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

Revision 358, 38.2 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>DOMInputSource 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>DOMInputSource  Class Reference</h1>This interface represents a single input source for an XML entity.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for DOMInputSource:<p><center><img src="classDOMInputSource__inherit__graph.gif" border="0" usemap="#DOMInputSource__inherit__map" alt="Inheritance graph"></center>
48<map name="DOMInputSource__inherit__map">
49<area href="classWrapper4InputSource.html" shape="rect" coords="7,105,151,87" alt="">
50</map>
51<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDOMInputSource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
52<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
53<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
54<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z97_0">~DOMInputSource</a> ()</td></tr>
55<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z97_0">More...</a><em></em></font><br><br></td></tr>
56<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
57<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_0">getEncoding</a> () const=0</td></tr>
58<tr><td>&nbsp;</td><td><font size=-1><em>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="classDOMInputSource.html#z98_4">setEncoding</a>() method.</em> <a href="#z98_0">More...</a><em></em></font><br><br></td></tr>
59<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_1">getPublicId</a> () const=0</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>Get the public identifier for this input source.</em> <a href="#z98_1">More...</a><em></em></font><br><br></td></tr>
61<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_2">getSystemId</a> () const=0</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Get the system identifier for this input source.</em> <a href="#z98_2">More...</a><em></em></font><br><br></td></tr>
63<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_3">getBaseURI</a> () const=0</td></tr>
64<tr><td>&nbsp;</td><td><font size=-1><em>Get the base URI to be used for resolving relative URIs to absolute URIs.</em> <a href="#z98_3">More...</a><em></em></font><br><br></td></tr>
65<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_4">setEncoding</a> (const XMLCh *const encodingStr)=0</td></tr>
66<tr><td>&nbsp;</td><td><font size=-1><em>Set the encoding which will be required for use with the XML text read via a stream opened by this input source.</em> <a href="#z98_4">More...</a><em></em></font><br><br></td></tr>
67<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_5">setPublicId</a> (const XMLCh *const publicId)=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>Set the public identifier for this input source.</em> <a href="#z98_5">More...</a><em></em></font><br><br></td></tr>
69<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_6">setSystemId</a> (const XMLCh *const systemId)=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Set the system identifier for this input source.</em> <a href="#z98_6">More...</a><em></em></font><br><br></td></tr>
71<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z98_7">setBaseURI</a> (const XMLCh *const baseURI)=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Set the base URI to be used for resolving relative URIs to absolute URIs.</em> <a href="#z98_7">More...</a><em></em></font><br><br></td></tr>
73<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
74<tr><td nowrap align=right valign=top>virtual <a class="el" href="classBinInputStream.html">BinInputStream</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z99_0">makeStream</a> () const=0</td></tr>
75<tr><td>&nbsp;</td><td><font size=-1><em>Makes the byte stream for this input source.</em> <a href="#z99_0">More...</a><em></em></font><br><br></td></tr>
76<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z99_1">setIssueFatalErrorIfNotFound</a> (const bool flag)=0</td></tr>
77<tr><td>&nbsp;</td><td><font size=-1><em>Indicates if the parser should issue fatal error if this input source is not found.</em> <a href="#z99_1">More...</a><em></em></font><br><br></td></tr>
78<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z99_2">getIssueFatalErrorIfNotFound</a> () const=0</td></tr>
79<tr><td>&nbsp;</td><td><font size=-1><em>Get the flag that indicates if the parser should issue fatal error if this input source is not found.</em> <a href="#z99_2">More...</a><em></em></font><br><br></td></tr>
80<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z99_3">release</a> ()=0</td></tr>
81<tr><td>&nbsp;</td><td><font size=-1><em>Called to indicate that this DOMInputSource is no longer in use and that the implementation may relinquish any resources associated with it.</em> <a href="#z99_3">More...</a><em></em></font><br><br></td></tr>
82<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
83<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
84<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMInputSource.html#z95_0">DOMInputSource</a> ()</td></tr>
85</table>
86<hr><a name="_details"></a><h2>Detailed Description</h2>
87This interface represents a single input source for an XML entity.
88<p>
89
90<p>
91This interface allows an application to encapsulate information about an input source in a single object, which may include a public identifier, a system identifier, a byte stream (possibly with a specified encoding), and/or a character stream.
92<p>
93
94<p>
95There are two places that the application will deliver this input source to the parser: as the argument to the parse method, or as the return value of the DOMEntityResolver.resolveEntity method.
96<p>
97
98<p>
99The <a class="el" href="classDOMBuilder.html">DOMBuilder</a> will use the DOMInputSource object to determine how to read XML input. If there is a character stream available, the parser will read that stream directly; if not, the parser will use a byte stream, if available; if neither a character stream nor a byte stream is available, the parser will attempt to open a URI connection to the resource identified by the system identifier.
100<p>
101
102<p>
103A DOMInputSource object belongs to the application: the parser shall never modify it in any way (it may modify a copy if necessary).
104<p>
105<dl compact><dt><b>
106See also: </b><dd>
107<a class="el" href="classDOMBuilder.html#z10_12">DOMBuilder::parse</a> , <a class="el" href="classDOMEntityResolver.html#z64_0">DOMEntityResolver::resolveEntity</a> </dl><dl compact><dt><b>
108Since: </b><dd>
109DOM Level 3 </dl>
110<p>
111<hr><h2>Constructor &amp; Destructor Documentation</h2>
112<a name="z95_0" doxytag="DOMInputSource::DOMInputSource"></a><p>
113<table width="100%" cellpadding="2" cellspacing="0" border="0">
114  <tr>
115    <td class="md">
116      <table cellpadding="0" cellspacing="0" border="0">
117        <tr>
118          <td class="md" nowrap valign="top"> DOMInputSource::DOMInputSource </td>
119          <td class="md" valign="top">(&nbsp;</td>
120          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
121          <td class="md" valign="top">)&nbsp;</td>
122          <td class="md" nowrap><code> [protected]</code></td>
123        </tr>
124
125      </table>
126    </td>
127  </tr>
128</table>
129<table cellspacing=5 cellpadding=0 border=0>
130  <tr>
131    <td>
132      &nbsp;
133    </td>
134    <td>
135
136<p>
137    </td>
138  </tr>
139</table>
140<a name="z97_0" doxytag="DOMInputSource::~DOMInputSource"></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 DOMInputSource::~DOMInputSource </td>
147          <td class="md" valign="top">(&nbsp;</td>
148          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
149          <td class="md" valign="top">)&nbsp;</td>
150          <td class="md" nowrap><code> [virtual]</code></td>
151        </tr>
152
153      </table>
154    </td>
155  </tr>
156</table>
157<table cellspacing=5 cellpadding=0 border=0>
158  <tr>
159    <td>
160      &nbsp;
161    </td>
162    <td>
163
164<p>
165Destructor.
166<p>
167    </td>
168  </tr>
169</table>
170<hr><h2>Member Function Documentation</h2>
171<a name="z98_3" doxytag="DOMInputSource::getBaseURI"></a><p>
172<table width="100%" cellpadding="2" cellspacing="0" border="0">
173  <tr>
174    <td class="md">
175      <table cellpadding="0" cellspacing="0" border="0">
176        <tr>
177          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMInputSource::getBaseURI </td>
178          <td class="md" valign="top">(&nbsp;</td>
179          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
180          <td class="md" valign="top">)&nbsp;</td>
181          <td class="md" nowrap> const<code> [pure virtual]</code></td>
182        </tr>
183
184      </table>
185    </td>
186  </tr>
187</table>
188<table cellspacing=5 cellpadding=0 border=0>
189  <tr>
190    <td>
191      &nbsp;
192    </td>
193    <td>
194
195<p>
196Get the base URI to be used for resolving relative URIs to absolute URIs.
197<p>
198If the baseURI is itself a relative URI, the behavior is implementation dependent.
199<p>
200
201<p>
202<b>"Experimental - subject to change"</b>
203<p>
204<dl compact><dt><b>
205Returns: </b><dd>
206The base URI. </dl><dl compact><dt><b>
207See also: </b><dd>
208<a class="el" href="classDOMInputSource.html#z98_7">setBaseURI</a> </dl><dl compact><dt><b>
209Since: </b><dd>
210DOM Level 3 </dl>
211<p>
212Implemented in <a class="el" href="classWrapper4InputSource.html#z241_3">Wrapper4InputSource</a>.    </td>
213  </tr>
214</table>
215<a name="z98_0" doxytag="DOMInputSource::getEncoding"></a><p>
216<table width="100%" cellpadding="2" cellspacing="0" border="0">
217  <tr>
218    <td class="md">
219      <table cellpadding="0" cellspacing="0" border="0">
220        <tr>
221          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMInputSource::getEncoding </td>
222          <td class="md" valign="top">(&nbsp;</td>
223          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
224          <td class="md" valign="top">)&nbsp;</td>
225          <td class="md" nowrap> const<code> [pure virtual]</code></td>
226        </tr>
227
228      </table>
229    </td>
230  </tr>
231</table>
232<table cellspacing=5 cellpadding=0 border=0>
233  <tr>
234    <td>
235      &nbsp;
236    </td>
237    <td>
238
239<p>
240An 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="classDOMInputSource.html#z98_4">setEncoding</a>() method.
241<p>
242This method returns name of the encoding that is to be forced. If the encoding has never been forced, it returns a null pointer.
243<p>
244
245<p>
246<b>"Experimental - subject to change"</b>
247<p>
248<dl compact><dt><b>
249Returns: </b><dd>
250The forced encoding, or null if none was supplied. </dl><dl compact><dt><b>
251See also: </b><dd>
252<a class="el" href="classDOMInputSource.html#z98_4">setEncoding</a> </dl><dl compact><dt><b>
253Since: </b><dd>
254DOM Level 3 </dl>
255<p>
256Implemented in <a class="el" href="classWrapper4InputSource.html#z241_0">Wrapper4InputSource</a>.    </td>
257  </tr>
258</table>
259<a name="z99_2" doxytag="DOMInputSource::getIssueFatalErrorIfNotFound"></a><p>
260<table width="100%" cellpadding="2" cellspacing="0" border="0">
261  <tr>
262    <td class="md">
263      <table cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <td class="md" nowrap valign="top"> virtual bool DOMInputSource::getIssueFatalErrorIfNotFound </td>
266          <td class="md" valign="top">(&nbsp;</td>
267          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
268          <td class="md" valign="top">)&nbsp;</td>
269          <td class="md" nowrap> const<code> [pure virtual]</code></td>
270        </tr>
271
272      </table>
273    </td>
274  </tr>
275</table>
276<table cellspacing=5 cellpadding=0 border=0>
277  <tr>
278    <td>
279      &nbsp;
280    </td>
281    <td>
282
283<p>
284Get the flag that indicates if the parser should issue fatal error if this input source is not found.
285<p>
286
287<p>
288<b>"Experimental - subject to change"</b>
289<p>
290<dl compact><dt><b>
291Returns: </b><dd>
292True if the parser should issue fatal error if this input source is not found. False if the parser issue warning message instead. </dl><dl compact><dt><b>
293See also: </b><dd>
294<a class="el" href="classDOMInputSource.html#z99_1">setIssueFatalErrorIfNotFound</a> </dl>
295<p>
296Implemented in <a class="el" href="classWrapper4InputSource.html#z241_4">Wrapper4InputSource</a>.    </td>
297  </tr>
298</table>
299<a name="z98_1" doxytag="DOMInputSource::getPublicId"></a><p>
300<table width="100%" cellpadding="2" cellspacing="0" border="0">
301  <tr>
302    <td class="md">
303      <table cellpadding="0" cellspacing="0" border="0">
304        <tr>
305          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMInputSource::getPublicId </td>
306          <td class="md" valign="top">(&nbsp;</td>
307          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
308          <td class="md" valign="top">)&nbsp;</td>
309          <td class="md" nowrap> const<code> [pure virtual]</code></td>
310        </tr>
311
312      </table>
313    </td>
314  </tr>
315</table>
316<table cellspacing=5 cellpadding=0 border=0>
317  <tr>
318    <td>
319      &nbsp;
320    </td>
321    <td>
322
323<p>
324Get the public identifier for this input source.
325<p>
326
327<p>
328<b>"Experimental - subject to change"</b>
329<p>
330<dl compact><dt><b>
331Returns: </b><dd>
332The public identifier, or null if none was supplied. </dl><dl compact><dt><b>
333See also: </b><dd>
334<a class="el" href="classDOMInputSource.html#z98_5">setPublicId</a> </dl><dl compact><dt><b>
335Since: </b><dd>
336DOM Level 3 </dl>
337<p>
338Implemented in <a class="el" href="classWrapper4InputSource.html#z241_1">Wrapper4InputSource</a>.    </td>
339  </tr>
340</table>
341<a name="z98_2" doxytag="DOMInputSource::getSystemId"></a><p>
342<table width="100%" cellpadding="2" cellspacing="0" border="0">
343  <tr>
344    <td class="md">
345      <table cellpadding="0" cellspacing="0" border="0">
346        <tr>
347          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMInputSource::getSystemId </td>
348          <td class="md" valign="top">(&nbsp;</td>
349          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
350          <td class="md" valign="top">)&nbsp;</td>
351          <td class="md" nowrap> const<code> [pure virtual]</code></td>
352        </tr>
353
354      </table>
355    </td>
356  </tr>
357</table>
358<table cellspacing=5 cellpadding=0 border=0>
359  <tr>
360    <td>
361      &nbsp;
362    </td>
363    <td>
364
365<p>
366Get the system identifier for this input source.
367<p>
368
369<p>
370<b>"Experimental - subject to change"</b>
371<p>
372
373<p>
374If the system ID is a URL, it will be fully resolved.
375<p>
376<dl compact><dt><b>
377Returns: </b><dd>
378The system identifier. </dl><dl compact><dt><b>
379See also: </b><dd>
380<a class="el" href="classDOMInputSource.html#z98_6">setSystemId</a> </dl><dl compact><dt><b>
381Since: </b><dd>
382DOM Level 3 </dl>
383<p>
384Implemented in <a class="el" href="classWrapper4InputSource.html#z241_2">Wrapper4InputSource</a>.    </td>
385  </tr>
386</table>
387<a name="z99_0" doxytag="DOMInputSource::makeStream"></a><p>
388<table width="100%" cellpadding="2" cellspacing="0" border="0">
389  <tr>
390    <td class="md">
391      <table cellpadding="0" cellspacing="0" border="0">
392        <tr>
393          <td class="md" nowrap valign="top"> virtual <a class="el" href="classBinInputStream.html">BinInputStream</a>* DOMInputSource::makeStream </td>
394          <td class="md" valign="top">(&nbsp;</td>
395          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
396          <td class="md" valign="top">)&nbsp;</td>
397          <td class="md" nowrap> const<code> [pure virtual]</code></td>
398        </tr>
399
400      </table>
401    </td>
402  </tr>
403</table>
404<table cellspacing=5 cellpadding=0 border=0>
405  <tr>
406    <td>
407      &nbsp;
408    </td>
409    <td>
410
411<p>
412Makes the byte stream for this input source.
413<p>
414
415<p>
416The 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.
417<p>
418
419<p>
420<b>"Experimental - subject to change"</b>
421<p>
422<dl compact><dt><b>
423See also: </b><dd>
424<a class="el" href="classBinInputStream.html">BinInputStream</a> </dl>
425<p>
426Implemented in <a class="el" href="classWrapper4InputSource.html#z240_0">Wrapper4InputSource</a>.    </td>
427  </tr>
428</table>
429<a name="z99_3" doxytag="DOMInputSource::release"></a><p>
430<table width="100%" cellpadding="2" cellspacing="0" border="0">
431  <tr>
432    <td class="md">
433      <table cellpadding="0" cellspacing="0" border="0">
434        <tr>
435          <td class="md" nowrap valign="top"> virtual void DOMInputSource::release </td>
436          <td class="md" valign="top">(&nbsp;</td>
437          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
438          <td class="md" valign="top">)&nbsp;</td>
439          <td class="md" nowrap><code> [pure virtual]</code></td>
440        </tr>
441
442      </table>
443    </td>
444  </tr>
445</table>
446<table cellspacing=5 cellpadding=0 border=0>
447  <tr>
448    <td>
449      &nbsp;
450    </td>
451    <td>
452
453<p>
454Called to indicate that this DOMInputSource is no longer in use and that the implementation may relinquish any resources associated with it.
455<p>
456Access to a released object will lead to unexpected result.
457<p>
458Implemented in <a class="el" href="classWrapper4InputSource.html#z242_5">Wrapper4InputSource</a>.    </td>
459  </tr>
460</table>
461<a name="z98_7" doxytag="DOMInputSource::setBaseURI"></a><p>
462<table width="100%" cellpadding="2" cellspacing="0" border="0">
463  <tr>
464    <td class="md">
465      <table cellpadding="0" cellspacing="0" border="0">
466        <tr>
467          <td class="md" nowrap valign="top"> virtual void DOMInputSource::setBaseURI </td>
468          <td class="md" valign="top">(&nbsp;</td>
469          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
470          <td class="mdname1" valign="top" nowrap>&nbsp; <em>baseURI</em>          </td>
471          <td class="md" valign="top">)&nbsp;</td>
472          <td class="md" nowrap><code> [pure virtual]</code></td>
473        </tr>
474
475      </table>
476    </td>
477  </tr>
478</table>
479<table cellspacing=5 cellpadding=0 border=0>
480  <tr>
481    <td>
482      &nbsp;
483    </td>
484    <td>
485
486<p>
487Set the base URI to be used for resolving relative URIs to absolute URIs.
488<p>
489If the baseURI is itself a relative URI, the behavior is implementation dependent.
490<p>
491
492<p>
493<b>"Experimental - subject to change"</b><dl compact><dt><b>
494Parameters: </b><dd>
495<table border=0 cellspacing=2 cellpadding=0>
496<tr><td valign=top><em>baseURI</em>&nbsp;</td><td>
497The base URI. </td></tr>
498</table>
499</dl><dl compact><dt><b>
500See also: </b><dd>
501<a class="el" href="classDOMInputSource.html#z98_3">getBaseURI</a> </dl><dl compact><dt><b>
502Since: </b><dd>
503DOM Level 3 </dl>
504<p>
505Implemented in <a class="el" href="classWrapper4InputSource.html#z242_3">Wrapper4InputSource</a>.    </td>
506  </tr>
507</table>
508<a name="z98_4" doxytag="DOMInputSource::setEncoding"></a><p>
509<table width="100%" cellpadding="2" cellspacing="0" border="0">
510  <tr>
511    <td class="md">
512      <table cellpadding="0" cellspacing="0" border="0">
513        <tr>
514          <td class="md" nowrap valign="top"> virtual void DOMInputSource::setEncoding </td>
515          <td class="md" valign="top">(&nbsp;</td>
516          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
517          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encodingStr</em>          </td>
518          <td class="md" valign="top">)&nbsp;</td>
519          <td class="md" nowrap><code> [pure virtual]</code></td>
520        </tr>
521
522      </table>
523    </td>
524  </tr>
525</table>
526<table cellspacing=5 cellpadding=0 border=0>
527  <tr>
528    <td>
529      &nbsp;
530    </td>
531    <td>
532
533<p>
534Set the encoding which will be required for use with the XML text read via a stream opened by this input source.
535<p>
536
537<p>
538This 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.
539<p>
540
541<p>
542<b>"Experimental - subject to change"</b><dl compact><dt><b>
543Parameters: </b><dd>
544<table border=0 cellspacing=2 cellpadding=0>
545<tr><td valign=top><em>encodingStr</em>&nbsp;</td><td>
546The name of the encoding to force. </td></tr>
547</table>
548</dl><dl compact><dt><b>
549Since: </b><dd>
550DOM Level 3 </dl>
551<p>
552Implemented in <a class="el" href="classWrapper4InputSource.html#z242_0">Wrapper4InputSource</a>.    </td>
553  </tr>
554</table>
555<a name="z99_1" doxytag="DOMInputSource::setIssueFatalErrorIfNotFound"></a><p>
556<table width="100%" cellpadding="2" cellspacing="0" border="0">
557  <tr>
558    <td class="md">
559      <table cellpadding="0" cellspacing="0" border="0">
560        <tr>
561          <td class="md" nowrap valign="top"> virtual void DOMInputSource::setIssueFatalErrorIfNotFound </td>
562          <td class="md" valign="top">(&nbsp;</td>
563          <td class="md" nowrap valign="top">const bool&nbsp;</td>
564          <td class="mdname1" valign="top" nowrap>&nbsp; <em>flag</em>          </td>
565          <td class="md" valign="top">)&nbsp;</td>
566          <td class="md" nowrap><code> [pure virtual]</code></td>
567        </tr>
568
569      </table>
570    </td>
571  </tr>
572</table>
573<table cellspacing=5 cellpadding=0 border=0>
574  <tr>
575    <td>
576      &nbsp;
577    </td>
578    <td>
579
580<p>
581Indicates if the parser should issue fatal error if this input source is not found.
582<p>
583If set to false, the parser issue warning message instead.
584<p>
585
586<p>
587<b>"Experimental - subject to change"</b><dl compact><dt><b>
588Parameters: </b><dd>
589<table border=0 cellspacing=2 cellpadding=0>
590<tr><td valign=top><em>flag</em>&nbsp;</td><td>
591True 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>
592</table>
593</dl><dl compact><dt><b>
594See also: </b><dd>
595<a class="el" href="classDOMInputSource.html#z99_2">getIssueFatalErrorIfNotFound</a> </dl>
596<p>
597Implemented in <a class="el" href="classWrapper4InputSource.html#z242_4">Wrapper4InputSource</a>.    </td>
598  </tr>
599</table>
600<a name="z98_5" doxytag="DOMInputSource::setPublicId"></a><p>
601<table width="100%" cellpadding="2" cellspacing="0" border="0">
602  <tr>
603    <td class="md">
604      <table cellpadding="0" cellspacing="0" border="0">
605        <tr>
606          <td class="md" nowrap valign="top"> virtual void DOMInputSource::setPublicId </td>
607          <td class="md" valign="top">(&nbsp;</td>
608          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
609          <td class="mdname1" valign="top" nowrap>&nbsp; <em>publicId</em>          </td>
610          <td class="md" valign="top">)&nbsp;</td>
611          <td class="md" nowrap><code> [pure virtual]</code></td>
612        </tr>
613
614      </table>
615    </td>
616  </tr>
617</table>
618<table cellspacing=5 cellpadding=0 border=0>
619  <tr>
620    <td>
621      &nbsp;
622    </td>
623    <td>
624
625<p>
626Set the public identifier for this input source.
627<p>
628
629<p>
630The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.
631<p>
632
633<p>
634<b>"Experimental - subject to change"</b><dl compact><dt><b>
635Parameters: </b><dd>
636<table border=0 cellspacing=2 cellpadding=0>
637<tr><td valign=top><em>publicId</em>&nbsp;</td><td>
638The public identifier as a string. </td></tr>
639</table>
640</dl><dl compact><dt><b>
641See also: </b><dd>
642<a class="el" href="classDOMInputSource.html#z98_1">getPublicId</a> </dl><dl compact><dt><b>
643Since: </b><dd>
644DOM Level 3 </dl>
645<p>
646Implemented in <a class="el" href="classWrapper4InputSource.html#z242_1">Wrapper4InputSource</a>.    </td>
647  </tr>
648</table>
649<a name="z98_6" doxytag="DOMInputSource::setSystemId"></a><p>
650<table width="100%" cellpadding="2" cellspacing="0" border="0">
651  <tr>
652    <td class="md">
653      <table cellpadding="0" cellspacing="0" border="0">
654        <tr>
655          <td class="md" nowrap valign="top"> virtual void DOMInputSource::setSystemId </td>
656          <td class="md" valign="top">(&nbsp;</td>
657          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
658          <td class="mdname1" valign="top" nowrap>&nbsp; <em>systemId</em>          </td>
659          <td class="md" valign="top">)&nbsp;</td>
660          <td class="md" nowrap><code> [pure virtual]</code></td>
661        </tr>
662
663      </table>
664    </td>
665  </tr>
666</table>
667<table cellspacing=5 cellpadding=0 border=0>
668  <tr>
669    <td>
670      &nbsp;
671    </td>
672    <td>
673
674<p>
675Set the system identifier for this input source.
676<p>
677
678<p>
679The 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.
680<p>
681
682<p>
683If the system ID is a URL, it must be fully resolved.
684<p>
685
686<p>
687<b>"Experimental - subject to change"</b><dl compact><dt><b>
688Parameters: </b><dd>
689<table border=0 cellspacing=2 cellpadding=0>
690<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
691The system identifier as a string. </td></tr>
692</table>
693</dl><dl compact><dt><b>
694See also: </b><dd>
695<a class="el" href="classDOMInputSource.html#z98_2">getSystemId</a> </dl><dl compact><dt><b>
696Since: </b><dd>
697DOM Level 3 </dl>
698<p>
699Implemented in <a class="el" href="classWrapper4InputSource.html#z242_2">Wrapper4InputSource</a>.    </td>
700  </tr>
701</table>
702<hr>The documentation for this class was generated from the following file:<ul>
703<li><a class="el" href="DOMInputSource_8hpp-source.html">DOMInputSource.hpp</a></ul>
704    </FONT></TD></TR></TABLE><BR>
705</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>
706              Copyright &copy; 1994-2004 The Apache Software Foundation.
707              All Rights Reserved.
708            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.