115 lines
17 KiB
HTML
115 lines
17 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_78395f82a4cb2f249a968d7b21478d82.html">items</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">FunctionRef.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="FunctionRef_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 _XQILLAFUNCTIONREF_HPP</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define _XQILLAFUNCTIONREF_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 <vector></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="Item_8hpp.html">xqilla/items/Item.hpp</a>></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="ATQNameOrDerived_8hpp.html">xqilla/items/ATQNameOrDerived.hpp</a>></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="Result_8hpp.html">xqilla/runtime/Result.hpp</a>></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span><a class="code" href="classDynamicContext.html">DynamicContext</a>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="classLocationInfo.html">LocationInfo</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="FunctionRef_8hpp.html#ae7e25f27a9f0573dd18414f1301ccc97"> 31</a></span> <span class="keyword">class </span>FunctionSignature;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">typedef</span> std::vector<Result> <a class="code" href="FunctionRef_8hpp.html#ae7e25f27a9f0573dd18414f1301ccc97">VectorOfResults</a>;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classFunctionRef.html"> 35</a></span> <span class="keyword">class </span>XQILLA_API <a class="code" href="classFunctionRef.html">FunctionRef</a> : <span class="keyword">public</span> <a class="code" href="classItem.html">Item</a></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classFunctionRef.html#a6ab64fb45d177c734a24c02b3a8fc878"> 38</a></span>  <span class="keyword">typedef</span> <a class="code" href="classRefCountPointer.html">RefCountPointer<const FunctionRef></a> <a class="code" href="classFunctionRef.html#a6ab64fb45d177c734a24c02b3a8fc878">Ptr</a>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classFunctionRef.html#ac509c10ff0aaf89f03b66bd4f9777e58"> 40</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFunctionRef.html#ac509c10ff0aaf89f03b66bd4f9777e58">isNode</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classFunctionRef.html#ab96d303be371dc3b1e3896baca89a94a"> 41</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFunctionRef.html#ab96d303be371dc3b1e3896baca89a94a">isAtomicValue</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classFunctionRef.html#ab48d3a228b653e4ccf2355c74c4c4dfd"> 42</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFunctionRef.html#ab48d3a228b653e4ccf2355c74c4c4dfd">isFunction</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classFunctionRef.html#aa456e7d8ef15e74d5b797c8e4fa6322d"> 44</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh *<a class="code" href="classFunctionRef.html#aa456e7d8ef15e74d5b797c8e4fa6322d">getTypeURI</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classFunctionRef.html#aebd20c113c8b2c9dc723b070a63f703f"> 45</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh *<a class="code" href="classFunctionRef.html#aebd20c113c8b2c9dc723b070a63f703f">getTypeName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html">ATQNameOrDerived::Ptr</a> getName(<span class="keyword">const</span> <a class="code" href="classDynamicContext.html">DynamicContext</a> *context) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getNumArgs() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> FunctionSignature *getSignature() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <a class="code" href="classResult.html">Result</a> execute(<span class="keyword">const</span> <a class="code" href="FunctionRef_8hpp.html#ae7e25f27a9f0573dd18414f1301ccc97">VectorOfResults</a> &args, <a class="code" href="classDynamicContext.html">DynamicContext</a> *context, <span class="keyword">const</span> <a class="code" href="classLocationInfo.html">LocationInfo</a> *location) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html">FunctionRef::Ptr</a> partialApply(<span class="keyword">const</span> <a class="code" href="classResult.html">Result</a> &arg, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> argNum, <a class="code" href="classDynamicContext.html">DynamicContext</a> *context, <span class="keyword">const</span> <a class="code" href="classLocationInfo.html">LocationInfo</a> *location) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classFunctionRef.html#acfa11cbc6c5df5405cb34da020e55a25"> 54</a></span>  <a class="code" href="classFunctionRef.html#acfa11cbc6c5df5405cb34da020e55a25">FunctionRef</a>() {}</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="classFunctionRef_html_ac509c10ff0aaf89f03b66bd4f9777e58"><div class="ttname"><a href="classFunctionRef.html#ac509c10ff0aaf89f03b66bd4f9777e58">FunctionRef::isNode</a></div><div class="ttdeci">virtual bool isNode() const </div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:40</div></div>
|
|
<div class="ttc" id="classFunctionRef_html_acfa11cbc6c5df5405cb34da020e55a25"><div class="ttname"><a href="classFunctionRef.html#acfa11cbc6c5df5405cb34da020e55a25">FunctionRef::FunctionRef</a></div><div class="ttdeci">FunctionRef()</div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:54</div></div>
|
|
<div class="ttc" id="classRefCountPointer_html"><div class="ttname"><a href="classRefCountPointer.html">RefCountPointer</a></div><div class="ttdoc">Super class of all the reference counted wrappers for Items. </div><div class="ttdef"><b>Definition:</b> ReferenceCounted.hpp:61</div></div>
|
|
<div class="ttc" id="Result_8hpp_html"><div class="ttname"><a href="Result_8hpp.html">Result.hpp</a></div></div>
|
|
<div class="ttc" id="classFunctionRef_html_aebd20c113c8b2c9dc723b070a63f703f"><div class="ttname"><a href="classFunctionRef.html#aebd20c113c8b2c9dc723b070a63f703f">FunctionRef::getTypeName</a></div><div class="ttdeci">virtual const XMLCh * getTypeName() const </div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:45</div></div>
|
|
<div class="ttc" id="classFunctionRef_html"><div class="ttname"><a href="classFunctionRef.html">FunctionRef</a></div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:35</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="FunctionRef_8hpp_html_ae7e25f27a9f0573dd18414f1301ccc97"><div class="ttname"><a href="FunctionRef_8hpp.html#ae7e25f27a9f0573dd18414f1301ccc97">VectorOfResults</a></div><div class="ttdeci">std::vector< Result > VectorOfResults</div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:31</div></div>
|
|
<div class="ttc" id="classFunctionRef_html_ab96d303be371dc3b1e3896baca89a94a"><div class="ttname"><a href="classFunctionRef.html#ab96d303be371dc3b1e3896baca89a94a">FunctionRef::isAtomicValue</a></div><div class="ttdeci">virtual bool isAtomicValue() const </div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:41</div></div>
|
|
<div class="ttc" id="classFunctionRef_html_ab48d3a228b653e4ccf2355c74c4c4dfd"><div class="ttname"><a href="classFunctionRef.html#ab48d3a228b653e4ccf2355c74c4c4dfd">FunctionRef::isFunction</a></div><div class="ttdeci">virtual bool isFunction() const </div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:42</div></div>
|
|
<div class="ttc" id="classItem_html"><div class="ttname"><a href="classItem.html">Item</a></div><div class="ttdef"><b>Definition:</b> Item.hpp:36</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="classLocationInfo_html"><div class="ttname"><a href="classLocationInfo.html">LocationInfo</a></div><div class="ttdoc">A class that gives records a location in the query. </div><div class="ttdef"><b>Definition:</b> LocationInfo.hpp:29</div></div>
|
|
<div class="ttc" id="classFunctionRef_html_a6ab64fb45d177c734a24c02b3a8fc878"><div class="ttname"><a href="classFunctionRef.html#a6ab64fb45d177c734a24c02b3a8fc878">FunctionRef::Ptr</a></div><div class="ttdeci">RefCountPointer< const FunctionRef > Ptr</div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:38</div></div>
|
|
<div class="ttc" id="ATQNameOrDerived_8hpp_html"><div class="ttname"><a href="ATQNameOrDerived_8hpp.html">ATQNameOrDerived.hpp</a></div></div>
|
|
<div class="ttc" id="classFunctionRef_html_aa456e7d8ef15e74d5b797c8e4fa6322d"><div class="ttname"><a href="classFunctionRef.html#aa456e7d8ef15e74d5b797c8e4fa6322d">FunctionRef::getTypeURI</a></div><div class="ttdeci">virtual const XMLCh * getTypeURI() const </div><div class="ttdef"><b>Definition:</b> FunctionRef.hpp:44</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>
|