docs/ResultSet.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: ResultSet</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: ResultSet</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>ResultSet<span class="signature">(graph)</span><span class="type-signature"></span></h2>
        
            <div class="class-description">Hold a query result</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="ResultSet"><span class="type-signature"></span>new ResultSet<span class="signature">(graph)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Builds an empty ResultSet object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>graph</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Graph.html">Graph</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line47">line 47</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="getHeader"><span class="type-signature"></span>getHeader<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line364">line 364</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    ResultSet's header.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getStatistics"><span class="type-signature"></span>getStatistics<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Statistics.html">Statistics</a>}</span></h4>
    

<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line385">line 385</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    ResultsSet's statistics.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Statistics.html">Statistics</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="hasNext"><span class="type-signature"></span>hasNext<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line371">line 371</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    If the ResultSet object can return additional records.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="next"><span class="type-signature"></span>next<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Record.html">Record</a>}</span></h4>
    

<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line378">line 378</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The current record.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Record.html">Record</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="parseArray"><span class="type-signature">(async) </span>parseArray<span class="signature">(rawArray)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;object>>}</span></h4>
    

<div class="description">
    Parse and in-place replace raw array into an array of values or objects.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rawArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw array representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line247">line 247</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Parsed array.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;Array.&lt;object>></span>


    </dd>
</dl>

    
    <h4 class="name" id="parseEdge"><span class="type-signature">(async) </span>parseEdge<span class="signature">(cell)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Edge.html">Edge</a>>}</span></h4>
    

<div class="description">
    Parse a raw edge representation into an Edge object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cell</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw edge representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line212">line 212</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Edge object.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Edge.html">Edge</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="parseEntityProperties"><span class="type-signature">(async) </span>parseEntityProperties<span class="signature">(props)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span></h4>
    

<div class="description">
    Parse raw entity properties representation into a Map
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>props</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw properties representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line151">line 151</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Map with the parsed properties.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;object></span>


    </dd>
</dl>

    
    <h4 class="name" id="parseHeader"><span class="type-signature"></span>parseHeader<span class="signature">(rawHeader)</span><span class="type-signature"></span></h4>
    

<div class="description">
    A raw representation of a header (query response schema) is a list.
Each entry in the list is a tuple (list of size 2).
tuple[0] represents the type of the column, and tuple[1] represents the name of the column.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rawHeader</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw header</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line100">line 100</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="parseMap"><span class="type-signature">(async) </span>parseMap<span class="signature">(rawMap)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span></h4>
    

<div class="description">
    Parse a raw map representation into Map object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rawMap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw map representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line272">line 272</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Map object.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;object></span>


    </dd>
</dl>

    
    <h4 class="name" id="parseNode"><span class="type-signature">(async) </span>parseNode<span class="signature">(cell)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Node.html">Node</a>>}</span></h4>
    

<div class="description">
    Parse raw node representation into a Node object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cell</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw node representation.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line182">line 182</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Node object.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Node.html">Node</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="parsePath"><span class="type-signature">(async) </span>parsePath<span class="signature">(rawPath)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Path.html">Path</a>>}</span></h4>
    

<div class="description">
    Parse a raw path representation into Path object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rawPath</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw path representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line260">line 260</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Path object.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Path.html">Path</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="parsePoint"><span class="type-signature"></span>parsePoint<span class="signature">(rawPoint)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Parse a raw Point representation into a lat-lon Map object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rawPoint</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">2-valued lat-lon array representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line287">line 287</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Map object with latitude and longitude keys.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="parseRecords"><span class="type-signature">(async) </span>parseRecords<span class="signature">(rawResultSet)</span><span class="type-signature"></span></h4>
    

<div class="description">
    The raw representation of response is at most 3 lists of objects. rawResultSet[1] contains the data records.
Each entry in the record can be either a node, an edge or a scalar
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rawResultSet</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw result set representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line116">line 116</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="parseResponse"><span class="type-signature">(async) </span>parseResponse<span class="signature">(resp)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Parse raw response data to ResultSet object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>resp</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw response representation - the raw representation of response is at most 3 lists of objects.
                   The last list is the statistics list.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line67">line 67</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="parseResults"><span class="type-signature">(async) </span>parseResults<span class="signature">(resp)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Parse a raw response body into header an records.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>resp</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw response</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line89">line 89</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="parseScalar"><span class="type-signature">(async) </span>parseScalar<span class="signature">(cell)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span></h4>
    

<div class="description">
    Parse a raw value into its actual value.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cell</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;object></span>


            </td>

            
            <td class="description last">raw value representation</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line301">line 301</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Actual value - scalar, array, Node, Edge, Path
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;object></span>


    </dd>
</dl>

    
    <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
    

<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="resultSet.js.html">resultSet.js</a>, <a href="resultSet.js.html#line392">line 392</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Result set size. (integer)
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Edge.html">Edge</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Node.html">Node</a></li><li><a href="Path.html">Path</a></li><li><a href="Record.html">Record</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="Statistics.html">Statistics</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Label">Label</a></li><li><a href="global.html#ResultSetColumnTypes">ResultSetColumnTypes</a></li><li><a href="global.html#ResultSetValueTypes">ResultSetValueTypes</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Dec 08 2022 09:52:52 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>