XQuilla/docs/simple-api/XQQuery_8hpp-source.html

161 lines
15 KiB
HTML
Raw Normal View History

2020-02-17 21:05:20 +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">
2020-02-17 21:11:31 +00:00
<title>XQilla Simple API Documentation</title>
2020-02-17 21:05:20 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 21:11:31 +00:00
<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:10:06 +00:00
<!-- Generated by Doxygen 1.5.1 -->
2020-02-17 21:05:20 +00:00
<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="classes.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</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>XQQuery.hpp</h1><a href="XQQuery_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-2006</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-2006</span>
<a name="l00005"></a>00005 <span class="comment"> * Progress Software Corporation. All rights reserved.</span>
<a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 2004-2006</span>
<a name="l00007"></a>00007 <span class="comment"> * Oracle. All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * See the file LICENSE for redistribution information.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
2020-02-17 21:11:31 +00:00
<a name="l00011"></a>00011 <span class="comment"> * $Id: XQQuery.hpp,v 1.18 2007/07/10 16:28:59 jpcs Exp $</span>
2020-02-17 21:05:20 +00:00
<a name="l00012"></a>00012 <span class="comment"> */</span>
<a name="l00013"></a>00013
2020-02-17 21:11:31 +00:00
<a name="l00014"></a>00014 <span class="preprocessor">#ifndef XQQUERY_HPP</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#define XQQUERY_HPP</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;xqilla/framework/XQillaExport.hpp&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;<a class="code" href="XMemory_8hpp.html">xercesc/util/XMemory.hpp</a>&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;<a class="code" href="InputSource_8hpp.html">xercesc/sax/InputSource.hpp</a>&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;<a class="code" href="ResultImpl_8hpp.html">xqilla/runtime/ResultImpl.hpp</a>&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;xqilla/runtime/LazySequenceResult.hpp&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;<a class="code" href="StaticContext_8hpp.html">xqilla/context/StaticContext.hpp</a>&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="keyword">class </span><a class="code" href="classDynamicContext.html">DynamicContext</a>;
<a name="l00027"></a>00027 <span class="keyword">class </span>XQUserFunction;
<a name="l00028"></a>00028 <span class="keyword">class </span>XQGlobalVariable;
<a name="l00029"></a><a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">00029</a> <span class="keyword">class </span><a class="code" href="classXQQuery.html">XQQuery</a>;
2020-02-17 21:08:05 +00:00
<a name="l00030"></a>00030
2020-02-17 21:11:31 +00:00
<a name="l00031"></a>00031 <span class="keyword">typedef</span> std::vector&lt;XQUserFunction*, XQillaAllocator&lt;XQUserFunction*&gt; &gt; <a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">UserFunctions</a>;
<a name="l00032"></a><a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">00032</a> <span class="keyword">typedef</span> std::vector&lt;XQGlobalVariable*, XQillaAllocator&lt;XQGlobalVariable*&gt; &gt; <a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">GlobalVariables</a>;
<a name="l00033"></a><a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">00033</a> <span class="keyword">typedef</span> std::vector&lt;XQQuery*, XQillaAllocator&lt;XQQuery*&gt; &gt; <a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">ImportedModules</a>;
<a name="l00034"></a>00034
<a name="l00049"></a><a class="code" href="classXQQuery.html">00049</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classXQQuery.html">XQQuery</a> : <span class="keyword">public</span> XERCES_CPP_NAMESPACE_QUALIFIER XMemory
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00053"></a>00053 ~<a class="code" href="classXQQuery.html">XQQuery</a>();
<a name="l00054"></a>00054
<a name="l00056"></a>00056 <span class="comment">// @{</span>
<a name="l00057"></a>00057
<a name="l00066"></a>00066 <a class="code" href="classDynamicContext.html">DynamicContext</a> *createDynamicContext(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
<a name="l00067"></a>00067 XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) <span class="keyword">const</span>;
<a name="l00068"></a>00068
<a name="l00082"></a>00082 <a class="code" href="classResult.html">Result</a> execute(<a class="code" href="classDynamicContext.html">DynamicContext</a>* context) <span class="keyword">const</span>;
<a name="l00083"></a>00083
<a name="l00094"></a>00094 <span class="keywordtype">void</span> execute(<a class="code" href="classEventHandler.html">EventHandler</a> *events, <a class="code" href="classDynamicContext.html">DynamicContext</a>* context) <span class="keyword">const</span>;
<a name="l00095"></a>00095
<a name="l00115"></a>00115 <span class="keywordtype">void</span> staticResolution(<a class="code" href="classStaticContext.html">StaticContext</a> *context = 0);
<a name="l00116"></a>00116
<a name="l00129"></a>00129 <span class="keywordtype">void</span> staticTyping(<a class="code" href="classStaticContext.html">StaticContext</a> *context = 0);
2020-02-17 21:08:05 +00:00
<a name="l00130"></a>00130
2020-02-17 21:11:31 +00:00
<a name="l00132"></a>00132
<a name="l00134"></a>00134 <span class="comment">// @{</span>
2020-02-17 21:08:05 +00:00
<a name="l00135"></a>00135
2020-02-17 21:11:31 +00:00
<a name="l00137"></a>00137 <span class="keyword">const</span> XMLCh* getQueryText() <span class="keyword">const</span>;
2020-02-17 21:08:05 +00:00
<a name="l00138"></a>00138
2020-02-17 21:11:31 +00:00
<a name="l00140"></a>00140 std::string getQueryPlan() <span class="keyword">const</span>;
<a name="l00141"></a>00141
2020-02-17 21:08:05 +00:00
<a name="l00143"></a>00143
2020-02-17 21:11:31 +00:00
<a name="l00145"></a>00145 <span class="comment">// @{</span>
<a name="l00146"></a>00146
<a name="l00148"></a>00148 ASTNode* getQueryBody() <span class="keyword">const</span>;
<a name="l00150"></a>00150 <span class="keywordtype">void</span> setQueryBody(ASTNode* query);
<a name="l00151"></a>00151
<a name="l00153"></a>00153 <span class="keywordtype">void</span> addFunction(XQUserFunction* fnDef);
<a name="l00155"></a><a class="code" href="classXQQuery.html#b2f02aae9a68cb9d73006297d6a87fb8">00155</a> <span class="keyword">const</span> <a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">UserFunctions</a> &amp;getFunctions()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_userDefFns; }
2020-02-17 21:08:05 +00:00
<a name="l00156"></a>00156
2020-02-17 21:11:31 +00:00
<a name="l00158"></a>00158 <span class="keywordtype">void</span> addVariable(XQGlobalVariable* varDef);
<a name="l00160"></a><a class="code" href="classXQQuery.html#50e591d0d38e627b5af9639fb2c5e637">00160</a> <span class="keyword">const</span> <a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">GlobalVariables</a> &amp;getVariables()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_userDefVars; }
2020-02-17 21:08:05 +00:00
<a name="l00161"></a>00161
2020-02-17 21:11:31 +00:00
<a name="l00163"></a><a class="code" href="classXQQuery.html#25efa228ae8c010dc45253036a23bf75">00163</a> <span class="keyword">const</span> <a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">ImportedModules</a> &amp;getImportedModules()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_importedModules; }
<a name="l00164"></a>00164
<a name="l00166"></a>00166 <span class="keyword">const</span> XMLCh* getFile() <span class="keyword">const</span>;
<a name="l00168"></a>00168 <span class="keywordtype">void</span> setFile(<span class="keyword">const</span> XMLCh* file);
<a name="l00169"></a>00169
<a name="l00170"></a><a class="code" href="classXQQuery.html#07159e0013722c33ae6c38a2e2ae99e4">00170</a> <span class="keyword">const</span> <a class="code" href="classDynamicContext.html">DynamicContext</a> *getStaticContext()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_context; }
<a name="l00171"></a>00171
<a name="l00173"></a>00173
<a name="l00175"></a>00175 <span class="comment">// @{</span>
<a name="l00176"></a>00176
<a name="l00178"></a>00178 <span class="keywordtype">void</span> setIsLibraryModule(<span class="keywordtype">bool</span> bIsModule=<span class="keyword">true</span>);
<a name="l00180"></a>00180 <span class="keywordtype">bool</span> getIsLibraryModule() <span class="keyword">const</span>;
<a name="l00182"></a>00182 <span class="keywordtype">void</span> setModuleTargetNamespace(<span class="keyword">const</span> XMLCh* uri);
<a name="l00184"></a>00184 <span class="keyword">const</span> XMLCh* getModuleTargetNamespace() <span class="keyword">const</span>;
<a name="l00186"></a>00186 <span class="keywordtype">void</span> importModule(<span class="keyword">const</span> XMLCh* szUri, VectorOfStrings* locations, <a class="code" href="classStaticContext.html">StaticContext</a>* context, <span class="keyword">const</span> LocationInfo *location);
<a name="l00187"></a>00187
2020-02-17 21:05:20 +00:00
<a name="l00189"></a>00189
2020-02-17 21:11:31 +00:00
<a name="l00190"></a>00190 <span class="keyword">private</span>:
<a name="l00192"></a>00192 <span class="keyword">class </span>QueryResult : <span class="keyword">public</span> <a class="code" href="classResultImpl.html">ResultImpl</a>
<a name="l00193"></a>00193 {
<a name="l00194"></a>00194 <span class="keyword">public</span>:
<a name="l00195"></a>00195 QueryResult(<span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> *query);
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <a class="code" href="classRefCountPointer.html">Item::Ptr</a> next(<a class="code" href="classDynamicContext.html">DynamicContext</a> *context);
<a name="l00198"></a>00198 std::string asString(<a class="code" href="classDynamicContext.html">DynamicContext</a> *context, <span class="keywordtype">int</span> indent) <span class="keyword">const</span>;
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="keyword">private</span>:
<a name="l00201"></a>00201 <span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> *_query;
<a name="l00202"></a>00202 <a class="code" href="classResult.html">Result</a> _parent;
<a name="l00203"></a>00203 <span class="keywordtype">bool</span> _toDo;
<a name="l00204"></a>00204 };
<a name="l00205"></a>00205
<a name="l00206"></a>00206 <span class="keyword">private</span>:
<a name="l00208"></a>00208 <a class="code" href="classXQQuery.html">XQQuery</a>(<span class="keyword">const</span> XMLCh* queryText, <a class="code" href="classDynamicContext.html">DynamicContext</a> *context, <span class="keywordtype">bool</span> contextOwned = <span class="keyword">false</span>,
<a name="l00209"></a>00209 XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
<a name="l00210"></a>00210 XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager);
2020-02-17 21:05:20 +00:00
<a name="l00211"></a>00211
2020-02-17 21:11:31 +00:00
<a name="l00212"></a>00212 <a class="code" href="classXQQuery.html">XQQuery</a>(<span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> &amp;);
<a name="l00213"></a>00213 <a class="code" href="classXQQuery.html">XQQuery</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> &amp;);
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="keywordtype">void</span> executeProlog(<a class="code" href="classDynamicContext.html">DynamicContext</a> *context) <span class="keyword">const</span>;
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="keyword">private</span>:
<a name="l00219"></a>00219 XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager* m_memMgr;
2020-02-17 21:05:20 +00:00
<a name="l00220"></a>00220
2020-02-17 21:11:31 +00:00
<a name="l00222"></a>00222 <a class="code" href="classDynamicContext.html">DynamicContext</a> *m_context;
<a name="l00223"></a>00223 <span class="keywordtype">bool</span> m_contextOwned;
2020-02-17 21:05:20 +00:00
<a name="l00224"></a>00224
2020-02-17 21:11:31 +00:00
<a name="l00225"></a>00225 ASTNode* m_query;
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="keywordtype">bool</span> m_bIsLibraryModule;
<a name="l00228"></a>00228 <span class="keyword">const</span> XMLCh* m_szTargetNamespace;
<a name="l00229"></a>00229 <span class="keyword">const</span> XMLCh* m_szQueryText;
<a name="l00230"></a>00230 <span class="keyword">const</span> XMLCh* m_szCurrentFile;
<a name="l00231"></a>00231
<a name="l00232"></a>00232 <a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">UserFunctions</a> m_userDefFns;
<a name="l00233"></a>00233 <a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">GlobalVariables</a> m_userDefVars;
<a name="l00234"></a>00234 <a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">ImportedModules</a> m_importedModules;
2020-02-17 21:05:20 +00:00
<a name="l00235"></a>00235
2020-02-17 21:11:31 +00:00
<a name="l00236"></a><a class="code" href="classXQQuery.html#88a4d20f5007ef053c45a8bacf5b8008">00236</a> <span class="keyword">friend</span> <span class="keyword">class </span>QueryResult;
<a name="l00237"></a><a class="code" href="classXQQuery.html#714edbeddd5c2a4c2d9120c7d2e6922c">00237</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classXQilla.html">XQilla</a>;
<a name="l00238"></a>00238 };
2020-02-17 21:05:20 +00:00
<a name="l00239"></a>00239
2020-02-17 21:11:31 +00:00
<a name="l00240"></a>00240 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Aug 31 14:37:35 2007 for XQilla Simple API by&nbsp;
2020-02-17 21:05:20 +00:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 21:10:06 +00:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
2020-02-17 21:05:20 +00:00
</body>
</html>