<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: XMLGrammarPool.hpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>XMLGrammarPool.hpp</h1><a href="XMLGrammarPool_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"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00006"></a>00006 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"> * </span>
<a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00010"></a>00010 <span class="comment"> * </span>
<a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">/*</span>
<a name="l00019"></a>00019 <span class="comment"> * $Id: XMLGrammarPool.hpp 527149 2007-04-10 14:56:39Z amassari $</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_XMLGRAMMARPOOL_HPP)</span>
<a name="l00023"></a><a class="code" href="XMLGrammarPool_8hpp.html#5a7f8d0ad810c3dd8b80f3bc9bcb4e12">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_XMLGRAMMARPOOL_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="PlatformUtils_8hpp.html">xercesc/util/PlatformUtils.hpp</a>></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <xercesc/util/RefHashTableOf.hpp></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="XMemory_8hpp.html">xercesc/util/XMemory.hpp</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="XSModel_8hpp.html">xercesc/framework/psvi/XSModel.hpp</a>></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <a class="code" href="XercesDefs_8hpp.html#43d74fa53d868d978f3e97cbb78b194d">XERCES_CPP_NAMESPACE_BEGIN</a>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span>Grammar;
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classXMLGrammarDescription.html">XMLGrammarDescription</a>;
<a name="l00035"></a>00035 <span class="keyword">class </span>DTDGrammar;
<a name="l00036"></a>00036 <span class="keyword">class </span>SchemaGrammar;
<a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="classXMLDTDDescription.html">XMLDTDDescription</a>;
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="classXMLSchemaDescription.html">XMLSchemaDescription</a>;
<a name="l00039"></a>00039 <span class="keyword">class </span>XMLStringPool;
<a name="l00040"></a>00040 <span class="keyword">class </span><a class="code" href="classBinInputStream.html">BinInputStream</a>;
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="classBinOutputStream.html">BinOutputStream</a>;
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="classXMLGrammarPool.html">00043</a> <span class="keyword">class </span><a class="code" href="XercesDefs_8hpp.html#13df5a01e63e51f62a1467b588b59054">XMLPARSER_EXPORT</a> <a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a> : <span class="keyword">public</span> <a class="code" href="classXMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete...">XMemory</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span> :
<a name="l00046"></a>00046 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00048"></a>00048 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00055"></a><a class="code" href="classXMLGrammarPool.html#792b7f4329e5f5879e697267e1f77045">00055</a> <span class="keyword">virtual</span> ~<a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a>(){};
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00060"></a>00060 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> cacheGrammar(Grammar* <span class="keyword">const</span> gramToCache) = 0;
<a name="l00077"></a>00077
<a name="l00085"></a>00085 <span class="keyword">virtual</span> Grammar* retrieveGrammar(<a class="code" href="classXMLGrammarDescription.html">XMLGrammarDescription</a>* <span class="keyword">const</span> gramDesc) = 0;
<a name="l00086"></a>00086
<a name="l00087"></a>00087
<a name="l00096"></a>00096 <span class="keyword">virtual</span> Grammar* orphanGrammar(<span class="keyword">const</span> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* <span class="keyword">const</span> nameSpaceKey) = 0;
<a name="l00097"></a>00097
<a name="l00098"></a>00098
<a name="l00104"></a>00104 <span class="keyword">virtual</span> RefHashTableOfEnumerator<Grammar> getGrammarEnumerator() <span class="keyword">const</span> = 0;
<a name="l00105"></a>00105
<a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> clear() = 0;
<a name="l00113"></a>00113
<a name="l00123"></a>00123 <span class="keyword">virtual</span> <span class="keywordtype">void</span> lockPool() = 0;
<a name="l00124"></a>00124
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> unlockPool() = 0;
<a name="l00136"></a>00136
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00141"></a>00141 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00143"></a>00143 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="keyword">virtual</span> DTDGrammar* createDTDGrammar() = 0;
<a name="l00149"></a>00149
<a name="l00154"></a>00154 <span class="keyword">virtual</span> SchemaGrammar* createSchemaGrammar() = 0;
<a name="l00155"></a>00155
<a name="l00160"></a>00160 <span class="keyword">virtual</span> <a class="code" href="classXMLDTDDescription.html">XMLDTDDescription</a>* createDTDDescription(<span class="keyword">const</span> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* <span class="keyword">const</span> systemId) = 0;
<a name="l00165"></a>00165 <span class="keyword">virtual</span> <a class="code" href="classXMLSchemaDescription.html">XMLSchemaDescription</a>* createSchemaDescription(<span class="keyword">const</span> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* <span class="keyword">const</span> targetNamespace) = 0;
<a name="l00166"></a>00166
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00171"></a>00171 <span class="comment"></span> <span class="comment">// ----------------------------------------------------------------------- </span>
<a name="l00173"></a>00173 <span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment">/***</span>
<a name="l00175"></a>00175 <span class="comment"> * Return an XSModel derived from the components of all SchemaGrammars</span>
<a name="l00176"></a>00176 <span class="comment"> * in the grammar pool. If the pool is locked, this should</span>
<a name="l00177"></a>00177 <span class="comment"> * be a thread-safe operation.</span>
<a name="l00178"></a>00178 <span class="comment"> *</span>
<a name="l00179"></a>00179 <span class="comment"> * NOTE: The function should NEVER return NULL. If there are no grammars in</span>
<a name="l00180"></a>00180 <span class="comment"> * the pool it should return an XSModel containing the Schema for Schema. </span>
<a name="l00181"></a>00181 <span class="comment"> *</span>
<a name="l00182"></a>00182 <span class="comment"> * Calling getXSModel() on an unlocked grammar pool may result in the</span>
<a name="l00183"></a>00183 <span class="comment"> * creation of a new XSModel with the old XSModel being deleted.</span>
<a name="l00184"></a>00184 <span class="comment"> * The bool parameter will indicate if the XSModel was changed.</span>
<a name="l00185"></a>00185 <span class="comment"> * </span>
<a name="l00186"></a>00186 <span class="comment"> */</span>
<a name="l00187"></a>00187 <span class="keyword">virtual</span> <a class="code" href="classXSModel.html">XSModel</a> *getXSModel(<span class="keywordtype">bool</span>& XSModelWasChanged) = 0;
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">// @}</span>
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00193"></a>00193 <span class="comment"></span> <span class="comment">// ----------------------------------------------------------------------- </span>
<a name="l00195"></a>00195 <span class="comment"></span>
<a name="l00200"></a><a class="code" href="classXMLGrammarPool.html#e12c5153eb902652d3ebd5c8d504e5b3">00200</a> <span class="keyword">inline</span> <a class="code" href="classMemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* getMemoryManager()
<a name="l00201"></a>00201 {
<a name="l00202"></a>00202 <span class="keywordflow">return</span> fMemMgr;
<a name="l00203"></a>00203 }
<a name="l00204"></a>00204
<a name="l00211"></a>00211 <span class="keyword">virtual</span> XMLStringPool *getURIStringPool() = 0;
<a name="l00213"></a>00213
<a name="l00214"></a>00214 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00216"></a>00216 <span class="comment"></span> <span class="comment">// ----------------------------------------------------------------------- </span>
<a name="l00217"></a>00217
<a name="l00218"></a>00218 <span class="comment">/***</span>
<a name="l00219"></a>00219 <span class="comment"> *</span>
<a name="l00220"></a>00220 <span class="comment"> * 1. Context: Serialize/Deserialize All Grammars In One Session</span>
<a name="l00221"></a>00221 <span class="comment"> *</span>
<a name="l00222"></a>00222 <span class="comment"> * Since it is common that a declaration in one grammar may reference </span>
<a name="l00223"></a>00223 <span class="comment"> * to definitions in other grammars, it is required to serialize those </span>
<a name="l00224"></a>00224 <span class="comment"> * related (or interdependent) grammars in to one persistent data store </span>
<a name="l00225"></a>00225 <span class="comment"> * in one serialization session (storing), and deserialize them from the</span>
<a name="l00226"></a>00226 <span class="comment"> * persistent data store in one deserialization session (loading) back</span>
<a name="l00227"></a>00227 <span class="comment"> * to the grammar pool. </span>
<a name="l00228"></a>00228 <span class="comment"> *</span>
<a name="l00229"></a>00229 <span class="comment"> * 2. Multiple serializations</span>
<a name="l00230"></a>00230 <span class="comment"> *</span>
<a name="l00231"></a>00231 <span class="comment"> * It is acceptable that client application requests more than one </span>
<a name="l00232"></a>00232 <span class="comment"> * grammar serialization on a particular grammar pool, to track the </span>
<a name="l00233"></a>00233 <span class="comment"> * different grammars cached, or for whatever reasons that client </span>
<a name="l00234"></a>00234 <span class="comment"> * application is interested in. </span>
<a name="l00235"></a>00235 <span class="comment"> *</span>
<a name="l00236"></a>00236 <span class="comment"> * 3. Multiple deserializations</span>
<a name="l00237"></a>00237 <span class="comment"> * </span>
<a name="l00238"></a>00238 <span class="comment"> * Request for grammar deserialization either after the grammar pool has </span>
<a name="l00239"></a>00239 <span class="comment"> * its own cached grammars, or request for more than one grammar </span>
<a name="l00240"></a>00240 <span class="comment"> * deserialization, may cause undesired and unpredictable consequence</span>
<a name="l00241"></a>00241 <span class="comment"> * and therefore client application shall be aware that individual </span>
<a name="l00242"></a>00242 <span class="comment"> * implementationis may NOT support this.</span>
<a name="l00243"></a>00243 <span class="comment"> *</span>
<a name="l00244"></a>00244 <span class="comment"> * However it is strongly recommended that the client application requests </span>
<a name="l00245"></a>00245 <span class="comment"> * no more than one grammar deserialization even a particular implementation</span>
<a name="l00246"></a>00246 <span class="comment"> * may allow multiple deserializations.</span>
<a name="l00247"></a>00247 <span class="comment"> *</span>
<a name="l00248"></a>00248 <span class="comment"> * 4. Locking</span>
<a name="l00249"></a>00249 <span class="comment"> *</span>
<a name="l00250"></a>00250 <span class="comment"> * Both serialization and deserialization requires to lock the grammar pool</span>
<a name="l00251"></a>00251 <span class="comment"> * before operation and unlock after operation. In the case the grammar pool</span>
<a name="l00252"></a>00252 <span class="comment"> * is locked by a third party, the request for serialization/deserialization</span>
<a name="l00253"></a>00253 <span class="comment"> * will NOT be entertained.</span>
<a name="l00254"></a>00254 <span class="comment"> *</span>
<a name="l00255"></a>00255 <span class="comment"> * 5. Versioning</span>
<a name="l00256"></a>00256 <span class="comment"> *</span>
<a name="l00257"></a>00257 <span class="comment"> * The Persistent data store has a version tag to be verified during </span>
<a name="l00258"></a>00258 <span class="comment"> * deserialization, thus a grammar pool may decide if it supports</span>
<a name="l00259"></a>00259 <span class="comment"> * a binary data created by a different release of Xerces.</span>
<a name="l00260"></a>00260 <span class="comment"> * </span>
<a name="l00261"></a>00261 <span class="comment"> * 6. Clean up</span>
<a name="l00262"></a>00262 <span class="comment"> *</span>
<a name="l00263"></a>00263 <span class="comment"> * The client application shall be aware that in the event of an exception</span>
<a name="l00264"></a>00264 <span class="comment"> * thrown due to a corrupted data store during deserialization, implementation</span>
<a name="l00265"></a>00265 <span class="comment"> * may not be able to clean up all resources allocated, and therefore it is </span>
<a name="l00266"></a>00266 <span class="comment"> * client application's responsibility to clean up those unreleased resources.</span>
<a name="l00267"></a>00267 <span class="comment"> *</span>
<a name="l00268"></a>00268 <span class="comment"> *</span>
<a name="l00269"></a>00269 <span class="comment"> */</span>
<a name="l00270"></a>00270 <span class="keyword">virtual</span> <span class="keywordtype">void</span> serializeGrammars(<a class="code" href="classBinOutputStream.html">BinOutputStream</a>* <span class="keyword">const</span>) = 0;
<a name="l00271"></a>00271 <span class="keyword">virtual</span> <span class="keywordtype">void</span> deserializeGrammars(<a class="code" href="classBinInputStream.html">BinInputStream</a>* <span class="keyword">const</span>) = 0;
<a name="l00272"></a>00272
<a name="l00273"></a>00273 <span class="comment">/*</span>
<a name="l00274"></a>00274 <span class="comment"> * Set/get a flag to not create XSAnnotations when deserializing the grammar.</span>
<a name="l00275"></a>00275 <span class="comment"> * Defaults to false (create XSAnnotations when deserializing the grammar).</span>
<a name="l00276"></a>00276 <span class="comment"> */</span>
<a name="l00277"></a><a class="code" href="classXMLGrammarPool.html#f320d13b44ba404c9653e5934ddd782a">00277</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> setIgnoreSerializedAnnotations(<span class="keyword">const</span> <span class="keywordtype">bool</span> flag)
<a name="l00278"></a>00278 {
<a name="l00279"></a>00279 fIgnoreSerializedAnnotations = flag;
<a name="l00280"></a>00280 };
<a name="l00281"></a><a class="code" href="classXMLGrammarPool.html#9b8187ba62782cc03c0ad1fc6a658023">00281</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> getIgnoreSerializedAnnotations()<span class="keyword"> const</span>
<a name="l00282"></a>00282 <span class="keyword"> </span>{
<a name="l00283"></a>00283 <span class="keywordflow">return</span> fIgnoreSerializedAnnotations;
<a name="l00284"></a>00284 };
<a name="l00285"></a>00285
<a name="l00286"></a>00286 <span class="keyword">protected</span> :
<a name="l00287"></a>00287 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00289"></a>00289 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00291"></a><a class="code" href="classXMLGrammarPool.html#0dc250a1820cebb8aa99449d1c57e502">00291</a> <span class="comment"></span> <a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a>(<a class="code" href="classMemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> memMgr = <a class="code" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252" title="The configurable memory manager.">XMLPlatformUtils::fgMemoryManager</a>)
<a name="l00292"></a>00292 :fMemMgr(memMgr)
<a name="l00293"></a>00293 ,fIgnoreSerializedAnnotations(false)
<a name="l00294"></a>00294 {
<a name="l00295"></a>00295 };
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="keyword">private</span> :
<a name="l00299"></a>00299 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00301"></a>00301 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00303"></a>00303 <span class="comment"></span> <a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a>(<span class="keyword">const</span> <a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a>& );
<a name="l00304"></a>00304 <a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a>& operator=(<span class="keyword">const</span> <a class="code" href="classXMLGrammarPool.html">XMLGrammarPool</a>& );
<a name="l00306"></a>00306
<a name="l00307"></a>00307 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00308"></a>00308 <span class="comment">//</span>
<a name="l00309"></a>00309 <span class="comment">// fMemMgr: plugged-in (or defaulted-in) memory manager</span>
<a name="l00310"></a>00310 <span class="comment">// not owned </span>
<a name="l00311"></a>00311 <span class="comment">// no reset after initialization</span>
<a name="l00312"></a>00312 <span class="comment">//</span>
<a name="l00313"></a>00313 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00314"></a>00314
<a name="l00315"></a>00315 <a class="code" href="classMemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> fMemMgr;
<a name="l00316"></a>00316 <span class="keywordtype">bool</span> fIgnoreSerializedAnnotations;
<a name="l00317"></a>00317
<a name="l00318"></a>00318 };
<a name="l00319"></a>00319
<a name="l00320"></a>00320 <a class="code" href="XercesDefs_8hpp.html#f03d5cb905763ef7a7bd22ab82718285">XERCES_CPP_NAMESPACE_END</a>
<a name="l00321"></a>00321
<a name="l00322"></a>00322 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 29 15:30:48 2010 for Xerces-C++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
contrib-release
>
by-pkgid
>
59e136c5713357bec32fa00e9f43af8f
>
files
>
308
