168 lines
16 KiB
HTML
168 lines
16 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.5.1 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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-2007</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-2007</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 "License");</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 "AS IS" 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: XQQuery.hpp,v 1.19 2007/11/28 13:13:25 jpcs Exp $</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> */</span>
|
|
<a name="l00021"></a>00021
|
|
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef XQQUERY_HPP</span>
|
|
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define XQQUERY_HPP</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"></span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor">#include <xqilla/framework/XQillaExport.hpp></span>
|
|
<a name="l00026"></a>00026 <span class="preprocessor">#include <vector></span>
|
|
<a name="l00027"></a>00027 <span class="preprocessor">#include <string></span>
|
|
<a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="XMemory_8hpp.html">xercesc/util/XMemory.hpp</a>></span>
|
|
<a name="l00029"></a>00029 <span class="preprocessor">#include <<a class="code" href="InputSource_8hpp.html">xercesc/sax/InputSource.hpp</a>></span>
|
|
<a name="l00030"></a>00030 <span class="preprocessor">#include <<a class="code" href="ResultImpl_8hpp.html">xqilla/runtime/ResultImpl.hpp</a>></span>
|
|
<a name="l00031"></a>00031 <span class="preprocessor">#include <xqilla/runtime/LazySequenceResult.hpp></span>
|
|
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="StaticContext_8hpp.html">xqilla/context/StaticContext.hpp</a>></span>
|
|
<a name="l00033"></a>00033
|
|
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classDynamicContext.html">DynamicContext</a>;
|
|
<a name="l00035"></a>00035 <span class="keyword">class </span>XQUserFunction;
|
|
<a name="l00036"></a>00036 <span class="keyword">class </span>XQGlobalVariable;
|
|
<a name="l00037"></a><a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">00037</a> <span class="keyword">class </span><a class="code" href="classXQQuery.html">XQQuery</a>;
|
|
<a name="l00038"></a>00038
|
|
<a name="l00039"></a>00039 <span class="keyword">typedef</span> std::vector<XQUserFunction*, XQillaAllocator<XQUserFunction*> > <a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">UserFunctions</a>;
|
|
<a name="l00040"></a><a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">00040</a> <span class="keyword">typedef</span> std::vector<XQGlobalVariable*, XQillaAllocator<XQGlobalVariable*> > <a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">GlobalVariables</a>;
|
|
<a name="l00041"></a><a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">00041</a> <span class="keyword">typedef</span> std::vector<XQQuery*, XQillaAllocator<XQQuery*> > <a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">ImportedModules</a>;
|
|
<a name="l00042"></a>00042
|
|
<a name="l00057"></a><a class="code" href="classXQQuery.html">00057</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="l00058"></a>00058 {
|
|
<a name="l00059"></a>00059 <span class="keyword">public</span>:
|
|
<a name="l00061"></a>00061 ~<a class="code" href="classXQQuery.html">XQQuery</a>();
|
|
<a name="l00062"></a>00062
|
|
<a name="l00064"></a>00064 <span class="comment">// @{</span>
|
|
<a name="l00065"></a>00065
|
|
<a name="l00074"></a>00074 <a class="code" href="classDynamicContext.html">DynamicContext</a> *createDynamicContext(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
|
|
<a name="l00075"></a>00075 XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) <span class="keyword">const</span>;
|
|
<a name="l00076"></a>00076
|
|
<a name="l00090"></a>00090 <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="l00091"></a>00091
|
|
<a name="l00102"></a>00102 <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="l00103"></a>00103
|
|
<a name="l00123"></a>00123 <span class="keywordtype">void</span> staticResolution(<a class="code" href="classStaticContext.html">StaticContext</a> *context = 0);
|
|
<a name="l00124"></a>00124
|
|
<a name="l00137"></a>00137 <span class="keywordtype">void</span> staticTyping(<a class="code" href="classStaticContext.html">StaticContext</a> *context = 0);
|
|
<a name="l00138"></a>00138
|
|
<a name="l00140"></a>00140
|
|
<a name="l00142"></a>00142 <span class="comment">// @{</span>
|
|
<a name="l00143"></a>00143
|
|
<a name="l00145"></a>00145 <span class="keyword">const</span> XMLCh* getQueryText() <span class="keyword">const</span>;
|
|
<a name="l00146"></a>00146
|
|
<a name="l00148"></a>00148 std::string getQueryPlan() <span class="keyword">const</span>;
|
|
<a name="l00149"></a>00149
|
|
<a name="l00151"></a>00151
|
|
<a name="l00153"></a>00153 <span class="comment">// @{</span>
|
|
<a name="l00154"></a>00154
|
|
<a name="l00156"></a>00156 ASTNode* getQueryBody() <span class="keyword">const</span>;
|
|
<a name="l00158"></a>00158 <span class="keywordtype">void</span> setQueryBody(ASTNode* query);
|
|
<a name="l00159"></a>00159
|
|
<a name="l00161"></a>00161 <span class="keywordtype">void</span> addFunction(XQUserFunction* fnDef);
|
|
<a name="l00163"></a><a class="code" href="classXQQuery.html#b2f02aae9a68cb9d73006297d6a87fb8">00163</a> <span class="keyword">const</span> <a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">UserFunctions</a> &getFunctions()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_userDefFns; }
|
|
<a name="l00164"></a>00164
|
|
<a name="l00166"></a>00166 <span class="keywordtype">void</span> addVariable(XQGlobalVariable* varDef);
|
|
<a name="l00168"></a><a class="code" href="classXQQuery.html#50e591d0d38e627b5af9639fb2c5e637">00168</a> <span class="keyword">const</span> <a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">GlobalVariables</a> &getVariables()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_userDefVars; }
|
|
<a name="l00169"></a>00169
|
|
<a name="l00171"></a><a class="code" href="classXQQuery.html#25efa228ae8c010dc45253036a23bf75">00171</a> <span class="keyword">const</span> <a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">ImportedModules</a> &getImportedModules()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_importedModules; }
|
|
<a name="l00172"></a>00172
|
|
<a name="l00174"></a>00174 <span class="keyword">const</span> XMLCh* getFile() <span class="keyword">const</span>;
|
|
<a name="l00176"></a>00176 <span class="keywordtype">void</span> setFile(<span class="keyword">const</span> XMLCh* file);
|
|
<a name="l00177"></a>00177
|
|
<a name="l00178"></a><a class="code" href="classXQQuery.html#07159e0013722c33ae6c38a2e2ae99e4">00178</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="l00179"></a>00179
|
|
<a name="l00181"></a>00181
|
|
<a name="l00183"></a>00183 <span class="comment">// @{</span>
|
|
<a name="l00184"></a>00184
|
|
<a name="l00186"></a>00186 <span class="keywordtype">void</span> setIsLibraryModule(<span class="keywordtype">bool</span> bIsModule=<span class="keyword">true</span>);
|
|
<a name="l00188"></a>00188 <span class="keywordtype">bool</span> getIsLibraryModule() <span class="keyword">const</span>;
|
|
<a name="l00190"></a>00190 <span class="keywordtype">void</span> setModuleTargetNamespace(<span class="keyword">const</span> XMLCh* uri);
|
|
<a name="l00192"></a>00192 <span class="keyword">const</span> XMLCh* getModuleTargetNamespace() <span class="keyword">const</span>;
|
|
<a name="l00194"></a>00194 <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="l00195"></a>00195
|
|
<a name="l00197"></a>00197
|
|
<a name="l00198"></a>00198 <span class="keyword">private</span>:
|
|
<a name="l00200"></a>00200 <span class="keyword">class </span>QueryResult : <span class="keyword">public</span> <a class="code" href="classResultImpl.html">ResultImpl</a>
|
|
<a name="l00201"></a>00201 {
|
|
<a name="l00202"></a>00202 <span class="keyword">public</span>:
|
|
<a name="l00203"></a>00203 QueryResult(<span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> *query);
|
|
<a name="l00204"></a>00204
|
|
<a name="l00205"></a>00205 <a class="code" href="classRefCountPointer.html">Item::Ptr</a> next(<a class="code" href="classDynamicContext.html">DynamicContext</a> *context);
|
|
<a name="l00206"></a>00206 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="l00207"></a>00207
|
|
<a name="l00208"></a>00208 <span class="keyword">private</span>:
|
|
<a name="l00209"></a>00209 <span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> *_query;
|
|
<a name="l00210"></a>00210 <a class="code" href="classResult.html">Result</a> _parent;
|
|
<a name="l00211"></a>00211 <span class="keywordtype">bool</span> _toDo;
|
|
<a name="l00212"></a>00212 };
|
|
<a name="l00213"></a>00213
|
|
<a name="l00214"></a>00214 <span class="keyword">private</span>:
|
|
<a name="l00216"></a>00216 <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="l00217"></a>00217 XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
|
|
<a name="l00218"></a>00218 XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager);
|
|
<a name="l00219"></a>00219
|
|
<a name="l00220"></a>00220 <a class="code" href="classXQQuery.html">XQQuery</a>(<span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> &);
|
|
<a name="l00221"></a>00221 <a class="code" href="classXQQuery.html">XQQuery</a> &operator=(<span class="keyword">const</span> <a class="code" href="classXQQuery.html">XQQuery</a> &);
|
|
<a name="l00222"></a>00222
|
|
<a name="l00223"></a>00223 <span class="keywordtype">void</span> executeProlog(<a class="code" href="classDynamicContext.html">DynamicContext</a> *context) <span class="keyword">const</span>;
|
|
<a name="l00224"></a>00224
|
|
<a name="l00225"></a>00225 <span class="keyword">private</span>:
|
|
<a name="l00227"></a>00227 XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager* m_memMgr;
|
|
<a name="l00228"></a>00228
|
|
<a name="l00230"></a>00230 <a class="code" href="classDynamicContext.html">DynamicContext</a> *m_context;
|
|
<a name="l00231"></a>00231 <span class="keywordtype">bool</span> m_contextOwned;
|
|
<a name="l00232"></a>00232
|
|
<a name="l00233"></a>00233 ASTNode* m_query;
|
|
<a name="l00234"></a>00234
|
|
<a name="l00235"></a>00235 <span class="keywordtype">bool</span> m_bIsLibraryModule;
|
|
<a name="l00236"></a>00236 <span class="keyword">const</span> XMLCh* m_szTargetNamespace;
|
|
<a name="l00237"></a>00237 <span class="keyword">const</span> XMLCh* m_szQueryText;
|
|
<a name="l00238"></a>00238 <span class="keyword">const</span> XMLCh* m_szCurrentFile;
|
|
<a name="l00239"></a>00239
|
|
<a name="l00240"></a>00240 <a class="code" href="XQQuery_8hpp.html#120407438cc6ede3bc7b57aae806741c">UserFunctions</a> m_userDefFns;
|
|
<a name="l00241"></a>00241 <a class="code" href="XQQuery_8hpp.html#9d2d5aa88c009aeb4423578b5665857a">GlobalVariables</a> m_userDefVars;
|
|
<a name="l00242"></a>00242 <a class="code" href="XQQuery_8hpp.html#6bfc1be626a21b5f066df297e669fe9f">ImportedModules</a> m_importedModules;
|
|
<a name="l00243"></a>00243
|
|
<a name="l00244"></a><a class="code" href="classXQQuery.html#88a4d20f5007ef053c45a8bacf5b8008">00244</a> <span class="keyword">friend</span> <span class="keyword">class </span>QueryResult;
|
|
<a name="l00245"></a><a class="code" href="classXQQuery.html#714edbeddd5c2a4c2d9120c7d2e6922c">00245</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classXQilla.html">XQilla</a>;
|
|
<a name="l00246"></a>00246 };
|
|
<a name="l00247"></a>00247
|
|
<a name="l00248"></a>00248 <span class="preprocessor">#endif</span>
|
|
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 20:16:43 2007 for XQilla Simple API by
|
|
<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>
|