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

132 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&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>DynamicContext.hpp</h1><a href="DynamicContext_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: DynamicContext.hpp 603 2008-08-18 23:40:47Z 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 _DYNAMICCONTEXT_HPP</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _DYNAMICCONTEXT_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;<a class="code" href="StaticContext_8hpp.html">xqilla/context/StaticContext.hpp</a>&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="ATDurationOrDerived_8hpp.html">xqilla/items/ATDurationOrDerived.hpp</a>&gt;</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a>;
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classItem.html">Item</a>;
<a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways.">URIResolver</a>;
<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classVariableStore.html" title="The pure virtual base class for accessing variables at runtime.">VariableStore</a>;
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classSequenceBuilder.html">SequenceBuilder</a>;
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classUpdateFactory.html">UpdateFactory</a>;
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classRegexGroupStore.html" title="The pure virtual base class for accessing regular expression group values at runtime...">RegexGroupStore</a>;
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classDebugListener.html" title="A class used to listen for debugging information.">DebugListener</a>;
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classStackFrame.html" title="A class that represents an item in a query call stack.">StackFrame</a>;
<a name="l00037"></a>00037
<a name="l00039"></a><a class="code" href="classDynamicContext.html">00039</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> : <span class="keyword">public</span> <a class="code" href="classStaticContext.html" title="The parse time static context interface.">StaticContext</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a><a class="code" href="classDynamicContext.html#a28e3084b59b68a270961e36dd25e6199">00042</a> <span class="keyword">virtual</span> <a class="code" href="classDynamicContext.html#a28e3084b59b68a270961e36dd25e6199">~DynamicContext</a>() {};
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">virtual</span> <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *createModuleDynamicContext(<span class="keyword">const</span> <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a>* moduleCtx, XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
<a name="l00045"></a>00045 XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) <span class="keyword">const</span> = 0;
<a name="l00046"></a>00046
<a name="l00048"></a>00048 <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearDynamicContext() = 0;
<a name="l00049"></a>00049
<a name="l00051"></a>00051 <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html">Item::Ptr</a> getContextItem() <span class="keyword">const</span> = 0;
<a name="l00053"></a>00053 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setContextItem(<span class="keyword">const</span> <a class="code" href="classRefCountPointer.html">Item::Ptr</a> &amp;item) = 0;
<a name="l00054"></a>00054
<a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getContextPosition() <span class="keyword">const</span> = 0;
<a name="l00058"></a>00058 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setContextPosition(<span class="keywordtype">size_t</span> pos) = 0;
<a name="l00059"></a>00059
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getContextSize() <span class="keyword">const</span> = 0;
<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setContextSize(<span class="keywordtype">size_t</span> size) = 0;
<a name="l00064"></a>00064
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classVariableStore.html" title="The pure virtual base class for accessing variables at runtime.">VariableStore</a>* getVariableStore() <span class="keyword">const</span> = 0;
<a name="l00068"></a>00068 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setVariableStore(<span class="keyword">const</span> <a class="code" href="classVariableStore.html" title="The pure virtual base class for accessing variables at runtime.">VariableStore</a> *store) = 0;
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classVariableStore.html" title="The pure virtual base class for accessing variables at runtime.">VariableStore</a>* getGlobalVariableStore() <span class="keyword">const</span> = 0;
<a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setGlobalVariableStore(<span class="keyword">const</span> <a class="code" href="classVariableStore.html" title="The pure virtual base class for accessing variables at runtime.">VariableStore</a> *store) = 0;
<a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setExternalVariable(<span class="keyword">const</span> XMLCh *namespaceURI, <span class="keyword">const</span> XMLCh *name, <span class="keyword">const</span> <a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a> &amp;value) = 0;
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setExternalVariable(<span class="keyword">const</span> XMLCh *qname, <span class="keyword">const</span> <a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a> &amp;value) = 0;
<a name="l00077"></a>00077
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRegexGroupStore.html" title="The pure virtual base class for accessing regular expression group values at runtime...">RegexGroupStore</a>* getRegexGroupStore() <span class="keyword">const</span> = 0;
<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setRegexGroupStore(<span class="keyword">const</span> <a class="code" href="classRegexGroupStore.html" title="The pure virtual base class for accessing regular expression group values at runtime...">RegexGroupStore</a> *store) = 0;
<a name="l00082"></a>00082
<a name="l00084"></a>00084 <span class="keyword">virtual</span> time_t getCurrentTime() <span class="keyword">const</span> = 0;
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setCurrentTime(time_t newTime) = 0;
<a name="l00087"></a>00087
<a name="l00089"></a>00089 <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">ATDurationOrDerived::Ptr</a> getImplicitTimezone() <span class="keyword">const</span> = 0;
<a name="l00091"></a>00091 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setImplicitTimezone(<span class="keyword">const</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">ATDurationOrDerived::Ptr</a> &amp;timezoneAsDuration) = 0;
<a name="l00092"></a>00092
<a name="l00094"></a>00094 <span class="comment">// XQilla context specific accessors //</span>
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keywordtype">void</span> registerURIResolver(<a class="code" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways.">URIResolver</a> *resolver, <span class="keywordtype">bool</span> adopt) = 0;
<a name="l00111"></a>00111 <span class="keyword">virtual</span> <a class="code" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways.">URIResolver</a> *getDefaultURIResolver() <span class="keyword">const</span> = 0;
<a name="l00113"></a>00113 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDefaultURIResolver(<a class="code" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways.">URIResolver</a> *resolver, <span class="keywordtype">bool</span> adopt) = 0;
<a name="l00114"></a>00114
<a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDebugListener(<a class="code" href="classDebugListener.html" title="A class used to listen for debugging information.">DebugListener</a> *listener) = 0;
<a name="l00118"></a>00118 <span class="keyword">virtual</span> <a class="code" href="classDebugListener.html" title="A class used to listen for debugging information.">DebugListener</a> *getDebugListener() <span class="keyword">const</span> = 0;
<a name="l00119"></a>00119
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStackFrame(<span class="keyword">const</span> <a class="code" href="classStackFrame.html" title="A class that represents an item in a query call stack.">StackFrame</a> *frame) = 0;
<a name="l00123"></a>00123 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classStackFrame.html" title="A class that represents an item in a query call stack.">StackFrame</a> *getStackFrame() <span class="keyword">const</span> = 0;
<a name="l00124"></a>00124
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">Node::Ptr</a> parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &amp;srcToUse,
<a name="l00127"></a>00127 <span class="keyword">const</span> <a class="code" href="classLocationInfo.html" title="A class that gives records a location in the query.">LocationInfo</a> *location = 0, <span class="keyword">const</span> QueryPathNode *projection = 0) = 0;
<a name="l00130"></a>00130 <span class="keyword">virtual</span> <a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a> resolveDocument(<span class="keyword">const</span> XMLCh* uri, <span class="keyword">const</span> <a class="code" href="classLocationInfo.html" title="A class that gives records a location in the query.">LocationInfo</a> *location = 0,
<a name="l00131"></a>00131 <span class="keyword">const</span> QueryPathNode *projection = 0) = 0;
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a> resolveCollection(<span class="keyword">const</span> XMLCh* uri, <span class="keyword">const</span> <a class="code" href="classLocationInfo.html" title="A class that gives records a location in the query.">LocationInfo</a> *location = 0,
<a name="l00135"></a>00135 <span class="keyword">const</span> QueryPathNode *projection = 0) = 0;
<a name="l00137"></a>00137 <span class="keyword">virtual</span> <a class="code" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a> resolveDefaultCollection(<span class="keyword">const</span> QueryPathNode *projection = 0) = 0;
<a name="l00138"></a>00138
<a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> putDocument(<span class="keyword">const</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">Node::Ptr</a> &amp;document, <span class="keyword">const</span> XMLCh *uri) = 0;
<a name="l00142"></a>00142
<a name="l00145"></a>00145 <span class="keyword">virtual</span> <a class="code" href="classSequenceBuilder.html">SequenceBuilder</a> *createSequenceBuilder() <span class="keyword">const</span> = 0;
<a name="l00146"></a>00146
<a name="l00149"></a>00149 <span class="keyword">virtual</span> <a class="code" href="classUpdateFactory.html">UpdateFactory</a> *createUpdateFactory() <span class="keyword">const</span> = 0;
<a name="l00150"></a>00150
<a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">void</span> testInterrupt() <span class="keyword">const</span> = 0;
<a name="l00153"></a>00153 };
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <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>