mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classResultImpl.html
King_DuckZ 8c48174b5b v2.0.0
2020-02-17 22:12:51 +01:00

305 lines
15 KiB
HTML
Raw Blame History

<!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>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</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>
</ul></div>
<h1>ResultImpl Class Reference</h1><!-- doxytag: class="ResultImpl" --><!-- doxytag: inherits="ReferenceCounted" -->A lazily evaluated query result.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ResultImpl_8hpp-source.html">ResultImpl.hpp</a>&gt;</code>
<p>
Inheritance diagram for ResultImpl:<p><center><img src="classResultImpl__inherit__graph.png" border="0" usemap="#ResultImpl__inherit__map" alt="Inheritance graph"></center>
<map name="ResultImpl__inherit__map">
<area href="classReferenceCounted.html" shape="rect" coords="19,7,165,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classResultImpl-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#8f4c0a79354b00cfcf58b2ef3100bf57">~ResultImpl</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap 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#09ba07ed2c1ee28aba3bbcded97cc29f">next</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)=0</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="#09ba07ed2c1ee28aba3bbcded97cc29f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#4ccbd7869905b64d89f49290979bbc56">skip</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Performs iterator specific skip of results. <a href="#4ccbd7869905b64d89f49290979bbc56"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#e99c4a228313951877a69fc8d4d89a99">getEffectiveBooleanValue</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const LocationInfo *info)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the effective boolean value of the sequence. Only works properly before <a class="el" href="classResultImpl.html#09ba07ed2c1ee28aba3bbcded97cc29f">next()</a> has been called. <a href="#e99c4a228313951877a69fc8d4d89a99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#e88cb3ac28f6dc7a8a712903fdd44377">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">Sequence</a>. Only works properly before <a class="el" href="classResultImpl.html#09ba07ed2c1ee28aba3bbcded97cc29f">next()</a> has been called. <a href="#e88cb3ac28f6dc7a8a712903fdd44377"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#1481ef73108798638a89b24f0f238e32">asString</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context, int indent) const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Debug method to visualise the <a class="el" href="classResult.html">Result</a>. <a href="#1481ef73108798638a89b24f0f238e32"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#663d68e0f83d699881055d950b20680c">getEffectiveBooleanValue</a> (const <a class="el" href="classRefCountPointer.html">Item::Ptr</a> &amp;first, const <a class="el" href="classRefCountPointer.html">Item::Ptr</a> &amp;second, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const LocationInfo *info)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the effective boolean value of the sequence. <a href="#663d68e0f83d699881055d950b20680c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#11ab0ebd671f5f63b3aad043ff0d8331">getIndent</a> (int indent)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#e7fdab3da3aecae7cfe9a031ca79b8d7">ResultImpl</a> (const LocationInfo *o)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not allocate this object from a memory manager! It must be created using the heap. <a href="#e7fdab3da3aecae7cfe9a031ca79b8d7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A lazily evaluated query result.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="8f4c0a79354b00cfcf58b2ef3100bf57"></a><!-- doxytag: member="ResultImpl::~ResultImpl" ref="8f4c0a79354b00cfcf58b2ef3100bf57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ResultImpl::~ResultImpl </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e7fdab3da3aecae7cfe9a031ca79b8d7"></a><!-- doxytag: member="ResultImpl::ResultImpl" ref="e7fdab3da3aecae7cfe9a031ca79b8d7" args="(const LocationInfo *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ResultImpl::ResultImpl </td>
<td>(</td>
<td class="paramtype">const LocationInfo *&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do not allocate this object from a memory manager! It must be created using the heap.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="09ba07ed2c1ee28aba3bbcded97cc29f"></a><!-- doxytag: member="ResultImpl::next" ref="09ba07ed2c1ee28aba3bbcded97cc29f" args="(DynamicContext *context)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next item from the iterator. Returns null if the is no next value.
<p>
</div>
</div><p>
<a class="anchor" name="4ccbd7869905b64d89f49290979bbc56"></a><!-- doxytag: member="ResultImpl::skip" ref="4ccbd7869905b64d89f49290979bbc56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ResultImpl::skip </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Performs iterator specific skip of results.
<p>
</div>
</div><p>
<a class="anchor" name="e99c4a228313951877a69fc8d4d89a99"></a><!-- doxytag: member="ResultImpl::getEffectiveBooleanValue" ref="e99c4a228313951877a69fc8d4d89a99" args="(DynamicContext *context, const LocationInfo *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ResultImpl::getEffectiveBooleanValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const LocationInfo *&nbsp;</td>
<td class="paramname"> <em>info</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the effective boolean value of the sequence. Only works properly before <a class="el" href="classResultImpl.html#09ba07ed2c1ee28aba3bbcded97cc29f">next()</a> has been called.
<p>
</div>
</div><p>
<a class="anchor" name="663d68e0f83d699881055d950b20680c"></a><!-- doxytag: member="ResultImpl::getEffectiveBooleanValue" ref="663d68e0f83d699881055d950b20680c" args="(const Item::Ptr &amp;first, const Item::Ptr &amp;second, DynamicContext *context, const LocationInfo *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool ResultImpl::getEffectiveBooleanValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">Item::Ptr</a> &amp;&nbsp;</td>
<td class="paramname"> <em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">Item::Ptr</a> &amp;&nbsp;</td>
<td class="paramname"> <em>second</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const LocationInfo *&nbsp;</td>
<td class="paramname"> <em>info</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the effective boolean value of the sequence.
<p>
</div>
</div><p>
<a class="anchor" name="e88cb3ac28f6dc7a8a712903fdd44377"></a><!-- doxytag: member="ResultImpl::toSequence" ref="e88cb3ac28f6dc7a8a712903fdd44377" args="(DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classSequence.html">Sequence</a> ResultImpl::toSequence </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cast operator to a <a class="el" href="classSequence.html">Sequence</a>. Only works properly before <a class="el" href="classResultImpl.html#09ba07ed2c1ee28aba3bbcded97cc29f">next()</a> has been called.
<p>
</div>
</div><p>
<a class="anchor" name="1481ef73108798638a89b24f0f238e32"></a><!-- doxytag: member="ResultImpl::asString" ref="1481ef73108798638a89b24f0f238e32" args="(DynamicContext *context, int indent) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string ResultImpl::asString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>indent</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Debug method to visualise the <a class="el" href="classResult.html">Result</a>.
<p>
</div>
</div><p>
<a class="anchor" name="11ab0ebd671f5f63b3aad043ff0d8331"></a><!-- doxytag: member="ResultImpl::getIndent" ref="11ab0ebd671f5f63b3aad043ff0d8331" args="(int indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::string ResultImpl::getIndent </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>indent</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 20:16:59 2007 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink