762 lines
38 KiB
HTML
762 lines
38 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: xercesc::InputSource 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.5.1 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main 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 List</span></a></li>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul></div>
|
|
<div class="nav">
|
|
<a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1InputSource.html">InputSource</a></div>
|
|
<h1>xercesc::InputSource Class Reference</h1><!-- doxytag: class="xercesc::InputSource" --><!-- doxytag: inherits="xercesc::XMemory" -->A single input source for an XML entity.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="InputSource_8hpp-source.html">InputSource.hpp</a>></code>
|
|
<p>
|
|
Inheritance diagram for xercesc::InputSource:<p><center><img src="classxercesc_1_1InputSource__inherit__graph.png" border="0" usemap="#xercesc_1_1InputSource__inherit__map" alt="Inheritance graph"></center>
|
|
<map name="xercesc_1_1InputSource__inherit__map">
|
|
<area href="classxercesc_1_1LocalFileInputSource.html" shape="rect" coords="5,156,227,180" alt="">
|
|
<area href="classxercesc_1_1MemBufInputSource.html" shape="rect" coords="251,156,469,180" alt="">
|
|
<area href="classxercesc_1_1StdInInputSource.html" shape="rect" coords="493,156,691,180" alt="">
|
|
<area href="classxercesc_1_1URLInputSource.html" shape="rect" coords="715,156,904,180" alt="">
|
|
<area href="classxercesc_1_1XMemory.html" shape="rect" coords="403,7,549,31" alt="">
|
|
</map>
|
|
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1InputSource-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">Virtual input source interface</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual BinInputStream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#58559673267865caf4090fcb881e9f2f">makeStream</a> () const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes the byte stream for this input source. <a href="#58559673267865caf4090fcb881e9f2f"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Getter methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#d929cb0a47dfb628eb1cca8cb56f90bb">getEncoding</a> () const</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">An input source can be set to force the parser to assume a particular encoding for the data that input source reprsents, via the <a class="el" href="classxercesc_1_1InputSource.html#38edffa85c69a79705506dc674f370ca">setEncoding()</a> method. <a href="#d929cb0a47dfb628eb1cca8cb56f90bb"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#23f9ca809e2b198b89e05445abdb36a4">getPublicId</a> () const</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the public identifier for this input source. <a href="#23f9ca809e2b198b89e05445abdb36a4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#a3a868b2a61ab8cf886c586d18a6bf3c">getSystemId</a> () const</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the system identifier for this input source. <a href="#a3a868b2a61ab8cf886c586d18a6bf3c"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#c2d933a3143a803d9473e9e7011a2ba7">getIssueFatalErrorIfNotFound</a> () const</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the flag that indicates if the parser should issue fatal error if this input source is not found. <a href="#c2d933a3143a803d9473e9e7011a2ba7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#f068f88f2c52969f131279a401c256fe">getMemoryManager</a> () const</td></tr>
|
|
|
|
<tr><td colspan="2"><div class="groupHeader">Setter methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#38edffa85c69a79705506dc674f370ca">setEncoding</a> (const XMLCh *const encodingStr)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the encoding which will be required for use with the XML text read via a stream opened by this input source. <a href="#38edffa85c69a79705506dc674f370ca"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec">setPublicId</a> (const XMLCh *const publicId)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the public identifier for this input source. <a href="#d88b92735d82dcadf39496ca83357aec"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#3542f513fd873dd217ce1972b041182b">setSystemId</a> (const XMLCh *const systemId)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the system identifier for this input source. <a href="#3542f513fd873dd217ce1972b041182b"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1InputSource.html#30493e827beb6798632d40f81be064c7">setIssueFatalErrorIfNotFound</a> (const bool flag)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates if the parser should issue fatal error if this input source is not found. <a href="#30493e827beb6798632d40f81be064c7"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
A single input source for an XML entity.
|
|
<p>
|
|
This class encapsulates information about an input source in a single object, which may include a public identifier or a system identifier<p>
|
|
There are two places that the application will deliver this input source to the parser: as the argument to the Parser::parse method, or as the return value of the EntityResolver::resolveEntity method.<p>
|
|
<a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> is never used directly, but is the base class for a number of derived classes for particular types of input sources. Derivatives are provided (in the framework/ directory) for URL input sources, memory buffer input sources, and so on.<p>
|
|
When it is time to parse the input described by an input source, it will be asked to create a binary stream for that source. That stream will be used to input the data of the source. The derived class provides the implementation of the <a class="el" href="classxercesc_1_1InputSource.html#58559673267865caf4090fcb881e9f2f">makeStream()</a> method, and provides a type of stream of the correct type for the input source it represents.<p>
|
|
An <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> object belongs to the application: the parser never modifies them in any way. They are always passed by const reference so the parser will make a copy of any input sources that it must keep around beyond the call.<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd>Parser::parse <p>
|
|
EntityResolver::resolveEntity </dd></dl>
|
|
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="4b9113b51e0d93bc9ec310061aa6f834"></a><!-- doxytag: member="xercesc::InputSource::~InputSource" ref="4b9113b51e0d93bc9ec310061aa6f834" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::InputSource::~InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a8a03426e60c7fea417ca87fe92cdbfe"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="a8a03426e60c7fea417ca87fe92cdbfe" args="(MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Default constructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4a73a8e57de0eb17e5f5c53cb838dce6"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="4a73a8e57de0eb17e5f5c53cb838dce6" args="(const XMLCh *const systemId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor with a system identifier as XMLCh type.
|
|
<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>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d7b79c573ccaa32680e6d7cbc0cc644c"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="d7b79c573ccaa32680e6d7cbc0cc644c" args="(const XMLCh *const systemId, const XMLCh *const publicId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>publicId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor with a system and public identifiers.
|
|
<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>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>publicId</em> </td><td>The public identifier as in the entity definition. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d16637d2929e9e193061186c994f7308"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="d16637d2929e9e193061186c994f7308" args="(const char *const systemId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor witha system identifier as string.
|
|
<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>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="619e49d0a44dffdba3e30566754ef99e"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="619e49d0a44dffdba3e30566754ef99e" args="(const char *const systemId, const char *const publicId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>publicId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor witha system and public identifiers.
|
|
<p>
|
|
Both as string <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>publicId</em> </td><td>The public identifier as in the entity definition. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4b9113b51e0d93bc9ec310061aa6f834"></a><!-- doxytag: member="xercesc::InputSource::~InputSource" ref="4b9113b51e0d93bc9ec310061aa6f834" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::InputSource::~InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a8a03426e60c7fea417ca87fe92cdbfe"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="a8a03426e60c7fea417ca87fe92cdbfe" args="(MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Default constructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4a73a8e57de0eb17e5f5c53cb838dce6"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="4a73a8e57de0eb17e5f5c53cb838dce6" args="(const XMLCh *const systemId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor with a system identifier as XMLCh type.
|
|
<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>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d7b79c573ccaa32680e6d7cbc0cc644c"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="d7b79c573ccaa32680e6d7cbc0cc644c" args="(const XMLCh *const systemId, const XMLCh *const publicId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>publicId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor with a system and public identifiers.
|
|
<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>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>publicId</em> </td><td>The public identifier as in the entity definition. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d16637d2929e9e193061186c994f7308"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="d16637d2929e9e193061186c994f7308" args="(const char *const systemId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor witha system identifier as string.
|
|
<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>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="619e49d0a44dffdba3e30566754ef99e"></a><!-- doxytag: member="xercesc::InputSource::InputSource" ref="619e49d0a44dffdba3e30566754ef99e" args="(const char *const systemId, const char *const publicId, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::InputSource::InputSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>publicId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor witha system and public identifiers.
|
|
<p>
|
|
Both as string <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>systemId</em> </td><td>The system identifier (URI). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>publicId</em> </td><td>The public identifier as in the entity definition. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="58559673267865caf4090fcb881e9f2f"></a><!-- doxytag: member="xercesc::InputSource::makeStream" ref="58559673267865caf4090fcb881e9f2f" args="() const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual BinInputStream* xercesc::InputSource::makeStream </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Makes the byte stream for this input source.
|
|
<p>
|
|
The derived class must create and return a binary input stream of an appropriate type for its kind of data source. The returned stream must be dynamically allocated and becomes the parser's property. <p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd>BinInputStream </dd></dl>
|
|
|
|
<p>
|
|
Implemented in <a class="el" href="classxercesc_1_1LocalFileInputSource.html#b080ba29fdbc0825da80cdce64f38007">xercesc::LocalFileInputSource</a>, <a class="el" href="classxercesc_1_1MemBufInputSource.html#12e9b809f29882afb3d472a9e7d2fd65">xercesc::MemBufInputSource</a>, <a class="el" href="classxercesc_1_1StdInInputSource.html#e6d4482b9b26bb3a0c1400777554717c">xercesc::StdInInputSource</a>, and <a class="el" href="classxercesc_1_1URLInputSource.html#3ad592d7ac5a359a59f9b2c6139bad49">xercesc::URLInputSource</a>.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d929cb0a47dfb628eb1cca8cb56f90bb"></a><!-- doxytag: member="xercesc::InputSource::getEncoding" ref="d929cb0a47dfb628eb1cca8cb56f90bb" args="() const" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh * xercesc::InputSource::getEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
An input source can be set to force the parser to assume a particular encoding for the data that input source reprsents, via the <a class="el" href="classxercesc_1_1InputSource.html#38edffa85c69a79705506dc674f370ca">setEncoding()</a> method.
|
|
<p>
|
|
This method returns name of the encoding that is to be forced. If the encoding has never been forced, it returns a null pointer.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The forced encoding, or null if none was supplied. </dd></dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1InputSource.html#38edffa85c69a79705506dc674f370ca">setEncoding</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="23f9ca809e2b198b89e05445abdb36a4"></a><!-- doxytag: member="xercesc::InputSource::getPublicId" ref="23f9ca809e2b198b89e05445abdb36a4" args="() const" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh * xercesc::InputSource::getPublicId </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get the public identifier for this input source.
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The public identifier, or null if none was supplied. </dd></dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec">setPublicId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a3a868b2a61ab8cf886c586d18a6bf3c"></a><!-- doxytag: member="xercesc::InputSource::getSystemId" ref="a3a868b2a61ab8cf886c586d18a6bf3c" args="() const" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh * xercesc::InputSource::getSystemId </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get the system identifier for this input source.
|
|
<p>
|
|
If the system ID is a URL, it will be fully resolved.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The system identifier. </dd></dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1InputSource.html#3542f513fd873dd217ce1972b041182b">setSystemId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c2d933a3143a803d9473e9e7011a2ba7"></a><!-- doxytag: member="xercesc::InputSource::getIssueFatalErrorIfNotFound" ref="c2d933a3143a803d9473e9e7011a2ba7" args="() const" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool xercesc::InputSource::getIssueFatalErrorIfNotFound </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get the flag that indicates if the parser should issue fatal error if this input source is not found.
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the parser should issue fatal error if this input source is not found. False if the parser issue warning message instead. </dd></dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1InputSource.html#30493e827beb6798632d40f81be064c7">setIssueFatalErrorIfNotFound</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f068f88f2c52969f131279a401c256fe"></a><!-- doxytag: member="xercesc::InputSource::getMemoryManager" ref="f068f88f2c52969f131279a401c256fe" args="() const" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> * xercesc::InputSource::getMemoryManager </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="38edffa85c69a79705506dc674f370ca"></a><!-- doxytag: member="xercesc::InputSource::setEncoding" ref="38edffa85c69a79705506dc674f370ca" args="(const XMLCh *const encodingStr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::InputSource::setEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>encodingStr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the encoding which will be required for use with the XML text read via a stream opened by this input source.
|
|
<p>
|
|
This is usually not set, allowing the encoding to be sensed in the usual XML way. However, in some cases, the encoding in the file is known to be incorrect because of intermediate transcoding, for instance encapsulation within a MIME document.<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>encodingStr</em> </td><td>The name of the encoding to force. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d88b92735d82dcadf39496ca83357aec"></a><!-- doxytag: member="xercesc::InputSource::setPublicId" ref="d88b92735d82dcadf39496ca83357aec" args="(const XMLCh *const publicId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::InputSource::setPublicId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>publicId</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the public identifier for this input source.
|
|
<p>
|
|
The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.<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> </td><td>The public identifier as a string. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd>Locator::getPublicId <p>
|
|
SAXParseException::getPublicId <p>
|
|
<a class="el" href="classxercesc_1_1InputSource.html#23f9ca809e2b198b89e05445abdb36a4">getPublicId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3542f513fd873dd217ce1972b041182b"></a><!-- doxytag: member="xercesc::InputSource::setSystemId" ref="3542f513fd873dd217ce1972b041182b" args="(const XMLCh *const systemId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::InputSource::setSystemId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the system identifier for this input source.
|
|
<p>
|
|
Set the system identifier for this input source.<p>
|
|
The system id is always required. The public id may be used to map to another system id, but the system id must always be present as a fall back.<p>
|
|
If the system ID is a URL, it must be fully resolved.<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>systemId</em> </td><td>The system identifier as a string. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1InputSource.html#a3a868b2a61ab8cf886c586d18a6bf3c">getSystemId</a> <p>
|
|
Locator::getSystemId <p>
|
|
SAXParseException::getSystemId </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="30493e827beb6798632d40f81be064c7"></a><!-- doxytag: member="xercesc::InputSource::setIssueFatalErrorIfNotFound" ref="30493e827beb6798632d40f81be064c7" args="(const bool flag)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void xercesc::InputSource::setIssueFatalErrorIfNotFound </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>flag</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Indicates if the parser should issue fatal error if this input source is not found.
|
|
<p>
|
|
If set to false, the parser issue warning message instead.<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>flag</em> </td><td>True if the parser should issue fatal error if this input source is not found. If set to false, the parser issue warning message instead. (Default: true)</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1InputSource.html#c2d933a3143a803d9473e9e7011a2ba7">getIssueFatalErrorIfNotFound</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="InputSource_8hpp-source.html">InputSource.hpp</a></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 19:14:05 2007 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.5.1 </small></address>
|
|
</body>
|
|
</html>
|