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

Revision 358, 28.9 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>XMLEntityHandler 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>XMLEntityHandler  Class Reference</h1>This abstract class is a callback mechanism for the scanner.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for XMLEntityHandler:<p><center><img src="classXMLEntityHandler__inherit__graph.gif" border="0" usemap="#XMLEntityHandler__inherit__map" alt="Inheritance graph"></center>
48<map name="XMLEntityHandler__inherit__map">
49<area href="classAbstractDOMParser.html" shape="rect" coords="7,105,140,86" alt="">
50<area href="classSAXParser.html" shape="rect" coords="164,105,244,86" alt="">
51<area href="classXercesDOMParser.html" shape="rect" coords="11,174,136,156" alt="">
52</map>
53<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXMLEntityHandler-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 colspan="2"><div class="groupHeader">Destructor</div></td></tr>
56<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z273_0">~XMLEntityHandler</a> ()</td></tr>
57<tr><td>&nbsp;</td><td><font size=-1><em>Default destructor.</em> <a href="#z273_0">More...</a><em></em></font><br><br></td></tr>
58<tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
59<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z274_0">endInputSource</a> (const <a class="el" href="classInputSource.html">InputSource</a> &amp;inputSource)=0</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>This method get called after the scanner has finished reading from the given input source while processing external entity references.</em> <a href="#z274_0">More...</a><em></em></font><br><br></td></tr>
61<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z274_1">expandSystemId</a> (const XMLCh *const systemId, XMLBuffer &amp;toFill)=0</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>This method allows the passes the scanned systemId to the entity handler, thereby giving it a chance to provide any customized handling like resolving relative path names.</em> <a href="#z274_1">More...</a><em></em></font><br><br></td></tr>
63<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z274_2">resetEntities</a> ()=0</td></tr>
64<tr><td>&nbsp;</td><td><font size=-1><em>This method allows the entity handler to reset itself, so that it can be used again.</em> <a href="#z274_2">More...</a><em></em></font><br><br></td></tr>
65<tr><td nowrap align=right valign=top>virtual <a class="el" href="classInputSource.html">InputSource</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z274_3">resolveEntity</a> (const XMLCh *const publicId, const XMLCh *const systemId, const XMLCh *const baseURI=0)=0</td></tr>
66<tr><td>&nbsp;</td><td><font size=-1><em>This method allows the entity handler to provide customized application specific entity resolution.</em> <a href="#z274_3">More...</a><em></em></font><br><br></td></tr>
67<tr><td nowrap align=right valign=top>virtual <a class="el" href="classInputSource.html">InputSource</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z274_4">resolveEntity</a> (<a class="el" href="classXMLResourceIdentifier.html">XMLResourceIdentifier</a> *resourceIdentifier)=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>This method allows the entity handler to provide customized application specific entity resolution.</em> <a href="#z274_4">More...</a><em></em></font><br><br></td></tr>
69<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z274_5">startInputSource</a> (const <a class="el" href="classInputSource.html">InputSource</a> &amp;inputSource)=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>This method will be called before the scanner starts reading from an input source while processing external entity references.</em> <a href="#z274_5">More...</a><em></em></font><br><br></td></tr>
71<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
72<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
73<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityHandler.html#z275_0">XMLEntityHandler</a> ()</td></tr>
74<tr><td>&nbsp;</td><td><font size=-1><em>Protected default constructor.</em> <a href="#z275_0">More...</a><em></em></font><br><br></td></tr>
75</table>
76<hr><a name="_details"></a><h2>Detailed Description</h2>
77This abstract class is a callback mechanism for the scanner.
78<p>
79By creating a derivative of this class and plugging into the scanner, the scanner will call back on the object's methods to entity events.
80<p>
81This class is primarily for use by those writing their own parser classes. If you use the standard parser classes, DOMParser and <a class="el" href="classSAXParser.html">SAXParser</a>, you won't use this API. You will instead use a similar mechanism defined by the SAX API, called <a class="el" href="classEntityResolver.html">EntityResolver</a>.
82<p>
83<hr><h2>Constructor &amp; Destructor Documentation</h2>
84<a name="z273_0" doxytag="XMLEntityHandler::~XMLEntityHandler"></a><p>
85<table width="100%" cellpadding="2" cellspacing="0" border="0">
86  <tr>
87    <td class="md">
88      <table cellpadding="0" cellspacing="0" border="0">
89        <tr>
90          <td class="md" nowrap valign="top"> virtual XMLEntityHandler::~XMLEntityHandler </td>
91          <td class="md" valign="top">(&nbsp;</td>
92          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
93          <td class="md" valign="top">)&nbsp;</td>
94          <td class="md" nowrap><code> [virtual]</code></td>
95        </tr>
96
97      </table>
98    </td>
99  </tr>
100</table>
101<table cellspacing=5 cellpadding=0 border=0>
102  <tr>
103    <td>
104      &nbsp;
105    </td>
106    <td>
107
108<p>
109Default destructor.
110<p>
111    </td>
112  </tr>
113</table>
114<a name="z275_0" doxytag="XMLEntityHandler::XMLEntityHandler"></a><p>
115<table width="100%" cellpadding="2" cellspacing="0" border="0">
116  <tr>
117    <td class="md">
118      <table cellpadding="0" cellspacing="0" border="0">
119        <tr>
120          <td class="md" nowrap valign="top"> XMLEntityHandler::XMLEntityHandler </td>
121          <td class="md" valign="top">(&nbsp;</td>
122          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
123          <td class="md" valign="top">)&nbsp;</td>
124          <td class="md" nowrap><code> [protected]</code></td>
125        </tr>
126
127      </table>
128    </td>
129  </tr>
130</table>
131<table cellspacing=5 cellpadding=0 border=0>
132  <tr>
133    <td>
134      &nbsp;
135    </td>
136    <td>
137
138<p>
139Protected default constructor.
140<p>
141    </td>
142  </tr>
143</table>
144<hr><h2>Member Function Documentation</h2>
145<a name="z274_0" doxytag="XMLEntityHandler::endInputSource"></a><p>
146<table width="100%" cellpadding="2" cellspacing="0" border="0">
147  <tr>
148    <td class="md">
149      <table cellpadding="0" cellspacing="0" border="0">
150        <tr>
151          <td class="md" nowrap valign="top"> virtual void XMLEntityHandler::endInputSource </td>
152          <td class="md" valign="top">(&nbsp;</td>
153          <td class="md" nowrap valign="top">const <a class="el" href="classInputSource.html">InputSource</a> &amp;&nbsp;</td>
154          <td class="mdname1" valign="top" nowrap>&nbsp; <em>inputSource</em>          </td>
155          <td class="md" valign="top">)&nbsp;</td>
156          <td class="md" nowrap><code> [pure virtual]</code></td>
157        </tr>
158
159      </table>
160    </td>
161  </tr>
162</table>
163<table cellspacing=5 cellpadding=0 border=0>
164  <tr>
165    <td>
166      &nbsp;
167    </td>
168    <td>
169
170<p>
171This method get called after the scanner has finished reading from the given input source while processing external entity references.
172<p>
173<dl compact><dt><b>
174Parameters: </b><dd>
175<table border=0 cellspacing=2 cellpadding=0>
176<tr><td valign=top><em>inputSource</em>&nbsp;</td><td>
177The input source for the entity </td></tr>
178</table>
179</dl>
180<p>
181Implemented in <a class="el" href="classSAXParser.html#z471_0">SAXParser</a>.    </td>
182  </tr>
183</table>
184<a name="z274_1" doxytag="XMLEntityHandler::expandSystemId"></a><p>
185<table width="100%" cellpadding="2" cellspacing="0" border="0">
186  <tr>
187    <td class="md">
188      <table cellpadding="0" cellspacing="0" border="0">
189        <tr>
190          <td class="md" nowrap valign="top"> virtual bool XMLEntityHandler::expandSystemId </td>
191          <td class="md" valign="top">(&nbsp;</td>
192          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
193          <td class="mdname" nowrap>&nbsp; <em>systemId</em>, </td>
194        </tr>
195        <tr>
196          <td></td>
197          <td></td>
198          <td class="md" nowrap>XMLBuffer &amp;&nbsp;</td>
199          <td class="mdname" nowrap>&nbsp; <em>toFill</em></td>
200        </tr>
201        <tr>
202          <td></td>
203          <td class="md">)&nbsp;</td>
204          <td class="md" colspan="2"><code> [pure virtual]</code></td>
205        </tr>
206
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing=5 cellpadding=0 border=0>
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219This method allows the passes the scanned systemId to the entity handler, thereby giving it a chance to provide any customized handling like resolving relative path names.
220<p>
221The scanner first calls this method before calling <code>resolveEntity</code>.<dl compact><dt><b>
222Parameters: </b><dd>
223<table border=0 cellspacing=2 cellpadding=0>
224<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
225The system id extracted by the scanner from the input source. </td></tr>
226<tr><td valign=top><em>toFill</em>&nbsp;</td><td>
227The buffer in which the fully expanded system id needs to be stored. </td></tr>
228</table>
229</dl>
230<p>
231Implemented in <a class="el" href="classSAXParser.html#z471_1">SAXParser</a>.    </td>
232  </tr>
233</table>
234<a name="z274_2" doxytag="XMLEntityHandler::resetEntities"></a><p>
235<table width="100%" cellpadding="2" cellspacing="0" border="0">
236  <tr>
237    <td class="md">
238      <table cellpadding="0" cellspacing="0" border="0">
239        <tr>
240          <td class="md" nowrap valign="top"> virtual void XMLEntityHandler::resetEntities </td>
241          <td class="md" valign="top">(&nbsp;</td>
242          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
243          <td class="md" valign="top">)&nbsp;</td>
244          <td class="md" nowrap><code> [pure virtual]</code></td>
245        </tr>
246
247      </table>
248    </td>
249  </tr>
250</table>
251<table cellspacing=5 cellpadding=0 border=0>
252  <tr>
253    <td>
254      &nbsp;
255    </td>
256    <td>
257
258<p>
259This method allows the entity handler to reset itself, so that it can be used again.
260<p>
261It is called prior to a new document parse operation.
262<p>
263Implemented in <a class="el" href="classSAXParser.html#z471_2">SAXParser</a>.    </td>
264  </tr>
265</table>
266<a name="z274_4" doxytag="XMLEntityHandler::resolveEntity"></a><p>
267<table width="100%" cellpadding="2" cellspacing="0" border="0">
268  <tr>
269    <td class="md">
270      <table cellpadding="0" cellspacing="0" border="0">
271        <tr>
272          <td class="md" nowrap valign="top"> virtual <a class="el" href="classInputSource.html">InputSource</a>* XMLEntityHandler::resolveEntity </td>
273          <td class="md" valign="top">(&nbsp;</td>
274          <td class="md" nowrap valign="top"><a class="el" href="classXMLResourceIdentifier.html">XMLResourceIdentifier</a> *&nbsp;</td>
275          <td class="mdname1" valign="top" nowrap>&nbsp; <em>resourceIdentifier</em>          </td>
276          <td class="md" valign="top">)&nbsp;</td>
277          <td class="md" nowrap><code> [pure virtual]</code></td>
278        </tr>
279
280      </table>
281    </td>
282  </tr>
283</table>
284<table cellspacing=5 cellpadding=0 border=0>
285  <tr>
286    <td>
287      &nbsp;
288    </td>
289    <td>
290
291<p>
292This method allows the entity handler to provide customized application specific entity resolution.
293<p>
294<em>Only one resolveEntity method will be used. If both setEntityResolver and  setXMLEntityResolver are called, then the last one is used.</em><dl compact><dt><b>
295Parameters: </b><dd>
296<table border=0 cellspacing=2 cellpadding=0>
297<tr><td valign=top><em>resourceIdentifier</em>&nbsp;</td><td>
298An object containing the type of resource to be resolved and the associated data members corresponding to this type. </td></tr>
299</table>
300</dl><dl compact><dt><b>
301Returns: </b><dd>
302The value returned by the resolveEntity method or NULL otherwise to indicate no processing was done. The returned <a class="el" href="classInputSource.html">InputSource</a> is owned by the parser which is responsible to clean up the memory. </dl>
303<p>
304Implemented in <a class="el" href="classSAXParser.html#z471_4">SAXParser</a>.    </td>
305  </tr>
306</table>
307<a name="z274_3" doxytag="XMLEntityHandler::resolveEntity"></a><p>
308<table width="100%" cellpadding="2" cellspacing="0" border="0">
309  <tr>
310    <td class="md">
311      <table cellpadding="0" cellspacing="0" border="0">
312        <tr>
313          <td class="md" nowrap valign="top"> virtual <a class="el" href="classInputSource.html">InputSource</a>* XMLEntityHandler::resolveEntity </td>
314          <td class="md" valign="top">(&nbsp;</td>
315          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
316          <td class="mdname" nowrap>&nbsp; <em>publicId</em>, </td>
317        </tr>
318        <tr>
319          <td></td>
320          <td></td>
321          <td class="md" nowrap>const XMLCh *const&nbsp;</td>
322          <td class="mdname" nowrap>&nbsp; <em>systemId</em>, </td>
323        </tr>
324        <tr>
325          <td></td>
326          <td></td>
327          <td class="md" nowrap>const XMLCh *const&nbsp;</td>
328          <td class="mdname" nowrap>&nbsp; <em>baseURI</em> = 0</td>
329        </tr>
330        <tr>
331          <td></td>
332          <td class="md">)&nbsp;</td>
333          <td class="md" colspan="2"><code> [pure virtual]</code></td>
334        </tr>
335
336      </table>
337    </td>
338  </tr>
339</table>
340<table cellspacing=5 cellpadding=0 border=0>
341  <tr>
342    <td>
343      &nbsp;
344    </td>
345    <td>
346
347<p>
348This method allows the entity handler to provide customized application specific entity resolution.
349<p>
350This method is defined by SAX 1.0 API.
351<p>
352<em>Only one resolveEntity method will be used. If both setEntityResolver and  setXMLEntityResolver are called, then the last one is used.</em><dl compact><dt><b>
353Parameters: </b><dd>
354<table border=0 cellspacing=2 cellpadding=0>
355<tr><td valign=top><em>publicId</em>&nbsp;</td><td>
356A const pointer to a Unicode string representing the public id of the entity just parsed. </td></tr>
357<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
358A const pointer to a Unicode string representing the system id of the entity just parsed. </td></tr>
359<tr><td valign=top><em>baseURI</em>&nbsp;</td><td>
360A const pointer to a Unicode string representing the base URI of the entity just parsed, or <code>null</code> if there is no base URI. </td></tr>
361</table>
362</dl><dl compact><dt><b>
363Returns: </b><dd>
364The value returned by the SAX resolveEntity method or NULL otherwise to indicate no processing was done. The returned <a class="el" href="classInputSource.html">InputSource</a> is owned by the parser which is responsible to clean up the memory. </dl>
365<p>
366Implemented in <a class="el" href="classSAXParser.html#z471_3">SAXParser</a>.    </td>
367  </tr>
368</table>
369<a name="z274_5" doxytag="XMLEntityHandler::startInputSource"></a><p>
370<table width="100%" cellpadding="2" cellspacing="0" border="0">
371  <tr>
372    <td class="md">
373      <table cellpadding="0" cellspacing="0" border="0">
374        <tr>
375          <td class="md" nowrap valign="top"> virtual void XMLEntityHandler::startInputSource </td>
376          <td class="md" valign="top">(&nbsp;</td>
377          <td class="md" nowrap valign="top">const <a class="el" href="classInputSource.html">InputSource</a> &amp;&nbsp;</td>
378          <td class="mdname1" valign="top" nowrap>&nbsp; <em>inputSource</em>          </td>
379          <td class="md" valign="top">)&nbsp;</td>
380          <td class="md" nowrap><code> [pure virtual]</code></td>
381        </tr>
382
383      </table>
384    </td>
385  </tr>
386</table>
387<table cellspacing=5 cellpadding=0 border=0>
388  <tr>
389    <td>
390      &nbsp;
391    </td>
392    <td>
393
394<p>
395This method will be called before the scanner starts reading from an input source while processing external entity references.
396<p>
397<dl compact><dt><b>
398Parameters: </b><dd>
399<table border=0 cellspacing=2 cellpadding=0>
400<tr><td valign=top><em>inputSource</em>&nbsp;</td><td>
401The external input source. </td></tr>
402</table>
403</dl>
404<p>
405Implemented in <a class="el" href="classSAXParser.html#z471_5">SAXParser</a>.    </td>
406  </tr>
407</table>
408<hr>The documentation for this class was generated from the following file:<ul>
409<li><a class="el" href="XMLEntityHandler_8hpp-source.html">XMLEntityHandler.hpp</a></ul>
410    </FONT></TD></TR></TABLE><BR>
411</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>
412              Copyright &copy; 1994-2004 The Apache Software Foundation.
413              All Rights Reserved.
414            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.