XQuilla/docs/simple-api/Result_8hpp_source.html
2020-02-17 22:19:57 +01:00

123 lines
12 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&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- 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>
<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 class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>Result.hpp</h1><a href="Result_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2001-2008</span>
<a name="l00003"></a>00003 <span class="comment"> * DecisionSoft Limited. All rights reserved.</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2004-2008</span>
<a name="l00005"></a>00005 <span class="comment"> * Oracle. All rights reserved.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<a name="l00008"></a>00008 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00009"></a>00009 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00014"></a>00014 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00015"></a>00015 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00016"></a>00016 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00017"></a>00017 <span class="comment"> * limitations under the License.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * $Id: Result.hpp 531 2008-04-10 23:23:07Z jpcs $</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _RESULT_HPP</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _RESULT_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;xercesc/util/XercesDefs.hpp&gt;</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;xqilla/framework/XQillaExport.hpp&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;<a class="code" href="Item_8hpp.html">xqilla/items/Item.hpp</a>&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;<a class="code" href="ResultImpl_8hpp.html">xqilla/runtime/ResultImpl.hpp</a>&gt;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;xqilla/runtime/EmptyResult.hpp&gt;</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a>;
<a name="l00034"></a>00034 <span class="keyword">class </span>SequenceType;
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a>;
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classStaticType.html" title="Class that represents the static type of an expression.">StaticType</a>;
<a name="l00037"></a>00037
<a name="l00039"></a><a class="code" href="classResult.html">00039</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042 <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>(<span class="keyword">const</span> <a class="code" href="classRefCountPointer.html">Item::Ptr</a> &amp;item);
<a name="l00043"></a>00043 <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>(<span class="keyword">const</span> <a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a> &amp;seq);
<a name="l00044"></a>00044 <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>(<a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *impl);
<a name="l00045"></a>00045 <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>(<span class="keyword">const</span> <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> &amp;o);
<a name="l00046"></a>00046 <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> &amp;o);
<a name="l00047"></a>00047 ~<a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>();
<a name="l00048"></a>00048
<a name="l00050"></a>00050 <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *operator-&gt;();
<a name="l00051"></a>00051
<a name="l00053"></a>00053 <span class="keyword">const</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *operator-&gt;() <span class="keyword">const</span>;
<a name="l00054"></a>00054
<a name="l00056"></a>00056 <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *<span class="keyword">get</span>();
<a name="l00057"></a>00057
<a name="l00059"></a>00059 <span class="keyword">const</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *<span class="keyword">get</span>() <span class="keyword">const</span>;
<a name="l00060"></a>00060
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> isNull() <span class="keyword">const</span>;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 EmptyResult* getEmpty() <span class="keyword">const</span>;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">private</span>:
<a name="l00067"></a>00067 <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *_impl;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">static</span> EmptyResult _empty;
<a name="l00070"></a>00070 };
<a name="l00071"></a>00071
<a name="l00072"></a><a class="code" href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383">00072</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383" title="Returns true if the underlying pointer is null.">Result::isNull</a>()<span class="keyword"> const</span>
<a name="l00073"></a>00073 <span class="keyword"></span>{
<a name="l00074"></a>00074 <span class="keywordflow">return</span> _impl == 0;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00077"></a><a class="code" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715">00077</a> <span class="keyword">inline</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *<a class="code" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715" title="Returns the underlying ResultImpl object.">Result::get</a>()
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="keywordflow">if</span>(_impl) <span class="keywordflow">return</span> _impl;
<a name="l00080"></a>00080 <span class="keywordflow">return</span> <a class="code" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a>();
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082
<a name="l00083"></a><a class="code" href="classResult.html#ad699b382cbc38d188036f61bc54754e2">00083</a> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *<a class="code" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715" title="Returns the underlying ResultImpl object.">Result::get</a>()<span class="keyword"> const</span>
<a name="l00084"></a>00084 <span class="keyword"></span>{
<a name="l00085"></a>00085 <span class="keywordflow">if</span>(_impl) <span class="keywordflow">return</span> _impl;
<a name="l00086"></a>00086 <span class="keywordflow">return</span> <a class="code" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a>();
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00089"></a><a class="code" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e">00089</a> <span class="keyword">inline</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *<a class="code" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e" title="Returns the underlying ResultImpl object.">Result::operator-&gt;</a>()
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keywordflow">return</span> <span class="keyword">get</span>();
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093
<a name="l00094"></a><a class="code" href="classResult.html#a3218a8e3d12a7d37885711bfb285960c">00094</a> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> *<a class="code" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e" title="Returns the underlying ResultImpl object.">Result::operator-&gt;</a>()<span class="keyword"> const</span>
<a name="l00095"></a>00095 <span class="keyword"></span>{
<a name="l00096"></a>00096 <span class="keywordflow">return</span> <span class="keyword">get</span>();
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 13 14:59:31 2009 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>