XQuilla/docs/simple-api/classxercesc_1_1XMLResourceIdentifier.html
2020-02-17 22:19:57 +01:00

355 lines
20 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 Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</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="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html">XMLResourceIdentifier</a>
</div>
</div>
<div class="contents">
<h1>xercesc::XMLResourceIdentifier Class Reference</h1><!-- doxytag: class="xercesc::XMLResourceIdentifier" -->
<p><code>#include &lt;<a class="el" href="XMLResourceIdentifier_8hpp_source.html">XMLResourceIdentifier.hpp</a>&gt;</code></p>
<p><a href="classxercesc_1_1XMLResourceIdentifier-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp029a9d96abbdf756a4ed5be1b2b6c69f"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46">ResourceIdentifierType</a> { <br/>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46ab81b90ef99ff13695b685a348be4fbf6">SchemaGrammar</a> = 0,
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46af0dbcb71fdeb81abbc90e81cebaa8fd0">SchemaImport</a>,
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46a89605893ca32761d4cb0e0657eb67801">SchemaInclude</a>,
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46a102015e242c9845e25b1f21740811928">SchemaRedefine</a>,
<br/>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46a720a881e98438e0bd58c907943cf9df6">ExternalEntity</a>,
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46af55aa0890125acbd8d853d7d4123c24b">UnKnown</a> = 255
<br/>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpfff7c892e0960645e398064e32ab6297"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#afac9a0d75a2c85864c5e45f9d43b721f">XMLResourceIdentifier</a> (const <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46">ResourceIdentifierType</a> resourceIdentitiferType, const XMLCh *const systemId, const XMLCh *const nameSpace=0, const XMLCh *const publicId=0, const XMLCh *const baseURI=0, const Locator *locator=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#afac9a0d75a2c85864c5e45f9d43b721f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#aee614b6ab31ba305f5df3baea5acccb5">~XMLResourceIdentifier</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#aee614b6ab31ba305f5df3baea5acccb5"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public Methods</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp9c5a24f0cbb12d939e4622b93bea904b"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46">ResourceIdentifierType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a27929ee66bba8611ad99b75fdcdfb804">getResourceIdentifierType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a0a37b2fde9716ccfb8bbbe5449990506">getPublicId</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#acca1833a60821ccec33b002ae1da9d6a">getSystemId</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#aafe276f926db473a30e6172d8ac51bea">getSchemaLocation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a962bf159940544172e61f48aa92e0076">getBaseURI</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a4faeb8fe3bae7559dba2bd8e18e3704a">getNameSpace</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Locator *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a620b34bb7cf9b41062a22d35ad334191">getLocator</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class is used along with <a class="el" href="classxercesc_1_1XMLEntityResolver.html" title="Revised interface for resolving entities.">XMLEntityResolver</a> to resolve entities. Instead of passing publicId and systemId on the resolveEntity call, as is done with the SAX entity resolver, an object of type <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html">XMLResourceIdentifier</a> is passed. By calling the <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a27929ee66bba8611ad99b75fdcdfb804">getResourceIdentifierType()</a> method the user can determine which data members are available for inspection:</p>
<table border="1" cellspacing="3" cellpadding="3">
<tr>
<td><p>ResourceIdentifierType </p>
</td><td><p>Available Data Members </p>
</td></tr>
<tr>
<td><p>SchemaGrammar </p>
</td><td><p>schemaLocation, nameSpace &amp; baseURI (current document) </p>
</td></tr>
<tr>
<td><p>SchemaImport </p>
</td><td><p>schemaLocation, nameSpace &amp; baseURI (current document) </p>
</td></tr>
<tr>
<td><p>SchemaInclude </p>
</td><td><p>schemaLocation &amp; baseURI (current document) </p>
</td></tr>
<tr>
<td><p>SchemaRedefine </p>
</td><td><p>schemaLocation &amp; baseURI (current document) </p>
</td></tr>
<tr>
<td><p>ExternalEntity </p>
</td><td><p>systemId, publicId &amp; baseURI (some items may be NULL) </p>
</td></tr>
</table>
<p>The following resolver would provide the application with a special character stream for the entity with the system identifier "http://www.myhost.com/today":</p>
<p><code> #include &lt;<a class="el" href="XMLEntityResolver_8hpp.html">xercesc/util/XMLEntityResolver.hpp</a>&gt;<br/>
#include &lt;<a class="el" href="InputSource_8hpp.html">xercesc/sax/InputSource.hpp</a>&gt;<br/>
<br/>
&nbsp;class MyResolver : public <a class="el" href="classxercesc_1_1XMLEntityResolver.html" title="Revised interface for resolving entities.">XMLEntityResolver</a> {<br/>
&nbsp;&nbsp;public:<br/>
&nbsp;&nbsp;&nbsp;<a class="el" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a> resolveEntity (XMLResourceIdentifier* xmlri);<br/>
&nbsp;&nbsp;&nbsp;...<br/>
&nbsp;&nbsp;};<br/>
<br/>
&nbsp;&nbsp;MyResolver::resolveEntity(XMLResourceIdentifier* xmlri) {<br/>
&nbsp;&nbsp;&nbsp;switch(xmlri-&gt;<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a27929ee66bba8611ad99b75fdcdfb804">getResourceIdentifierType()</a>) {<br/>
&nbsp;&nbsp;&nbsp;&nbsp;case XMLResourceIdentifier::SystemId:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (XMLString::compareString(xmlri-&gt;<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#acca1833a60821ccec33b002ae1da9d6a">getSystemId()</a>, "http://www.myhost.com/today")) {<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;MyReader* reader = new MyReader();<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return new InputSource(reader);<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} else {<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return null;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;default:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return null;<br/>
&nbsp;&nbsp;&nbsp;}<br/>
&nbsp;&nbsp;}</code></p>
<dl class="see"><dt><b>See also:</b></dt><dd>SAXParser::setXMLEntityResolver </dd>
<dd>
<a class="el" href="classxercesc_1_1InputSource.html#aa8a03426e60c7fea417ca87fe92cdbfe" title="Default constructor.">InputSource::InputSource</a> </dd></dl>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::ResourceIdentifierType" ref="a03d02f61f1257c212999d8157ffd2c46" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46">xercesc::XMLResourceIdentifier::ResourceIdentifierType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46ab81b90ef99ff13695b685a348be4fbf6"></a><!-- doxytag: member="SchemaGrammar" ref="a03d02f61f1257c212999d8157ffd2c46ab81b90ef99ff13695b685a348be4fbf6" args="" -->SchemaGrammar</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46af0dbcb71fdeb81abbc90e81cebaa8fd0"></a><!-- doxytag: member="SchemaImport" ref="a03d02f61f1257c212999d8157ffd2c46af0dbcb71fdeb81abbc90e81cebaa8fd0" args="" -->SchemaImport</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46a89605893ca32761d4cb0e0657eb67801"></a><!-- doxytag: member="SchemaInclude" ref="a03d02f61f1257c212999d8157ffd2c46a89605893ca32761d4cb0e0657eb67801" args="" -->SchemaInclude</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46a102015e242c9845e25b1f21740811928"></a><!-- doxytag: member="SchemaRedefine" ref="a03d02f61f1257c212999d8157ffd2c46a102015e242c9845e25b1f21740811928" args="" -->SchemaRedefine</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46a720a881e98438e0bd58c907943cf9df6"></a><!-- doxytag: member="ExternalEntity" ref="a03d02f61f1257c212999d8157ffd2c46a720a881e98438e0bd58c907943cf9df6" args="" -->ExternalEntity</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a03d02f61f1257c212999d8157ffd2c46af55aa0890125acbd8d853d7d4123c24b"></a><!-- doxytag: member="UnKnown" ref="a03d02f61f1257c212999d8157ffd2c46af55aa0890125acbd8d853d7d4123c24b" args="" -->UnKnown</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afac9a0d75a2c85864c5e45f9d43b721f"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::XMLResourceIdentifier" ref="afac9a0d75a2c85864c5e45f9d43b721f" args="(const ResourceIdentifierType resourceIdentitiferType, const XMLCh *const systemId, const XMLCh *const nameSpace=0, const XMLCh *const publicId=0, const XMLCh *const baseURI=0, const Locator *locator=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::XMLResourceIdentifier::XMLResourceIdentifier </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46">ResourceIdentifierType</a>&nbsp;</td>
<td class="paramname"> <em>resourceIdentitiferType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>systemId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>nameSpace</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>publicId</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>baseURI</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="aee614b6ab31ba305f5df3baea5acccb5"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::~XMLResourceIdentifier" ref="aee614b6ab31ba305f5df3baea5acccb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::XMLResourceIdentifier::~XMLResourceIdentifier </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a962bf159940544172e61f48aa92e0076"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getBaseURI" ref="a962bf159940544172e61f48aa92e0076" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh * xercesc::XMLResourceIdentifier::getBaseURI </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a620b34bb7cf9b41062a22d35ad334191"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getLocator" ref="a620b34bb7cf9b41062a22d35ad334191" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Locator * xercesc::XMLResourceIdentifier::getLocator </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4faeb8fe3bae7559dba2bd8e18e3704a"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getNameSpace" ref="a4faeb8fe3bae7559dba2bd8e18e3704a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh * xercesc::XMLResourceIdentifier::getNameSpace </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0a37b2fde9716ccfb8bbbe5449990506"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getPublicId" ref="a0a37b2fde9716ccfb8bbbe5449990506" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh * xercesc::XMLResourceIdentifier::getPublicId </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a27929ee66bba8611ad99b75fdcdfb804"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getResourceIdentifierType" ref="a27929ee66bba8611ad99b75fdcdfb804" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#a03d02f61f1257c212999d8157ffd2c46">XMLResourceIdentifier::ResourceIdentifierType</a> xercesc::XMLResourceIdentifier::getResourceIdentifierType </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aafe276f926db473a30e6172d8ac51bea"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getSchemaLocation" ref="aafe276f926db473a30e6172d8ac51bea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh * xercesc::XMLResourceIdentifier::getSchemaLocation </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acca1833a60821ccec33b002ae1da9d6a"></a><!-- doxytag: member="xercesc::XMLResourceIdentifier::getSystemId" ref="acca1833a60821ccec33b002ae1da9d6a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh * xercesc::XMLResourceIdentifier::getSystemId </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XMLResourceIdentifier_8hpp_source.html">XMLResourceIdentifier.hpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 13 15:00:04 2009 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>