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

Revision 358, 20.5 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>DOMEntityResolver 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>DOMEntityResolver  Class Reference</h1>DOMEntityResolver provides a way for applications to redirect references to external entities.
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMEntityResolver-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
48<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
49<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
50<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMEntityResolver.html#z63_0">~DOMEntityResolver</a> ()</td></tr>
51<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z63_0">More...</a><em></em></font><br><br></td></tr>
52<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr>
53<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMInputSource.html">DOMInputSource</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMEntityResolver.html#z64_0">resolveEntity</a> (const XMLCh *const publicId, const XMLCh *const systemId, const XMLCh *const baseURI)=0</td></tr>
54<tr><td>&nbsp;</td><td><font size=-1><em>Allow the application to resolve external entities.</em> <a href="#z64_0">More...</a><em></em></font><br><br></td></tr>
55<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
56<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
57<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMEntityResolver.html#z61_0">DOMEntityResolver</a> ()</td></tr>
58</table>
59<hr><a name="_details"></a><h2>Detailed Description</h2>
60DOMEntityResolver provides a way for applications to redirect references to external entities.
61<p>
62
63<p>
64Applications needing to implement customized handling for external entities must implement this interface and register their implementation by setting the entityResolver attribute of the <a class="el" href="classDOMBuilder.html">DOMBuilder</a>.
65<p>
66
67<p>
68The <a class="el" href="classDOMBuilder.html">DOMBuilder</a> will then allow the application to intercept any external entities (including the external DTD subset and external parameter entities) before including them.
69<p>
70
71<p>
72Many DOM applications will not need to implement this interface, but it will be especially useful for applications that build XML documents from databases or other specialized input sources, or for applications that use URNs.
73<p>
74<dl compact><dt><b>
75See also: </b><dd>
76<a class="el" href="classDOMBuilder.html#z10_7">DOMBuilder::setEntityResolver</a> , <a class="el" href="classDOMInputSource.html#z95_0">DOMInputSource::DOMInputSource</a> </dl><dl compact><dt><b>
77Since: </b><dd>
78DOM Level 3 </dl>
79<p>
80<hr><h2>Constructor &amp; Destructor Documentation</h2>
81<a name="z61_0" doxytag="DOMEntityResolver::DOMEntityResolver"></a><p>
82<table width="100%" cellpadding="2" cellspacing="0" border="0">
83  <tr>
84    <td class="md">
85      <table cellpadding="0" cellspacing="0" border="0">
86        <tr>
87          <td class="md" nowrap valign="top"> DOMEntityResolver::DOMEntityResolver </td>
88          <td class="md" valign="top">(&nbsp;</td>
89          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
90          <td class="md" valign="top">)&nbsp;</td>
91          <td class="md" nowrap><code> [protected]</code></td>
92        </tr>
93
94      </table>
95    </td>
96  </tr>
97</table>
98<table cellspacing=5 cellpadding=0 border=0>
99  <tr>
100    <td>
101      &nbsp;
102    </td>
103    <td>
104
105<p>
106    </td>
107  </tr>
108</table>
109<a name="z63_0" doxytag="DOMEntityResolver::~DOMEntityResolver"></a><p>
110<table width="100%" cellpadding="2" cellspacing="0" border="0">
111  <tr>
112    <td class="md">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top"> virtual DOMEntityResolver::~DOMEntityResolver </td>
116          <td class="md" valign="top">(&nbsp;</td>
117          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
118          <td class="md" valign="top">)&nbsp;</td>
119          <td class="md" nowrap><code> [virtual]</code></td>
120        </tr>
121
122      </table>
123    </td>
124  </tr>
125</table>
126<table cellspacing=5 cellpadding=0 border=0>
127  <tr>
128    <td>
129      &nbsp;
130    </td>
131    <td>
132
133<p>
134Destructor.
135<p>
136    </td>
137  </tr>
138</table>
139<hr><h2>Member Function Documentation</h2>
140<a name="z64_0" doxytag="DOMEntityResolver::resolveEntity"></a><p>
141<table width="100%" cellpadding="2" cellspacing="0" border="0">
142  <tr>
143    <td class="md">
144      <table cellpadding="0" cellspacing="0" border="0">
145        <tr>
146          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMInputSource.html">DOMInputSource</a>* DOMEntityResolver::resolveEntity </td>
147          <td class="md" valign="top">(&nbsp;</td>
148          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
149          <td class="mdname" nowrap>&nbsp; <em>publicId</em>, </td>
150        </tr>
151        <tr>
152          <td></td>
153          <td></td>
154          <td class="md" nowrap>const XMLCh *const&nbsp;</td>
155          <td class="mdname" nowrap>&nbsp; <em>systemId</em>, </td>
156        </tr>
157        <tr>
158          <td></td>
159          <td></td>
160          <td class="md" nowrap>const XMLCh *const&nbsp;</td>
161          <td class="mdname" nowrap>&nbsp; <em>baseURI</em></td>
162        </tr>
163        <tr>
164          <td></td>
165          <td class="md">)&nbsp;</td>
166          <td class="md" colspan="2"><code> [pure virtual]</code></td>
167        </tr>
168
169      </table>
170    </td>
171  </tr>
172</table>
173<table cellspacing=5 cellpadding=0 border=0>
174  <tr>
175    <td>
176      &nbsp;
177    </td>
178    <td>
179
180<p>
181Allow the application to resolve external entities.
182<p>
183
184<p>
185The <a class="el" href="classDOMBuilder.html">DOMBuilder</a> will call this method before opening any external entity except the top-level document entity (including the external DTD subset, external entities referenced within the DTD, and external entities referenced within the document element): the application may request that the <a class="el" href="classDOMBuilder.html">DOMBuilder</a> resolve the entity itself, that it use an alternative URI, or that it use an entirely different input source.
186<p>
187
188<p>
189Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box).
190<p>
191
192<p>
193If the system identifier is a URL, the <a class="el" href="classDOMBuilder.html">DOMBuilder</a> parser must resolve it fully before reporting it to the application.
194<p>
195
196<p>
197 The returned <a class="el" href="classDOMInputSource.html">DOMInputSource</a> is owned by the <a class="el" href="classDOMBuilder.html">DOMBuilder</a> which is responsible to clean up the memory.
198<p>
199
200<p>
201<b>"Experimental - subject to change"</b><dl compact><dt><b>
202Parameters: </b><dd>
203<table border=0 cellspacing=2 cellpadding=0>
204<tr><td valign=top><em>publicId</em>&nbsp;</td><td>
205The public identifier of the external entity being referenced, or null if none was supplied. </td></tr>
206<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
207The system identifier of the external entity being referenced. </td></tr>
208<tr><td valign=top><em>baseURI</em>&nbsp;</td><td>
209The absolute base URI of the resource being parsed, or <code>null</code> if there is no base URI. </td></tr>
210</table>
211</dl><dl compact><dt><b>
212Returns: </b><dd>
213A <a class="el" href="classDOMInputSource.html">DOMInputSource</a> object describing the new input source, or <code>null</code> to request that the parser open a regular URI connection to the system identifier. The returned <a class="el" href="classDOMInputSource.html">DOMInputSource</a> is owned by the <a class="el" href="classDOMBuilder.html">DOMBuilder</a> which is responsible to clean up the memory. </dl><dl compact><dt><b>
214Exceptions: </b><dd>
215<table border=0 cellspacing=2 cellpadding=0>
216<tr><td valign=top><em>DOMSystemException</em>&nbsp;</td><td>
217 Any DOMSystemException exception, possibly wrapping another exception. </td></tr>
218</table>
219</dl><dl compact><dt><b>
220See also: </b><dd>
221<a class="el" href="classDOMInputSource.html#z95_0">DOMInputSource::DOMInputSource</a> </dl><dl compact><dt><b>
222Since: </b><dd>
223DOM Level 3 </dl>    </td>
224  </tr>
225</table>
226<hr>The documentation for this class was generated from the following file:<ul>
227<li><a class="el" href="DOMEntityResolver_8hpp-source.html">DOMEntityResolver.hpp</a></ul>
228    </FONT></TD></TR></TABLE><BR>
229</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>
230              Copyright &copy; 1994-2004 The Apache Software Foundation.
231              All Rights Reserved.
232            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.