XQuilla/docs/simple-api/classResultImpl.html

287 lines
15 KiB
HTML
Raw Normal View History

2020-02-17 21:11:31 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
2020-02-17 21:23:16 +00:00
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
2020-02-17 21:19:57 +00:00
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
2020-02-17 21:23:16 +00:00
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
2020-02-17 21:19:57 +00:00
</ul>
</div>
</div>
<div class="contents">
2020-02-17 21:23:16 +00:00
<h1>ResultImpl Class Reference</h1><!-- doxytag: class="ResultImpl" --><!-- doxytag: inherits="LocationInfo" -->
2020-02-17 21:19:57 +00:00
<p>A lazily evaluated query result.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ResultImpl_8hpp_source.html">ResultImpl.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ResultImpl:</div>
2020-02-17 21:23:16 +00:00
<div class="dynsection">
2020-02-17 21:19:57 +00:00
<div class="center"><img src="classResultImpl__inherit__graph.png" border="0" usemap="#ResultImpl_inherit__map" alt="Inheritance graph"/></div>
<map name="ResultImpl_inherit__map" id="ResultImpl_inherit__map">
2020-02-17 21:23:16 +00:00
<area shape="rect" id="node2" href="classLocationInfo.html" title="A class that gives records a location in the query." alt="" coords="5,5,109,35"/></map>
2020-02-17 21:19:57 +00:00
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classResultImpl-members.html">List of all members.</a></p>
2020-02-17 21:23:16 +00:00
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a8f4c0a79354b00cfcf58b2ef3100bf57">~ResultImpl</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#afe6b26d2f92bd9a494c60ff2c21dbbac">getResultPointer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a6f4ce236cfd8dba22738c3718e0cda4c">setResultPointer</a> (<a class="el" href="classResult.html">Result</a> *p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a4820c3c36a27975b1b704b903d2d1c5f">next</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the next item from the iterator. Returns null if the is no next value. <a href="#a4820c3c36a27975b1b704b903d2d1c5f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a8f095d8add3f386c32a9580524c44ae3">nextOrTail</a> (<a class="el" href="classResult.html">Result</a> &amp;tail, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the next item, or returns a tail call <a class="el" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> which will give the next item. <a href="#a8f095d8add3f386c32a9580524c44ae3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSequence.html">Sequence</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#ae88cb3ac28f6dc7a8a712903fdd44377">toSequence</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast operator to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a>. <a href="#ae88cb3ac28f6dc7a8a712903fdd44377"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#aae51d00769e17bf4d95b47f87fddcecf">toResultBuffer</a> (unsigned int readCount, ResultBuffer &amp;buffer)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a result buffer of the result. <a href="#aae51d00769e17bf4d95b47f87fddcecf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a344da0a3791b3e12ebdc5e323ae8b9dd">skip</a> (unsigned count, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Skip ahead. <a href="#a344da0a3791b3e12ebdc5e323ae8b9dd"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#ae7fdab3da3aecae7cfe9a031ca79b8d7">ResultImpl</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *o)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#ae9e8cbdcfea2cff7ea65fc014bc5ea13">resultPointer_</a></td></tr>
2020-02-17 21:19:57 +00:00
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2020-02-17 21:23:16 +00:00
<p>A lazily evaluated query result. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 21:19:57 +00:00
<a class="anchor" id="a8f4c0a79354b00cfcf58b2ef3100bf57"></a><!-- doxytag: member="ResultImpl::~ResultImpl" ref="a8f4c0a79354b00cfcf58b2ef3100bf57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual ResultImpl::~ResultImpl </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline, virtual]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae7fdab3da3aecae7cfe9a031ca79b8d7"></a><!-- doxytag: member="ResultImpl::ResultImpl" ref="ae7fdab3da3aecae7cfe9a031ca79b8d7" args="(const LocationInfo *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">ResultImpl::ResultImpl </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td>
<td class="paramname"> <em>o</em></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [protected]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afe6b26d2f92bd9a494c60ff2c21dbbac"></a><!-- doxytag: member="ResultImpl::getResultPointer" ref="afe6b26d2f92bd9a494c60ff2c21dbbac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname"><a class="el" href="classResult.html">Result</a>* ResultImpl::getResultPointer </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4820c3c36a27975b1b704b903d2d1c5f"></a><!-- doxytag: member="ResultImpl::next" ref="a4820c3c36a27975b1b704b903d2d1c5f" args="(DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::next </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [virtual]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:11:31 +00:00
2020-02-17 21:19:57 +00:00
<p>Get the next item from the iterator. Returns null if the is no next value. </p>
</div>
</div>
<a class="anchor" id="a8f095d8add3f386c32a9580524c44ae3"></a><!-- doxytag: member="ResultImpl::nextOrTail" ref="a8f095d8add3f386c32a9580524c44ae3" args="(Result &amp;tail, DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::nextOrTail </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype"><a class="el" href="classResult.html">Result</a> &amp;&nbsp;</td>
<td class="paramname"> <em>tail</em>, </td>
2020-02-17 21:11:31 +00:00
</tr>
<tr>
2020-02-17 21:19:57 +00:00
<td class="paramkey"></td>
<td></td>
2020-02-17 21:23:16 +00:00
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em></td><td>&nbsp;</td>
2020-02-17 21:11:31 +00:00
</tr>
<tr>
2020-02-17 21:19:57 +00:00
<td></td>
<td>)</td>
2020-02-17 21:23:16 +00:00
<td></td><td></td><td><code> [virtual]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:11:31 +00:00
2020-02-17 21:19:57 +00:00
<p>Gets the next item, or returns a tail call <a class="el" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> which will give the next item. </p>
2020-02-17 21:11:31 +00:00
2020-02-17 21:19:57 +00:00
</div>
</div>
<a class="anchor" id="a6f4ce236cfd8dba22738c3718e0cda4c"></a><!-- doxytag: member="ResultImpl::setResultPointer" ref="a6f4ce236cfd8dba22738c3718e0cda4c" args="(Result *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">void ResultImpl::setResultPointer </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype"><a class="el" href="classResult.html">Result</a> *&nbsp;</td>
<td class="paramname"> <em>p</em></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
</div>
</div>
2020-02-17 21:22:42 +00:00
<a class="anchor" id="a344da0a3791b3e12ebdc5e323ae8b9dd"></a><!-- doxytag: member="ResultImpl::skip" ref="a344da0a3791b3e12ebdc5e323ae8b9dd" args="(unsigned count, DynamicContext *context)" -->
2020-02-17 21:19:57 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:22:42 +00:00
<td class="memname">virtual void ResultImpl::skip </td>
2020-02-17 21:19:57 +00:00
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>count</em>, </td>
2020-02-17 21:22:42 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2020-02-17 21:23:16 +00:00
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em></td><td>&nbsp;</td>
2020-02-17 21:22:42 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2020-02-17 21:23:16 +00:00
<td></td><td></td><td><code> [virtual]</code></td>
2020-02-17 21:22:42 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Skip ahead. </p>
</div>
</div>
<a class="anchor" id="aae51d00769e17bf4d95b47f87fddcecf"></a><!-- doxytag: member="ResultImpl::toResultBuffer" ref="aae51d00769e17bf4d95b47f87fddcecf" args="(unsigned int readCount, ResultBuffer &amp;buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ResultImpl::toResultBuffer </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>readCount</em>, </td>
2020-02-17 21:22:42 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2020-02-17 21:23:16 +00:00
<td class="paramtype">ResultBuffer &amp;&nbsp;</td>
<td class="paramname"> <em>buffer</em></td><td>&nbsp;</td>
2020-02-17 21:22:42 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2020-02-17 21:23:16 +00:00
<td></td><td></td><td><code> [virtual]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:11:31 +00:00
2020-02-17 21:19:57 +00:00
<p>Returns a result buffer of the result. </p>
</div>
</div>
<a class="anchor" id="ae88cb3ac28f6dc7a8a712903fdd44377"></a><!-- doxytag: member="ResultImpl::toSequence" ref="ae88cb3ac28f6dc7a8a712903fdd44377" args="(DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:19:08 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual <a class="el" href="classSequence.html">Sequence</a> ResultImpl::toSequence </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [virtual]</code></td>
2020-02-17 21:19:08 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:22:42 +00:00
<p>Cast operator to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a>. </p>
2020-02-17 21:19:57 +00:00
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae9e8cbdcfea2cff7ea65fc014bc5ea13"></a><!-- doxytag: member="ResultImpl::resultPointer_" ref="ae9e8cbdcfea2cff7ea65fc014bc5ea13" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:11:31 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname"><a class="el" href="classResult.html">Result</a>* <a class="el" href="classResultImpl.html#ae9e8cbdcfea2cff7ea65fc014bc5ea13">ResultImpl::resultPointer_</a><code> [protected]</code></td>
2020-02-17 21:11:31 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ResultImpl_8hpp_source.html">ResultImpl.hpp</a></li>
</ul>
</div>
2020-02-17 21:24:17 +00:00
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla Simple API by&nbsp;
2020-02-17 21:11:31 +00:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 21:23:16 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
2020-02-17 21:11:31 +00:00
</body>
</html>