145 lines
19 KiB
HTML
145 lines
19 KiB
HTML
<!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&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_e3266bbc227f825a287bdb912a8a79c0.html">include</a></li><li class="navelem"><a class="el" href="dir_a1bc92396ffc8a3dc7aa16f9f9aed8c7.html">xqilla</a></li><li class="navelem"><a class="el" href="dir_edb9ca93fdcc21e6038ca507797536da.html">runtime</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Result.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="Result_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2001, 2008,</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * DecisionSoft Limited. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2004, 2018 Oracle and/or its affiliates. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * </span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * You may obtain a copy of the License at</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * limitations under the License.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef _RESULT_HPP</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define _RESULT_HPP</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <xercesc/util/XercesDefs.hpp></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <xqilla/framework/XQillaExport.hpp></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="Item_8hpp.html">xqilla/items/Item.hpp</a>></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="ResultImpl_8hpp.html">xqilla/runtime/ResultImpl.hpp</a>></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <xqilla/runtime/EmptyResult.hpp></span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span><a class="code" href="classSequence.html">Sequence</a>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>SequenceType;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="classDynamicContext.html">DynamicContext</a>;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span><a class="code" href="classStaticType.html">StaticType</a>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classResult.html"> 37</a></span> <span class="keyword">class </span>XQILLA_API <a class="code" href="classResult.html">Result</a></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classResult.html">Result</a>(<span class="keyword">const</span> <a class="code" href="classRefCountPointer.html">Item::Ptr</a> &item);</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classResult.html">Result</a>(<span class="keyword">const</span> <a class="code" href="classSequence.html">Sequence</a> &seq);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classResult.html">Result</a>(<a class="code" href="classResultImpl.html">ResultImpl</a> *impl);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classResult.html">Result</a>(<span class="keyword">const</span> <a class="code" href="classResult.html">Result</a> &o);</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classResult.html">Result</a> &operator=(<span class="keyword">const</span> <a class="code" href="classResult.html">Result</a> &o);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  ~<a class="code" href="classResult.html">Result</a>();</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classResultImpl.html">ResultImpl</a> *operator->();</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> <a class="code" href="classResultImpl.html">ResultImpl</a> *operator->() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classResultImpl.html">ResultImpl</a> *<span class="keyword">get</span>();</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">const</span> <a class="code" href="classResultImpl.html">ResultImpl</a> *<span class="keyword">get</span>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> isNull() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  EmptyResult* getEmpty() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classResultImpl.html">ResultImpl</a> *_impl;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> EmptyResult _empty;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> };</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383"> 70</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383">Result::isNull</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> _impl == 0;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715"> 75</a></span> <span class="keyword">inline</span> <a class="code" href="classResultImpl.html">ResultImpl</a> *<a class="code" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715">Result::get</a>()</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> {</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span>(_impl) <span class="keywordflow">return</span> _impl;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> <a class="code" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a>();</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classResult.html#ad699b382cbc38d188036f61bc54754e2"> 81</a></span> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classResultImpl.html">ResultImpl</a> *<a class="code" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715">Result::get</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span>(_impl) <span class="keywordflow">return</span> _impl;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> <a class="code" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a>();</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> }</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e"> 87</a></span> <span class="keyword">inline</span> <a class="code" href="classResultImpl.html">ResultImpl</a> *<a class="code" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e">Result::operator-></a>()</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> {</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> <span class="keyword">get</span>();</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classResult.html#a3218a8e3d12a7d37885711bfb285960c"> 92</a></span> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classResultImpl.html">ResultImpl</a> *<a class="code" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e">Result::operator-></a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> <span class="keyword">get</span>();</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="classRefCountPointer_html"><div class="ttname"><a href="classRefCountPointer.html">RefCountPointer< const Item ></a></div></div>
|
|
<div class="ttc" id="ResultImpl_8hpp_html"><div class="ttname"><a href="ResultImpl_8hpp.html">ResultImpl.hpp</a></div></div>
|
|
<div class="ttc" id="classResult_html"><div class="ttname"><a href="classResult.html">Result</a></div><div class="ttdoc">A scoped pointer wrapper for the lazily evaluated query result. </div><div class="ttdef"><b>Definition:</b> Result.hpp:37</div></div>
|
|
<div class="ttc" id="classResult_html_afb0e13d1fd84752d4dd4f1c250442383"><div class="ttname"><a href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383">Result::isNull</a></div><div class="ttdeci">bool isNull() const </div><div class="ttdoc">Returns true if the underlying pointer is null. </div><div class="ttdef"><b>Definition:</b> Result.hpp:70</div></div>
|
|
<div class="ttc" id="Item_8hpp_html"><div class="ttname"><a href="Item_8hpp.html">Item.hpp</a></div></div>
|
|
<div class="ttc" id="classDynamicContext_html"><div class="ttname"><a href="classDynamicContext.html">DynamicContext</a></div><div class="ttdoc">The execution time dynamic context interface. </div><div class="ttdef"><b>Definition:</b> DynamicContext.hpp:38</div></div>
|
|
<div class="ttc" id="classResult_html_a1d33d5326a611a9b1cd9e1c9f908bdb1"><div class="ttname"><a href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">Result::getEmpty</a></div><div class="ttdeci">EmptyResult * getEmpty() const </div></div>
|
|
<div class="ttc" id="classResult_html_a98858dfc452cee5c5197bd957f9c0715"><div class="ttname"><a href="classResult.html#a98858dfc452cee5c5197bd957f9c0715">Result::get</a></div><div class="ttdeci">ResultImpl * get()</div><div class="ttdoc">Returns the underlying ResultImpl object. </div><div class="ttdef"><b>Definition:</b> Result.hpp:75</div></div>
|
|
<div class="ttc" id="classStaticType_html"><div class="ttname"><a href="classStaticType.html">StaticType</a></div><div class="ttdoc">Class that represents the static type of an expression. </div><div class="ttdef"><b>Definition:</b> StaticType.hpp:33</div></div>
|
|
<div class="ttc" id="classSequence_html"><div class="ttname"><a href="classSequence.html">Sequence</a></div><div class="ttdoc">An eagerly evaluated result of a query execution. </div><div class="ttdef"><b>Definition:</b> Sequence.hpp:39</div></div>
|
|
<div class="ttc" id="classResultImpl_html"><div class="ttname"><a href="classResultImpl.html">ResultImpl</a></div><div class="ttdoc">A lazily evaluated query result. </div><div class="ttdef"><b>Definition:</b> ResultImpl.hpp:33</div></div>
|
|
<div class="ttc" id="classResult_html_a6cc161373ec2b58852f250c1b2c4091e"><div class="ttname"><a href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e">Result::operator-></a></div><div class="ttdeci">ResultImpl * operator->()</div><div class="ttdoc">Returns the underlying ResultImpl object. </div><div class="ttdef"><b>Definition:</b> Result.hpp:87</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|