qminer
Version:
A C++ based data analytics platform for processing large-scale real-time streams containing structured and unstructured data
409 lines (405 loc) • 15.5 kB
HTML
<html>
<head>
<meta name="generator" content="JSDoc 3">
<meta charset="utf-8">
<title>Class: FIn</title>
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
<link href="css/baseline.css" rel="stylesheet">
</head>
<body onload="prettyPrint()">
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content">
<a href="index.html" class="jsdoc-navbar-package-name">QMiner JavaScript API v9.4.0</a>
</div>
</div>
</nav>
<div id="jsdoc-body-container">
<div id="jsdoc-content">
<div id="jsdoc-content-container">
<div id="jsdoc-main" role="main">
<header class="page-header">
<div class="symbol-detail-labels"><span class="label label-kind">class</span> <span class="label label-static">static</span></div>
<h1><small><a href="module-fs.html">fs</a>.<wbr></small><span class="symbol-name">FIn</span></h1>
<p class="source-link">Source: <a href="fsdoc.js.html#source-line-255">fsdoc.<wbr>js:255</a></p>
<div class="symbol-classdesc">
<p>Used for reading files.</p>
</div>
<dl class="dl-compact">
</dl>
</header>
<section id="summary">
<div class="summary-callout">
<h2 class="summary-callout-heading">Properties</h2>
<div class="summary-content">
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-fs.FIn.html#eof">eof</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-fs.FIn.html#length">length</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
</div>
</div>
</div>
<div class="summary-callout">
<h2 class="summary-callout-heading">Methods</h2>
<div class="summary-content">
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-fs.FIn.html#close">close()</a></dt>
<dd>
</dd>
<dt><a href="module-fs.FIn.html#getCh">getCh()</a></dt>
<dd>
</dd>
<dt><a href="module-fs.FIn.html#isClosed">isClosed()</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-fs.FIn.html#peekCh">peekCh()</a></dt>
<dd>
</dd>
<dt><a href="module-fs.FIn.html#readAll">readAll()</a></dt>
<dd>
</dd>
<dt><a href="module-fs.FIn.html#readJson">readJson()</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-fs.FIn.html#readLine">readLine()</a></dt>
<dd>
</dd>
<dt><a href="module-fs.FIn.html#readString">readString()</a></dt>
<dd>
</dd>
</dl>
</div>
</div>
</div>
</section>
<section>
<h2 id="FIn">new <span class="symbol-name">FIn</span><span class="signature"><span class="signature-params">(fileName)</span></span></h2>
<p>Input file stream.</p>
<section>
<h3>
Example
</h3>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// read a line
var str = fin.readLine();</code></pre>
</div>
</section>
<section>
<h3>Parameter</h3>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>fileName</p>
</td>
<td>
<p>string</p>
</td>
<td>
<p> </p>
</td>
<td>
<p>File name.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
</dl>
</section>
<section>
<h2>Properties</h2>
<section>
<h3 id="eof"><span class="symbol-name">eof</span></h3>
<p>True if end of file is detected. Otherwise, false. Type <code>boolean</code>.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// check if it's end of the file
var eof = fin.eof;</code></pre>
</div>
</section>
<dl class="dl-compact">
</dl>
<h3 id="length"><span class="symbol-name">length</span></h3>
<p>Length of input stream. Type <code>number</code>.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// get the length of the document
var len = fin.length;</code></pre>
</div>
</section>
<dl class="dl-compact">
</dl>
</section>
<h2>Methods</h2>
<section>
<h3 id="close"><span class="symbol-name">close</span><span class="signature"><span class="signature-params">()</span></span></h3>
<p>Closes the input stream.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// close the stream
fin.close();</code></pre>
</div>
</section>
<dl class="dl-compact">
</dl>
<h3 id="getCh"><span class="symbol-name">getCh</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> string</span></span></h3>
<p>Reads a character.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// get the next character
var char = fin.getCh();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>string</code>B Character string.</p>
</dd>
</dl>
<h3 id="isClosed"><span class="symbol-name">isClosed</span><span class="signature"><span class="signature-params">()</span></span></h3>
<p>Checks if the input stream is closed.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// check if the stream is closed
var check = fin.isClosed();</code></pre>
</div>
</section>
<dl class="dl-compact">
</dl>
<h3 id="peekCh"><span class="symbol-name">peekCh</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> string</span></span></h3>
<p>Peeks a character.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// peek the next character
var char = fin.peekCh();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>string</code>B Character string.</p>
</dd>
</dl>
<h3 id="readAll"><span class="symbol-name">readAll</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> string</span></span></h3>
<p>Reads the whole stream.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// get/read a the whole string
var all = fin.readAll();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>string</code>B Content of the file.</p>
</dd>
</dl>
<h3 id="readJson"><span class="symbol-name">readJson</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Object</span></span></h3>
<p>Reads json that was serialized using <code>fs.FOut.writeJson</code>.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import fs module
var fs = require('qminer').fs;
// create and save a json and then read it using the readJson method</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>Object</code>B Json object.</p>
</dd>
</dl>
<h3 id="readLine"><span class="symbol-name">readLine</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> string</span></span></h3>
<p>Reads a line.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import module
var fs = require('qminer').fs;
// open file in write mode
var fout = fs.openWrite('file.txt');
// write sync and close
fout.writeLine('example text');
fout.close();
// open file in read mode
var fin = new fs.FIn('file.txt');
// get/read a new line
var line = fin.readLine();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>string</code>B Line string.</p>
</dd>
</dl>
<h3 id="readString"><span class="symbol-name">readString</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> string</span></span></h3>
<p>Reads a string that was serialized using <code>fs.FOut.writeBinary</code>.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import fs module
var fs = require('qminer').fs;
// read a string that was serialized using fs.FOut.writeBinary</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>string</code>B String.</p>
</dd>
</dl>
</section>
</section>
</div>
</div>
<nav id="jsdoc-toc-nav" role="navigation"></nav>
</div>
</div>
<footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container">
<p>
</p>
</div>
</footer>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tree.jquery.js"></script>
<script src="scripts/prettify.js"></script>
<script src="scripts/jsdoc-toc.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/scrollanchor.js"></script>
</body>
</html>