source: NonGTP/Xerces/xerces/doc/html/apiDocs/classXMLGrammarPool.html @ 358

Revision 358, 38.8 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>XMLGrammarPool class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>XMLGrammarPool  Class Reference</h1>Inheritance diagram for XMLGrammarPool:<p><center><img src="classXMLGrammarPool__inherit__graph.gif" border="0" usemap="#XMLGrammarPool__inherit__map" alt="Inheritance graph"></center>
45<map name="XMLGrammarPool__inherit__map">
46<area href="classXMemory.html" shape="rect" coords="33,36,103,17" alt="">
47</map>
48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XMLGrammarPool:<p><center><img src="classXMLGrammarPool__coll__graph.gif" border="0" usemap="#XMLGrammarPool__coll__map" alt="Collaboration graph"></center>
49<map name="XMLGrammarPool__coll__map">
50<area href="classXMemory.html" shape="rect" coords="7,36,76,17" alt="">
51<area href="classMemoryManager.html" shape="rect" coords="100,36,209,17" alt="">
52</map>
53<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXMLGrammarPool-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
54<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
55<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#a0">serializeGrammars</a> (<a class="el" href="classBinOutputStream.html">BinOutputStream</a> *const)=0</td></tr>
56<tr><td>&nbsp;</td><td><font size=-1><em>serialization and deserialization support.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
57<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#a1">deserializeGrammars</a> (<a class="el" href="classBinInputStream.html">BinInputStream</a> *const)=0</td></tr>
58<tr><td colspan="2"><div class="groupHeader">Virtual destructor for derived classes</div></td></tr>
59<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z288_0">~XMLGrammarPool</a> ()</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>virtual destructor.</em> <a href="#z288_0">More...</a><em></em></font><br><br></td></tr>
61<tr><td colspan="2"><div class="groupHeader">The Grammar Pool Interface</div></td></tr>
62<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_0">cacheGrammar</a> (<a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *const gramToCache)=0</td></tr>
63<tr><td>&nbsp;</td><td><font size=-1><em>cacheGrammar.</em> <a href="#z289_0">More...</a><em></em></font><br><br></td></tr>
64<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_1">retrieveGrammar</a> (<a class="el" href="classXMLGrammarDescription.html">XMLGrammarDescription</a> *const gramDesc)=0</td></tr>
65<tr><td>&nbsp;</td><td><font size=-1><em>retrieveGrammar.</em> <a href="#z289_1">More...</a><em></em></font><br><br></td></tr>
66<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_2">orphanGrammar</a> (const XMLCh *const nameSpaceKey)=0</td></tr>
67<tr><td>&nbsp;</td><td><font size=-1><em>orphanGrammar.</em> <a href="#z289_2">More...</a><em></em></font><br><br></td></tr>
68<tr><td nowrap align=right valign=top>virtual RefHashTableOfEnumerator&lt;<br>
69 <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_3">getGrammarEnumerator</a> () const=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Get an enumeration of the cached Grammars in the Grammar pool.</em> <a href="#z289_3">More...</a><em></em></font><br><br></td></tr>
71<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_4">clear</a> ()=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>clear.</em> <a href="#z289_4">More...</a><em></em></font><br><br></td></tr>
73<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_5">lockPool</a> ()=0</td></tr>
74<tr><td>&nbsp;</td><td><font size=-1><em>lockPool.</em> <a href="#z289_5">More...</a><em></em></font><br><br></td></tr>
75<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z289_6">unlockPool</a> ()=0</td></tr>
76<tr><td>&nbsp;</td><td><font size=-1><em>unlockPool.</em> <a href="#z289_6">More...</a><em></em></font><br><br></td></tr>
77<tr><td colspan="2"><div class="groupHeader">Factory interface</div></td></tr>
78<tr><td nowrap align=right valign=top>virtual DTDGrammar *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z290_0">createDTDGrammar</a> ()=0</td></tr>
79<tr><td>&nbsp;</td><td><font size=-1><em>createDTDGrammar.</em> <a href="#z290_0">More...</a><em></em></font><br><br></td></tr>
80<tr><td nowrap align=right valign=top>virtual SchemaGrammar *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z290_1">createSchemaGrammar</a> ()=0</td></tr>
81<tr><td>&nbsp;</td><td><font size=-1><em>createSchemaGrammar.</em> <a href="#z290_1">More...</a><em></em></font><br><br></td></tr>
82<tr><td nowrap align=right valign=top>virtual <a class="el" href="classXMLDTDDescription.html">XMLDTDDescription</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z290_2">createDTDDescription</a> (const XMLCh *const systemId)=0</td></tr>
83<tr><td>&nbsp;</td><td><font size=-1><em>createDTDDescription.</em> <a href="#z290_2">More...</a><em></em></font><br><br></td></tr>
84<tr><td nowrap align=right valign=top>virtual <a class="el" href="classXMLSchemaDescription.html">XMLSchemaDescription</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z290_3">createSchemaDescription</a> (const XMLCh *const targetNamespace)=0</td></tr>
85<tr><td>&nbsp;</td><td><font size=-1><em>createSchemaDescription.</em> <a href="#z290_3">More...</a><em></em></font><br><br></td></tr>
86<tr><td colspan="2"><div class="groupHeader">schema component model support</div></td></tr>
87<tr><td nowrap align=right valign=top>virtual <a class="el" href="classXSModel.html">XSModel</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z291_0">getXSModel</a> ()=0</td></tr>
88<tr><td nowrap align=right valign=top>virtual <a class="el" href="classXSModel.html">XSModel</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z291_1">getXSModel</a> (bool &amp;XSModelWasChanged)</td></tr>
89<tr><td colspan="2"><div class="groupHeader">Getter</div></td></tr>
90<tr><td nowrap align=right valign=top><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z292_0">getMemoryManager</a> ()</td></tr>
91<tr><td>&nbsp;</td><td><font size=-1><em>getMemoryManager.</em> <a href="#z292_0">More...</a><em></em></font><br><br></td></tr>
92<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSNamedMap_8hpp.html#a1">XMLStringPool</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z292_1">getURIStringPool</a> ()=0</td></tr>
93<tr><td>&nbsp;</td><td><font size=-1><em>Return an XMLStringPool for use by validation routines.</em> <a href="#z292_1">More...</a><em></em></font><br><br></td></tr>
94<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
95<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
96<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLGrammarPool.html#z293_0">XMLGrammarPool</a> (<a class="el" href="classMemoryManager.html">MemoryManager</a> *const memMgr=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
97</table>
98<hr><h2>Constructor &amp; Destructor Documentation</h2>
99<a name="z288_0" doxytag="XMLGrammarPool::~XMLGrammarPool"></a><p>
100<table width="100%" cellpadding="2" cellspacing="0" border="0">
101  <tr>
102    <td class="md">
103      <table cellpadding="0" cellspacing="0" border="0">
104        <tr>
105          <td class="md" nowrap valign="top"> virtual XMLGrammarPool::~XMLGrammarPool </td>
106          <td class="md" valign="top">(&nbsp;</td>
107          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
108          <td class="md" valign="top">)&nbsp;</td>
109          <td class="md" nowrap><code> [virtual]</code></td>
110        </tr>
111
112      </table>
113    </td>
114  </tr>
115</table>
116<table cellspacing=5 cellpadding=0 border=0>
117  <tr>
118    <td>
119      &nbsp;
120    </td>
121    <td>
122
123<p>
124virtual destructor.
125<p>
126    </td>
127  </tr>
128</table>
129<a name="z293_0" doxytag="XMLGrammarPool::XMLGrammarPool"></a><p>
130<table width="100%" cellpadding="2" cellspacing="0" border="0">
131  <tr>
132    <td class="md">
133      <table cellpadding="0" cellspacing="0" border="0">
134        <tr>
135          <td class="md" nowrap valign="top"> XMLGrammarPool::XMLGrammarPool </td>
136          <td class="md" valign="top">(&nbsp;</td>
137          <td class="md" nowrap valign="top"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
138          <td class="mdname1" valign="top" nowrap>&nbsp; <em>memMgr</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>          </td>
139          <td class="md" valign="top">)&nbsp;</td>
140          <td class="md" nowrap><code> [protected]</code></td>
141        </tr>
142
143      </table>
144    </td>
145  </tr>
146</table>
147<table cellspacing=5 cellpadding=0 border=0>
148  <tr>
149    <td>
150      &nbsp;
151    </td>
152    <td>
153
154<p>
155    </td>
156  </tr>
157</table>
158<hr><h2>Member Function Documentation</h2>
159<a name="z289_0" doxytag="XMLGrammarPool::cacheGrammar"></a><p>
160<table width="100%" cellpadding="2" cellspacing="0" border="0">
161  <tr>
162    <td class="md">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top"> virtual bool XMLGrammarPool::cacheGrammar </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="md" nowrap valign="top"><a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *const&nbsp;</td>
168          <td class="mdname1" valign="top" nowrap>&nbsp; <em>gramToCache</em>          </td>
169          <td class="md" valign="top">)&nbsp;</td>
170          <td class="md" nowrap><code> [pure virtual]</code></td>
171        </tr>
172
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing=5 cellpadding=0 border=0>
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185cacheGrammar.
186<p>
187Provide the grammar pool with an opportunity to cache the given grammar. If the pool does not choose to do so, it should return false; otherwise, it should return true, so that the caller knows whether the grammar has been adopted.<dl compact><dt><b>
188Parameters: </b><dd>
189<table border=0 cellspacing=2 cellpadding=0>
190<tr><td valign=top><em>gramToCache:</em>&nbsp;</td><td>
191the Grammar to be cached in the grammar pool </td></tr>
192</table>
193</dl><dl compact><dt><b>
194Returns: </b><dd>
195true if the grammar pool has elected to cache the grammar (in which case it is assumed to have adopted it); false if it does not cache it </dl>    </td>
196  </tr>
197</table>
198<a name="z289_4" doxytag="XMLGrammarPool::clear"></a><p>
199<table width="100%" cellpadding="2" cellspacing="0" border="0">
200  <tr>
201    <td class="md">
202      <table cellpadding="0" cellspacing="0" border="0">
203        <tr>
204          <td class="md" nowrap valign="top"> virtual bool XMLGrammarPool::clear </td>
205          <td class="md" valign="top">(&nbsp;</td>
206          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
207          <td class="md" valign="top">)&nbsp;</td>
208          <td class="md" nowrap><code> [pure virtual]</code></td>
209        </tr>
210
211      </table>
212    </td>
213  </tr>
214</table>
215<table cellspacing=5 cellpadding=0 border=0>
216  <tr>
217    <td>
218      &nbsp;
219    </td>
220    <td>
221
222<p>
223clear.
224<p>
225all grammars are removed from the grammar pool and deleted. <dl compact><dt><b>
226Returns: </b><dd>
227true if the grammar pool was cleared. false if it did not. </dl>    </td>
228  </tr>
229</table>
230<a name="z290_2" doxytag="XMLGrammarPool::createDTDDescription"></a><p>
231<table width="100%" cellpadding="2" cellspacing="0" border="0">
232  <tr>
233    <td class="md">
234      <table cellpadding="0" cellspacing="0" border="0">
235        <tr>
236          <td class="md" nowrap valign="top"> virtual <a class="el" href="classXMLDTDDescription.html">XMLDTDDescription</a>* XMLGrammarPool::createDTDDescription </td>
237          <td class="md" valign="top">(&nbsp;</td>
238          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
239          <td class="mdname1" valign="top" nowrap>&nbsp; <em>systemId</em>          </td>
240          <td class="md" valign="top">)&nbsp;</td>
241          <td class="md" nowrap><code> [pure virtual]</code></td>
242        </tr>
243
244      </table>
245    </td>
246  </tr>
247</table>
248<table cellspacing=5 cellpadding=0 border=0>
249  <tr>
250    <td>
251      &nbsp;
252    </td>
253    <td>
254
255<p>
256createDTDDescription.
257<p>
258    </td>
259  </tr>
260</table>
261<a name="z290_0" doxytag="XMLGrammarPool::createDTDGrammar"></a><p>
262<table width="100%" cellpadding="2" cellspacing="0" border="0">
263  <tr>
264    <td class="md">
265      <table cellpadding="0" cellspacing="0" border="0">
266        <tr>
267          <td class="md" nowrap valign="top"> virtual DTDGrammar* XMLGrammarPool::createDTDGrammar </td>
268          <td class="md" valign="top">(&nbsp;</td>
269          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
270          <td class="md" valign="top">)&nbsp;</td>
271          <td class="md" nowrap><code> [pure virtual]</code></td>
272        </tr>
273
274      </table>
275    </td>
276  </tr>
277</table>
278<table cellspacing=5 cellpadding=0 border=0>
279  <tr>
280    <td>
281      &nbsp;
282    </td>
283    <td>
284
285<p>
286createDTDGrammar.
287<p>
288    </td>
289  </tr>
290</table>
291<a name="z290_3" doxytag="XMLGrammarPool::createSchemaDescription"></a><p>
292<table width="100%" cellpadding="2" cellspacing="0" border="0">
293  <tr>
294    <td class="md">
295      <table cellpadding="0" cellspacing="0" border="0">
296        <tr>
297          <td class="md" nowrap valign="top"> virtual <a class="el" href="classXMLSchemaDescription.html">XMLSchemaDescription</a>* XMLGrammarPool::createSchemaDescription </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap>&nbsp; <em>targetNamespace</em>          </td>
301          <td class="md" valign="top">)&nbsp;</td>
302          <td class="md" nowrap><code> [pure virtual]</code></td>
303        </tr>
304
305      </table>
306    </td>
307  </tr>
308</table>
309<table cellspacing=5 cellpadding=0 border=0>
310  <tr>
311    <td>
312      &nbsp;
313    </td>
314    <td>
315
316<p>
317createSchemaDescription.
318<p>
319    </td>
320  </tr>
321</table>
322<a name="z290_1" doxytag="XMLGrammarPool::createSchemaGrammar"></a><p>
323<table width="100%" cellpadding="2" cellspacing="0" border="0">
324  <tr>
325    <td class="md">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top"> virtual SchemaGrammar* XMLGrammarPool::createSchemaGrammar </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
331          <td class="md" valign="top">)&nbsp;</td>
332          <td class="md" nowrap><code> [pure virtual]</code></td>
333        </tr>
334
335      </table>
336    </td>
337  </tr>
338</table>
339<table cellspacing=5 cellpadding=0 border=0>
340  <tr>
341    <td>
342      &nbsp;
343    </td>
344    <td>
345
346<p>
347createSchemaGrammar.
348<p>
349    </td>
350  </tr>
351</table>
352<a name="a1" doxytag="XMLGrammarPool::deserializeGrammars"></a><p>
353<table width="100%" cellpadding="2" cellspacing="0" border="0">
354  <tr>
355    <td class="md">
356      <table cellpadding="0" cellspacing="0" border="0">
357        <tr>
358          <td class="md" nowrap valign="top"> virtual void XMLGrammarPool::deserializeGrammars </td>
359          <td class="md" valign="top">(&nbsp;</td>
360          <td class="md" nowrap valign="top"><a class="el" href="classBinInputStream.html">BinInputStream</a> *&nbsp;</td>
361          <td class="mdname1" valign="top" nowrap>&nbsp; <em>const</em>          </td>
362          <td class="md" valign="top">)&nbsp;</td>
363          <td class="md" nowrap><code> [pure virtual]</code></td>
364        </tr>
365
366      </table>
367    </td>
368  </tr>
369</table>
370<table cellspacing=5 cellpadding=0 border=0>
371  <tr>
372    <td>
373      &nbsp;
374    </td>
375    <td>
376
377<p>
378    </td>
379  </tr>
380</table>
381<a name="z289_3" doxytag="XMLGrammarPool::getGrammarEnumerator"></a><p>
382<table width="100%" cellpadding="2" cellspacing="0" border="0">
383  <tr>
384    <td class="md">
385      <table cellpadding="0" cellspacing="0" border="0">
386        <tr>
387          <td class="md" nowrap valign="top"> virtual RefHashTableOfEnumerator&lt;<a class="el" href="XSModel_8hpp.html#a1">Grammar</a>&gt; XMLGrammarPool::getGrammarEnumerator </td>
388          <td class="md" valign="top">(&nbsp;</td>
389          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
390          <td class="md" valign="top">)&nbsp;</td>
391          <td class="md" nowrap> const<code> [pure virtual]</code></td>
392        </tr>
393
394      </table>
395    </td>
396  </tr>
397</table>
398<table cellspacing=5 cellpadding=0 border=0>
399  <tr>
400    <td>
401      &nbsp;
402    </td>
403    <td>
404
405<p>
406Get an enumeration of the cached Grammars in the Grammar pool.
407<p>
408<dl compact><dt><b>
409Returns: </b><dd>
410enumeration of the cached Grammars in Grammar pool </dl>    </td>
411  </tr>
412</table>
413<a name="z292_0" doxytag="XMLGrammarPool::getMemoryManager"></a><p>
414<table width="100%" cellpadding="2" cellspacing="0" border="0">
415  <tr>
416    <td class="md">
417      <table cellpadding="0" cellspacing="0" border="0">
418        <tr>
419          <td class="md" nowrap valign="top"> <a class="el" href="classMemoryManager.html">MemoryManager</a>* const XMLGrammarPool::getMemoryManager </td>
420          <td class="md" valign="top">(&nbsp;</td>
421          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
422          <td class="md" valign="top">)&nbsp;</td>
423          <td class="md" nowrap></td>
424        </tr>
425
426      </table>
427    </td>
428  </tr>
429</table>
430<table cellspacing=5 cellpadding=0 border=0>
431  <tr>
432    <td>
433      &nbsp;
434    </td>
435    <td>
436
437<p>
438getMemoryManager.
439<p>
440    </td>
441  </tr>
442</table>
443<a name="z292_1" doxytag="XMLGrammarPool::getURIStringPool"></a><p>
444<table width="100%" cellpadding="2" cellspacing="0" border="0">
445  <tr>
446    <td class="md">
447      <table cellpadding="0" cellspacing="0" border="0">
448        <tr>
449          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSNamedMap_8hpp.html#a1">XMLStringPool</a>* XMLGrammarPool::getURIStringPool </td>
450          <td class="md" valign="top">(&nbsp;</td>
451          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
452          <td class="md" valign="top">)&nbsp;</td>
453          <td class="md" nowrap><code> [pure virtual]</code></td>
454        </tr>
455
456      </table>
457    </td>
458  </tr>
459</table>
460<table cellspacing=5 cellpadding=0 border=0>
461  <tr>
462    <td>
463      &nbsp;
464    </td>
465    <td>
466
467<p>
468Return an XMLStringPool for use by validation routines.
469<p>
470Implementations should not create a string pool on each call to this method, but should maintain one string pool for all grammars for which this pool is responsible.     </td>
471  </tr>
472</table>
473<a name="z291_1" doxytag="XMLGrammarPool::getXSModel"></a><p>
474<table width="100%" cellpadding="2" cellspacing="0" border="0">
475  <tr>
476    <td class="md">
477      <table cellpadding="0" cellspacing="0" border="0">
478        <tr>
479          <td class="md" nowrap valign="top"> virtual <a class="el" href="classXSModel.html">XSModel</a>* XMLGrammarPool::getXSModel </td>
480          <td class="md" valign="top">(&nbsp;</td>
481          <td class="md" nowrap valign="top">bool &amp;&nbsp;</td>
482          <td class="mdname1" valign="top" nowrap>&nbsp; <em>XSModelWasChanged</em>          </td>
483          <td class="md" valign="top">)&nbsp;</td>
484          <td class="md" nowrap><code> [virtual]</code></td>
485        </tr>
486
487      </table>
488    </td>
489  </tr>
490</table>
491<table cellspacing=5 cellpadding=0 border=0>
492  <tr>
493    <td>
494      &nbsp;
495    </td>
496    <td>
497
498<p>
499    </td>
500  </tr>
501</table>
502<a name="z291_0" doxytag="XMLGrammarPool::getXSModel"></a><p>
503<table width="100%" cellpadding="2" cellspacing="0" border="0">
504  <tr>
505    <td class="md">
506      <table cellpadding="0" cellspacing="0" border="0">
507        <tr>
508          <td class="md" nowrap valign="top"> virtual <a class="el" href="classXSModel.html">XSModel</a>* XMLGrammarPool::getXSModel </td>
509          <td class="md" valign="top">(&nbsp;</td>
510          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
511          <td class="md" valign="top">)&nbsp;</td>
512          <td class="md" nowrap><code> [pure virtual]</code></td>
513        </tr>
514
515      </table>
516    </td>
517  </tr>
518</table>
519<table cellspacing=5 cellpadding=0 border=0>
520  <tr>
521    <td>
522      &nbsp;
523    </td>
524    <td>
525
526<p>
527    </td>
528  </tr>
529</table>
530<a name="z289_5" doxytag="XMLGrammarPool::lockPool"></a><p>
531<table width="100%" cellpadding="2" cellspacing="0" border="0">
532  <tr>
533    <td class="md">
534      <table cellpadding="0" cellspacing="0" border="0">
535        <tr>
536          <td class="md" nowrap valign="top"> virtual void XMLGrammarPool::lockPool </td>
537          <td class="md" valign="top">(&nbsp;</td>
538          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
539          <td class="md" valign="top">)&nbsp;</td>
540          <td class="md" nowrap><code> [pure virtual]</code></td>
541        </tr>
542
543      </table>
544    </td>
545  </tr>
546</table>
547<table cellspacing=5 cellpadding=0 border=0>
548  <tr>
549    <td>
550      &nbsp;
551    </td>
552    <td>
553
554<p>
555lockPool.
556<p>
557When this method is called by the application, the  grammar pool should stop adding new grammars to the cache. This should result in the grammar pool being sharable among parsers operating in different threads.     </td>
558  </tr>
559</table>
560<a name="z289_2" doxytag="XMLGrammarPool::orphanGrammar"></a><p>
561<table width="100%" cellpadding="2" cellspacing="0" border="0">
562  <tr>
563    <td class="md">
564      <table cellpadding="0" cellspacing="0" border="0">
565        <tr>
566          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* XMLGrammarPool::orphanGrammar </td>
567          <td class="md" valign="top">(&nbsp;</td>
568          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
569          <td class="mdname1" valign="top" nowrap>&nbsp; <em>nameSpaceKey</em>          </td>
570          <td class="md" valign="top">)&nbsp;</td>
571          <td class="md" nowrap><code> [pure virtual]</code></td>
572        </tr>
573
574      </table>
575    </td>
576  </tr>
577</table>
578<table cellspacing=5 cellpadding=0 border=0>
579  <tr>
580    <td>
581      &nbsp;
582    </td>
583    <td>
584
585<p>
586orphanGrammar.
587<p>
588grammar removed from the grammar pool and owned by the caller<dl compact><dt><b>
589Parameters: </b><dd>
590<table border=0 cellspacing=2 cellpadding=0>
591<tr><td valign=top><em>nameSpaceKey:</em>&nbsp;</td><td>
592Key used to search for grammar in the grammar pool </td></tr>
593</table>
594</dl><dl compact><dt><b>
595Returns: </b><dd>
596the grammar that was removed from the pool (0 if none) </dl>    </td>
597  </tr>
598</table>
599<a name="z289_1" doxytag="XMLGrammarPool::retrieveGrammar"></a><p>
600<table width="100%" cellpadding="2" cellspacing="0" border="0">
601  <tr>
602    <td class="md">
603      <table cellpadding="0" cellspacing="0" border="0">
604        <tr>
605          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* XMLGrammarPool::retrieveGrammar </td>
606          <td class="md" valign="top">(&nbsp;</td>
607          <td class="md" nowrap valign="top"><a class="el" href="classXMLGrammarDescription.html">XMLGrammarDescription</a> *const&nbsp;</td>
608          <td class="mdname1" valign="top" nowrap>&nbsp; <em>gramDesc</em>          </td>
609          <td class="md" valign="top">)&nbsp;</td>
610          <td class="md" nowrap><code> [pure virtual]</code></td>
611        </tr>
612
613      </table>
614    </td>
615  </tr>
616</table>
617<table cellspacing=5 cellpadding=0 border=0>
618  <tr>
619    <td>
620      &nbsp;
621    </td>
622    <td>
623
624<p>
625retrieveGrammar.
626<p>
627<dl compact><dt><b>
628Parameters: </b><dd>
629<table border=0 cellspacing=2 cellpadding=0>
630<tr><td valign=top><em>gramDesc:</em>&nbsp;</td><td>
631the Grammar Description used to search for grammar cached in the grammar pool </td></tr>
632</table>
633</dl>    </td>
634  </tr>
635</table>
636<a name="a0" doxytag="XMLGrammarPool::serializeGrammars"></a><p>
637<table width="100%" cellpadding="2" cellspacing="0" border="0">
638  <tr>
639    <td class="md">
640      <table cellpadding="0" cellspacing="0" border="0">
641        <tr>
642          <td class="md" nowrap valign="top"> virtual void XMLGrammarPool::serializeGrammars </td>
643          <td class="md" valign="top">(&nbsp;</td>
644          <td class="md" nowrap valign="top"><a class="el" href="classBinOutputStream.html">BinOutputStream</a> *&nbsp;</td>
645          <td class="mdname1" valign="top" nowrap>&nbsp; <em>const</em>          </td>
646          <td class="md" valign="top">)&nbsp;</td>
647          <td class="md" nowrap><code> [pure virtual]</code></td>
648        </tr>
649
650      </table>
651    </td>
652  </tr>
653</table>
654<table cellspacing=5 cellpadding=0 border=0>
655  <tr>
656    <td>
657      &nbsp;
658    </td>
659    <td>
660
661<p>
662serialization and deserialization support.
663<p>
664    </td>
665  </tr>
666</table>
667<a name="z289_6" doxytag="XMLGrammarPool::unlockPool"></a><p>
668<table width="100%" cellpadding="2" cellspacing="0" border="0">
669  <tr>
670    <td class="md">
671      <table cellpadding="0" cellspacing="0" border="0">
672        <tr>
673          <td class="md" nowrap valign="top"> virtual void XMLGrammarPool::unlockPool </td>
674          <td class="md" valign="top">(&nbsp;</td>
675          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
676          <td class="md" valign="top">)&nbsp;</td>
677          <td class="md" nowrap><code> [pure virtual]</code></td>
678        </tr>
679
680      </table>
681    </td>
682  </tr>
683</table>
684<table cellspacing=5 cellpadding=0 border=0>
685  <tr>
686    <td>
687      &nbsp;
688    </td>
689    <td>
690
691<p>
692unlockPool.
693<p>
694After this method has been called, the grammar pool implementation should return to its default behaviour when cacheGrammars(...) is called. One effect, depending on the underlying implementation, is that the grammar pool may no longer be thread-safe (even on read operations).
695<p>
696For PSVI support any previous <a class="el" href="classXSModel.html">XSModel</a> that was produced will be deleted.     </td>
697  </tr>
698</table>
699<hr>The documentation for this class was generated from the following file:<ul>
700<li><a class="el" href="XMLGrammarPool_8hpp-source.html">XMLGrammarPool.hpp</a></ul>
701    </FONT></TD></TR></TABLE><BR>
702</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
703              Copyright &copy; 1994-2004 The Apache Software Foundation.
704              All Rights Reserved.
705            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.