XQuilla/docs/simple-api/DocumentCache_8hpp_source.html
2020-02-17 22:21:23 +01:00

143 lines
15 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>DocumentCache.hpp</h1><a href="DocumentCache_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$</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _DOCUMENTCACHE_HPP</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _DOCUMENTCACHE_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="XPath2MemoryManager_8hpp.html">xqilla/framework/XPath2MemoryManager.hpp</a>&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;<a class="code" href="Node_8hpp.html">xqilla/items/Node.hpp</a>&gt;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;xercesc/util/XercesDefs.hpp&gt;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;<a class="code" href="XMemory_8hpp.html">xercesc/util/XMemory.hpp</a>&gt;</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a>;
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classStaticContext.html" title="The parse time static context interface.">StaticContext</a>;
<a name="l00035"></a>00035 <span class="keyword">class </span>QualifiedName;
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classLocationInfo.html" title="A class that gives records a location in the query.">LocationInfo</a>;
<a name="l00037"></a><a class="code" href="DocumentCache_8hpp.html#aaab74fdf21f46c72dd5e97f48fecb3b6">00037</a> <span class="keyword">class </span>QueryPathNode;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">typedef</span> std::vector&lt;const XMLCh*, XQillaAllocator&lt;const XMLCh*&gt; &gt; <a class="code" href="DocumentCache_8hpp.html#aaab74fdf21f46c72dd5e97f48fecb3b6">VectorOfStrings</a>;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 XERCES_CPP_NAMESPACE_BEGIN
<a name="l00042"></a>00042 <span class="keyword">class </span>DOMDocument;
<a name="l00043"></a>00043 <span class="keyword">class </span>DOMNode;
<a name="l00044"></a>00044 <span class="keyword">class </span>DatatypeValidator;
<a name="l00045"></a>00045 <span class="keyword">class </span>XMLEntityResolver;
<a name="l00046"></a>00046 <span class="keyword">class </span>ComplexTypeInfo;
<a name="l00047"></a>00047 <span class="keyword">class </span>SchemaElementDecl;
<a name="l00048"></a>00048 <span class="keyword">class </span>SchemaAttDef;
<a name="l00049"></a>00049 <span class="keyword">class </span>InputSource;
<a name="l00050"></a>00050 <span class="keyword">class </span>GrammarResolver;
<a name="l00051"></a>00051 XERCES_CPP_NAMESPACE_END
<a name="l00052"></a>00052
<a name="l00054"></a><a class="code" href="classDocumentCache.html">00054</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classDocumentCache.html" title="Expression Context is a storage for contexts.">DocumentCache</a> : <span class="keyword">public</span> XERCES_CPP_NAMESPACE_QUALIFIER XMemory
<a name="l00055"></a>00055 {
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00058"></a><a class="code" href="classDocumentCache.html#a3e4998ee9a3b6a7fd78e528c2c9c05de">00058</a> <span class="keyword">static</span> <span class="keyword">const</span> XMLCh g_szUntyped[];
<a name="l00059"></a>00059
<a name="l00060"></a><a class="code" href="classDocumentCache.html#a1a52f4dee29626e4085603be380aca4f">00060</a> <span class="keyword">enum</span> <a class="code" href="classDocumentCache.html#a1a52f4dee29626e4085603be380aca4f">ValidationMode</a> {
<a name="l00061"></a><a class="code" href="classDocumentCache.html#a1a52f4dee29626e4085603be380aca4fa4639627cff2ecb5ebb7685db56da071e">00061</a> VALIDATION_STRICT = 0,
<a name="l00062"></a><a class="code" href="classDocumentCache.html#a1a52f4dee29626e4085603be380aca4fa6e20038a40752eb64b8daacecdaadf72">00062</a> VALIDATION_LAX = 1,
<a name="l00063"></a><a class="code" href="classDocumentCache.html#a1a52f4dee29626e4085603be380aca4fa61e7d9802f6f294e1a8efa0a08c97d67">00063</a> VALIDATION_SKIP = 2
<a name="l00064"></a>00064 };
<a name="l00065"></a>00065
<a name="l00067"></a><a class="code" href="classDocumentCache.html#a456f90f0ac61a4d2d5336bd7aa98fc0e">00067</a> <span class="keyword">virtual</span> <a class="code" href="classDocumentCache.html#a456f90f0ac61a4d2d5336bd7aa98fc0e" title="virtual destructor">~DocumentCache</a>() {}
<a name="l00068"></a>00068
<a name="l00070"></a>00070 <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> loadDocument(<span class="keyword">const</span> XMLCh* uri, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context, <span class="keyword">const</span> QueryPathNode *projection = 0) = 0;
<a name="l00072"></a>00072 <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 class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context, <span class="keyword">const</span> QueryPathNode *projection = 0) = 0;
<a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &amp;srcToUse, <a class="code" href="classEventHandler.html">EventHandler</a> *handler, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context) = 0;
<a name="l00075"></a>00075
<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setXMLEntityResolver(XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* <span class="keyword">const</span> handler) = 0;
<a name="l00082"></a>00082 <span class="keyword">virtual</span> XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* getXMLEntityResolver() <span class="keyword">const</span> = 0;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getDoPSVI() <span class="keyword">const</span> = 0;
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDoPSVI(<span class="keywordtype">bool</span> value) = 0;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/*</span>
<a name="l00088"></a>00088 <span class="comment"> * returns true if the type represented by uri:typename is an instance of uriToCheck:typeNameToCheck </span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * ie: to check </span>
<a name="l00091"></a>00091 <span class="comment"> * xs:integer instance of xs:decimal, </span>
<a name="l00092"></a>00092 <span class="comment"> * call</span>
<a name="l00093"></a>00093 <span class="comment"> * isTypeOrDerivedFromType(&quot;xs&quot;, &quot;integer&quot;, &quot;xs&quot;, &quot;decimal&quot;) </span>
<a name="l00094"></a>00094 <span class="comment"> * (except of course, call with URIs, not prefixes!)</span>
<a name="l00095"></a>00095 <span class="comment"> */</span>
<a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isTypeOrDerivedFromType(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> uri, <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> typeName, <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> uriToCheck, <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> typeNameToCheck) <span class="keyword">const</span> = 0;
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isTypeDefined(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> uri, <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> typeName) <span class="keyword">const</span> = 0;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">void</span> addSchemaLocation(<span class="keyword">const</span> XMLCh* uri, <a class="code" href="DocumentCache_8hpp.html#aaab74fdf21f46c72dd5e97f48fecb3b6">VectorOfStrings</a>* locations, <a class="code" href="classStaticContext.html" title="The parse time static context interface.">StaticContext</a> *context, <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="l00100"></a>00100
<a name="l00102"></a>00102 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getSchemaUriId(<span class="keyword">const</span> XMLCh* uri) <span class="keyword">const</span> = 0;
<a name="l00103"></a>00103 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh* getSchemaUri(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">id</span>) <span class="keyword">const</span> = 0;
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keyword">virtual</span> XERCES_CPP_NAMESPACE_QUALIFIER GrammarResolver *getGrammarResolver() <span class="keyword">const</span> = 0;
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">virtual</span> XERCES_CPP_NAMESPACE_QUALIFIER DatatypeValidator* getDatatypeValidator(<span class="keyword">const</span> XMLCh* uri, <span class="keyword">const</span> XMLCh* typeName) <span class="keyword">const</span> = 0;
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">virtual</span> XERCES_CPP_NAMESPACE_QUALIFIER ComplexTypeInfo* getComplexTypeInfo(<span class="keyword">const</span> XMLCh* uri, <span class="keyword">const</span> XMLCh* typeName) <span class="keyword">const</span> = 0;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keyword">virtual</span> XERCES_CPP_NAMESPACE_QUALIFIER SchemaElementDecl* getElementDecl(<span class="keyword">const</span> XMLCh* elementUri, <span class="keyword">const</span> XMLCh* elementName) <span class="keyword">const</span> = 0;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keyword">virtual</span> XERCES_CPP_NAMESPACE_QUALIFIER SchemaAttDef* getAttributeDecl(<span class="keyword">const</span> XMLCh* attributeUri, <span class="keyword">const</span> XMLCh* attributeName) <span class="keyword">const</span> = 0;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">virtual</span> <a class="code" href="classDocumentCache.html" title="Expression Context is a storage for contexts.">DocumentCache</a> *createDerivedCache(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr) <span class="keyword">const</span> = 0;
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span>
<a name="l00120"></a>00120
<a name="l00121"></a>00121
<a name="l00122"></a>00122
<a name="l00123"></a>00123
<a name="l00124"></a>00124
<a name="l00125"></a>00125
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Mar 1 21:15:51 2010 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>