XQuilla/docs/dom3-api/classxercesc_1_1DOMEntityResolver.html
2020-02-17 22:05:20 +01:00

180 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM Level 3 API: xercesc::DOMEntityResolver Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a></div>
<h1>xercesc::DOMEntityResolver Class Reference</h1><!-- doxytag: class="xercesc::DOMEntityResolver" --><a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a> provides a way for applications to redirect references to external entities.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="DOMEntityResolver_8hpp-source.html">DOMEntityResolver.hpp</a>&gt;</code>
<p>
<a href="classxercesc_1_1DOMEntityResolver-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntityResolver.html#2b5add432fa4d574c6ee17f572a96a9c">~DOMEntityResolver</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#2b5add432fa4d574c6ee17f572a96a9c"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntityResolver.html#80b99ce22470c90288763cf818e5b31c">resolveEntity</a> (const XMLCh *const publicId, const XMLCh *const systemId, const XMLCh *const baseURI)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow the application to resolve external entities. <a href="#80b99ce22470c90288763cf818e5b31c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntityResolver.html#fcad42522b46848083c7055b84760b48">DOMEntityResolver</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a> provides a way for applications to redirect references to external entities.
<p>
Applications 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="classxercesc_1_1DOMBuilder.html">DOMBuilder</a>.<p>
The <a class="el" href="classxercesc_1_1DOMBuilder.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.<p>
Many 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.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#1d2c6058e5d3c02c6c66b0f8c39d9b7d">DOMBuilder::setEntityResolver</a> <p>
<a class="el" href="classxercesc_1_1DOMInputSource.html#a9a2f11ce8631967b00c450b2265e08e">DOMInputSource::DOMInputSource</a> </dd></dl>
<dl compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="fcad42522b46848083c7055b84760b48"></a><!-- doxytag: member="xercesc::DOMEntityResolver::DOMEntityResolver" ref="fcad42522b46848083c7055b84760b48" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">xercesc::DOMEntityResolver::DOMEntityResolver </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="2b5add432fa4d574c6ee17f572a96a9c"></a><!-- doxytag: member="xercesc::DOMEntityResolver::~DOMEntityResolver" ref="2b5add432fa4d574c6ee17f572a96a9c" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual xercesc::DOMEntityResolver::~DOMEntityResolver </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="80b99ce22470c90288763cf818e5b31c"></a><!-- doxytag: member="xercesc::DOMEntityResolver::resolveEntity" ref="80b99ce22470c90288763cf818e5b31c" args="(const XMLCh *const publicId, const XMLCh *const systemId, const XMLCh *const baseURI)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a>* xercesc::DOMEntityResolver::resolveEntity </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const XMLCh *const &nbsp;</td>
<td class="mdname" nowrap> <em>publicId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh *const &nbsp;</td>
<td class="mdname" nowrap> <em>systemId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh *const &nbsp;</td>
<td class="mdname" nowrap> <em>baseURI</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Allow the application to resolve external entities.
<p>
The <a class="el" href="classxercesc_1_1DOMBuilder.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="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> resolve the entity itself, that it use an alternative URI, or that it use an entirely different input source.<p>
Application 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).<p>
If the system identifier is a URL, the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> parser must resolve it fully before reporting it to the application.<p>
The returned <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> is owned by the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> which is responsible to clean up the memory.<p>
<b>"Experimental - subject to change"</b><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>publicId</em>&nbsp;</td><td>The public identifier of the external entity being referenced, or null if none was supplied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>systemId</em>&nbsp;</td><td>The system identifier of the external entity being referenced. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>baseURI</em>&nbsp;</td><td>The absolute base URI of the resource being parsed, or <code>null</code> if there is no base URI. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classxercesc_1_1DOMInputSource.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="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> is owned by the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> which is responsible to clean up the memory. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMInputSource.html#a9a2f11ce8631967b00c450b2265e08e">DOMInputSource::DOMInputSource</a> </dd></dl>
<dl compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMEntityResolver_8hpp-source.html">DOMEntityResolver.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 00:19:02 2006 for XQilla DOM Level 3 API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>