425 lines
19 KiB
HTML
425 lines
19 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&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.3.9.1 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
|
<h1>xercesc::XMLResourceIdentifier Class Reference</h1><code>#include <<a class="el" href="XMLResourceIdentifier_8hpp-source.html">XMLResourceIdentifier.hpp</a>></code>
|
|
<p>
|
|
<a href="classxercesc_1_1XMLResourceIdentifier-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 Types</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0">ResourceIdentifierType</a> { <br>
|
|
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0w0">SchemaGrammar</a> = 0,
|
|
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0w1">SchemaImport</a>,
|
|
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0w2">SchemaInclude</a>,
|
|
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0w3">SchemaRedefine</a>,
|
|
<br>
|
|
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0w4">ExternalEntity</a>,
|
|
<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0w5">UnKnown</a> = 255
|
|
<br>
|
|
}</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z69_0">XMLResourceIdentifier</a> (const <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0">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"> </td><td class="mdescRight">Constructor. <a href="#z69_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z69_1">~XMLResourceIdentifier</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z69_1"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Public Methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0">ResourceIdentifierType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_0">getResourceIdentifierType</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_1">getPublicId</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_2">getSystemId</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_3">getSchemaLocation</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_4">getBaseURI</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_5">getNameSpace</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const Locator * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_6">getLocator</a> () const </td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
This class is used along with <a class="el" href="classxercesc_1_1XMLEntityResolver.html">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#z71_0">getResourceIdentifierType()</a> method the user can determine which data members are available for inspection:<p>
|
|
<table border="1" cellspacing="3" cellpadding="3">
|
|
<tr>
|
|
<td>ResourceIdentifierType </td><td>Available Data Members </td></tr>
|
|
<tr>
|
|
<td>SchemaGrammar </td><td>schemaLocation, nameSpace & baseURI (current document) </td></tr>
|
|
<tr>
|
|
<td>SchemaImport </td><td>schemaLocation, nameSpace & baseURI (current document) </td></tr>
|
|
<tr>
|
|
<td>SchemaInclude </td><td>schemaLocation & baseURI (current document) </td></tr>
|
|
<tr>
|
|
<td>SchemaRedefine </td><td>schemaLocation & baseURI (current document) </td></tr>
|
|
<tr>
|
|
<td>ExternalEntity </td><td>systemId, publicId & baseURI (some items may be NULL) </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>
|
|
<code> #include <xercesc/util/XMLEntityResolver.hpp><br>
|
|
#include <xercesc/sax/InputSource.hpp><br>
|
|
<br>
|
|
class MyResolver : public <a class="el" href="classxercesc_1_1XMLEntityResolver.html">XMLEntityResolver</a> {<br>
|
|
public:<br>
|
|
<a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> resolveEntity (XMLResourceIdentifier* xmlri);<br>
|
|
...<br>
|
|
};<br>
|
|
<br>
|
|
MyResolver::resolveEntity(XMLResourceIdentifier* xmlri) {<br>
|
|
switch(xmlri-><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_0">getResourceIdentifierType()</a>) {<br>
|
|
case XMLResourceIdentifier::SystemId:<br>
|
|
if (XMLString::compareString(xmlri-><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z71_2">getSystemId()</a>, "http://www.myhost.com/today")) {<br>
|
|
MyReader* reader = new MyReader();<br>
|
|
return new InputSource(reader);<br>
|
|
} else {<br>
|
|
return null;<br>
|
|
}<br>
|
|
break;<br>
|
|
default:<br>
|
|
return null;<br>
|
|
}<br>
|
|
}</code><p>
|
|
<dl compact><dt><b>See also:</b></dt><dd>SAXParser#setXMLEntityResolver <p>
|
|
<a class="el" href="classxercesc_1_1InputSource.html#z103_0">InputSource::InputSource</a> </dd></dl>
|
|
|
|
<p>
|
|
<hr><h2>Member Enumeration Documentation</h2>
|
|
<a class="anchor" name="z67_0" doxytag="xercesc::XMLResourceIdentifier::ResourceIdentifierType"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">enum <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0">xercesc::XMLResourceIdentifier::ResourceIdentifierType</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Enumeration values: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" name="z67_0w0" doxytag="SchemaGrammar"></a>SchemaGrammar</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="z67_0w1" doxytag="SchemaImport"></a>SchemaImport</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="z67_0w2" doxytag="SchemaInclude"></a>SchemaInclude</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="z67_0w3" doxytag="SchemaRedefine"></a>SchemaRedefine</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="z67_0w4" doxytag="ExternalEntity"></a>ExternalEntity</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="z67_0w5" doxytag="UnKnown"></a>UnKnown</em> </td><td>
|
|
</td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="z69_0" doxytag="xercesc::XMLResourceIdentifier::XMLResourceIdentifier"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">xercesc::XMLResourceIdentifier::XMLResourceIdentifier </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const <a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0">ResourceIdentifierType</a> </td>
|
|
<td class="mdname" nowrap> <em>resourceIdentitiferType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh *const </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 </td>
|
|
<td class="mdname" nowrap> <em>nameSpace</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>publicId</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>baseURI</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const Locator * </td>
|
|
<td class="mdname" nowrap> <em>locator</em> = <code>0</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Constructor.
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z69_1" doxytag="xercesc::XMLResourceIdentifier::~XMLResourceIdentifier"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">xercesc::XMLResourceIdentifier::~<a class="el" href="classxercesc_1_1XMLResourceIdentifier.html">XMLResourceIdentifier</a> </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="z71_4" doxytag="xercesc::XMLResourceIdentifier::getBaseURI"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">const XMLCh * xercesc::XMLResourceIdentifier::getBaseURI </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z71_6" doxytag="xercesc::XMLResourceIdentifier::getLocator"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">const Locator * xercesc::XMLResourceIdentifier::getLocator </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z71_5" doxytag="xercesc::XMLResourceIdentifier::getNameSpace"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">const XMLCh * xercesc::XMLResourceIdentifier::getNameSpace </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z71_1" doxytag="xercesc::XMLResourceIdentifier::getPublicId"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">const XMLCh * xercesc::XMLResourceIdentifier::getPublicId </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z71_0" doxytag="xercesc::XMLResourceIdentifier::getResourceIdentifierType"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1XMLResourceIdentifier.html#z67_0">XMLResourceIdentifier::ResourceIdentifierType</a> xercesc::XMLResourceIdentifier::getResourceIdentifierType </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z71_3" doxytag="xercesc::XMLResourceIdentifier::getSchemaLocation"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">const XMLCh * xercesc::XMLResourceIdentifier::getSchemaLocation </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z71_2" doxytag="xercesc::XMLResourceIdentifier::getSystemId"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">const XMLCh * xercesc::XMLResourceIdentifier::getSystemId </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<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></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:42 2009 for XQilla Simple API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
|
|
</body>
|
|
</html>
|