blob: 7a0af3fa15fb4cb9bc899553a9ca34ced0d1364e [file] [log] [blame]
<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>Xerces-C++: SAX2XMLReader 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>
<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>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<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>
<A href="../charter.html" onMouseOut="rolloverOff('side-charter');" onMouseOver="rolloverOn('side-charter');"><IMG alt="Charter" border="0" height="12" hspace="0" name="side-charter" onLoad="rolloverLoad('side-charter','../graphics/charter-label-2.jpg','../graphics/charter-label-3.jpg');" src="../graphics/charter-label-3.jpg" vspace="0" width="120"></A><BR>
<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>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<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>
<A href="http://xerces.apache.org/xerces-c/download.cgi" onMouseOut="rolloverOff('side-ext-20');" onMouseOver="rolloverOn('side-ext-20');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-20" onLoad="rolloverLoad('side-ext-20','../graphics/ext-20-label-2.jpg','../graphics/ext-20-label-3.jpg');" src="../graphics/ext-20-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build Instructions" 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>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<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>
<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>
<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>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<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>
<A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-88');" onMouseOver="rolloverOn('side-ext-88');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-88" onLoad="rolloverLoad('side-ext-88','../graphics/ext-88-label-2.jpg','../graphics/ext-88-label-3.jpg');" src="../graphics/ext-88-label-3.jpg" vspace="0" width="120"></A><BR>
<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>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<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>
<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>
<A href="../mailing-lists.html" onMouseOut="rolloverOff('side-mailing-lists');" onMouseOver="rolloverOn('side-mailing-lists');"><IMG alt="Mailing Lists" border="0" height="12" hspace="0" name="side-mailing-lists" onLoad="rolloverLoad('side-mailing-lists','../graphics/mailing-lists-label-2.jpg','../graphics/mailing-lists-label-3.jpg');" src="../graphics/mailing-lists-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../source-repository.html" onMouseOut="rolloverOff('side-source-repository');" onMouseOver="rolloverOn('side-source-repository');"><IMG alt="Source Repository" border="0" height="12" hspace="0" name="side-source-repository" onLoad="rolloverLoad('side-source-repository','../graphics/source-repository-label-2.jpg','../graphics/source-repository-label-3.jpg');" src="../graphics/source-repository-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../applications.html" onMouseOut="rolloverOff('side-applications');" onMouseOver="rolloverOn('side-applications');"><IMG alt="Applications" border="0" height="12" hspace="0" name="side-applications" onLoad="rolloverLoad('side-applications','../graphics/applications-label-2.jpg','../graphics/applications-label-3.jpg');" src="../graphics/applications-label-3.jpg" vspace="0" width="120"></A><BR>
<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>
<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">
<P>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>SAX2XMLReader Class Reference</h1><!-- doxytag: class="SAX2XMLReader" --><div class="dynheader">
Inheritance diagram for SAX2XMLReader:</div>
<div class="dynsection">
<p><center><img src="classSAX2XMLReader__inherit__graph.png" border="0" usemap="#SAX2XMLReader__inherit__map" alt="Inheritance graph"></center>
<map name="SAX2XMLReader__inherit__map">
<area shape="rect" href="classSAX2XMLFilter.html" title="SAX2XMLFilter" alt="" coords="13,84,128,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classSAX2XMLReader-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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#d6be26566ce8e2f65b95849247d10853">ValSchemes</a> { <a class="el" href="classSAX2XMLReader.html#d6be26566ce8e2f65b95849247d108537b5317560a7f1130511148b7750d6244">Val_Never</a>,
<a class="el" href="classSAX2XMLReader.html#d6be26566ce8e2f65b95849247d1085395ad9c6bc78a2ce7fa2a8db410b1dc39">Val_Always</a>,
<a class="el" href="classSAX2XMLReader.html#d6be26566ce8e2f65b95849247d1085357143e99019f8302ea26965e26ce7cb0">Val_Auto</a>
}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ValScheme enum used in setValidationScheme Val_Never: Do not report validation errors. <a href="classSAX2XMLReader.html#d6be26566ce8e2f65b95849247d10853">More...</a><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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#faad9a21efa3e2626e80a7045c3a39b1">SAX2XMLReader</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor. <a href="#faad9a21efa3e2626e80a7045c3a39b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#65eac731ad3537122d86bf5826fe8047">~SAX2XMLReader</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor. <a href="#65eac731ad3537122d86bf5826fe8047"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Implementation of SAX 2.0 XMLReader interface's.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classContentHandler.html">ContentHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#9fda35bb540194c1a8a5a4a95c0bcdb7">getContentHandler</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the installed content handler. <a href="#9fda35bb540194c1a8a5a4a95c0bcdb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDTDHandler.html">DTDHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#89f6ad6b94dce1d82f86d88084cafeaf">getDTDHandler</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the installed DTD handler. <a href="#89f6ad6b94dce1d82f86d88084cafeaf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classEntityResolver.html">EntityResolver</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#ef939a6a68ded3d000f8ecbd80cc5089">getEntityResolver</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the installed entity resolver. <a href="#ef939a6a68ded3d000f8ecbd80cc5089"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classErrorHandler.html">ErrorHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#96bb93cd1b62dd75068325cbcdfbb581">getErrorHandler</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the installed error handler. <a href="#96bb93cd1b62dd75068325cbcdfbb581"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#6a704107fbb8c3552589236e959238be">getFeature</a> (const XMLCh *const name) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the current state of any feature in a SAX2 XMLReader. <a href="#6a704107fbb8c3552589236e959238be"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#909627968ffa64bb14e673d5e2caf6f7">getProperty</a> (const XMLCh *const name) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the current value of a property in a SAX2 XMLReader. <a href="#909627968ffa64bb14e673d5e2caf6f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#a1885becac34443e9648ccaeeed733f5">setContentHandler</a> (<a class="el" href="classContentHandler.html">ContentHandler</a> *const handler)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow an application to register a document event handler. <a href="#a1885becac34443e9648ccaeeed733f5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#b862874149da5e744a04f1bc6de60ff4">setDTDHandler</a> (<a class="el" href="classDTDHandler.html">DTDHandler</a> *const handler)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow an application to register a DTD event handler. <a href="#b862874149da5e744a04f1bc6de60ff4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#b4621486a9776d480ec10e596a4d66a6">setEntityResolver</a> (<a class="el" href="classEntityResolver.html">EntityResolver</a> *const resolver)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow an application to register a custom entity resolver. <a href="#b4621486a9776d480ec10e596a4d66a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#910e9acbec9c8bbd4ff3fdb92c76cf0e">setErrorHandler</a> (<a class="el" href="classErrorHandler.html">ErrorHandler</a> *const handler)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow an application to register an error event handler. <a href="#910e9acbec9c8bbd4ff3fdb92c76cf0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#a597ea87071e1a0aa1288567e4bfd6d7">setFeature</a> (const XMLCh *const name, const bool value)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the state of any feature in a SAX2 XMLReader. <a href="#a597ea87071e1a0aa1288567e4bfd6d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#02a51d39bbb1241cef2f6dab1ec56947">setProperty</a> (const XMLCh *const name, void *value)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the value of any property in a SAX2 XMLReader. <a href="#02a51d39bbb1241cef2f6dab1ec56947"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#284811d3b9785e0898093638ab17662d">parse</a> (const <a class="el" href="classInputSource.html">InputSource</a> &amp;source)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse an XML document. <a href="#284811d3b9785e0898093638ab17662d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#faa08affc814631f5a6059e9611b84e3">parse</a> (const XMLCh *const systemId)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse an XML document from a system identifier (URI). <a href="#faa08affc814631f5a6059e9611b84e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#b063964b062ebbb98a74347354877f45">parse</a> (const char *const systemId)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse an XML document from a system identifier (URI). <a href="#b063964b062ebbb98a74347354877f45"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">SAX 2.0-ext</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDeclHandler.html">DeclHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#8f814c6f2a2b1750ea6672de7c2392cd">getDeclarationHandler</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the installed declaration handler. <a href="#8f814c6f2a2b1750ea6672de7c2392cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classLexicalHandler.html">LexicalHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#2279a6a050eef26c67ba11620044a0ec">getLexicalHandler</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the installed lexical handler. <a href="#2279a6a050eef26c67ba11620044a0ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#60b5233e334c78920a8361cec2a81429">setDeclarationHandler</a> (<a class="el" href="classDeclHandler.html">DeclHandler</a> *const handler)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow an application to register a declaration event handler. <a href="#60b5233e334c78920a8361cec2a81429"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#397fd37a21987186c6e4e63211f5d118">setLexicalHandler</a> (<a class="el" href="classLexicalHandler.html">LexicalHandler</a> *const handler)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow an application to register a lexical event handler. <a href="#397fd37a21987186c6e4e63211f5d118"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Getter Methods (Xerces-C specific)</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXMLValidator.html">XMLValidator</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#a9fd92dd2a348d0884c2ec8156c755db">getValidator</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is used to get the current validator. <a href="#a9fd92dd2a348d0884c2ec8156c755db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#6a6f6b7af13342e221b8cac6335af05c">getErrorCount</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get error count from the last parse operation. <a href="#6a6f6b7af13342e221b8cac6335af05c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#693dae9983a6d951c1fb36f0a9eab111">getExitOnFirstFatalError</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the state of the parser's exit-on-First-Fatal-Error flag. <a href="#693dae9983a6d951c1fb36f0a9eab111"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#f2d257d62e2b044095409d84181c6424">getValidationConstraintFatal</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the state of the parser's validation-constraint-fatal flag. <a href="#f2d257d62e2b044095409d84181c6424"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#edc75b118c38b2beb51cb074f25c04b5">getGrammar</a> (const XMLCh *const nameSpaceKey)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the grammar that is associated with the specified namespace key. <a href="#edc75b118c38b2beb51cb074f25c04b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#a294a6a334a9bfd2b5ec048419875f5f">getRootGrammar</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the grammar where the root element is declared. <a href="#a294a6a334a9bfd2b5ec048419875f5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#f20b4b419f902f2fc46bb2d7043077da">getURIText</a> (unsigned int uriId) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the string corresponding to a URI id from the URI string pool. <a href="#f20b4b419f902f2fc46bb2d7043077da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#62b318d390f6c99bc254a2c7a2892230">getSrcOffset</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the current src offset within the input source. <a href="#62b318d390f6c99bc254a2c7a2892230"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Setter Methods (Xerces-C specific)</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#2ee07410cc0f6488eeada730471990ae">setValidator</a> (<a class="el" href="classXMLValidator.html">XMLValidator</a> *valueToAdopt)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is used to set a validator. <a href="#2ee07410cc0f6488eeada730471990ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#ceaca940ae26cc40234074f338632872">setExitOnFirstFatalError</a> (const bool newState)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method allows users to set the parser's behaviour when it encounters the first fatal error. <a href="#ceaca940ae26cc40234074f338632872"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#1e582e31531c645181c220c9ccbbe904">setValidationConstraintFatal</a> (const bool newState)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method allows users to set the parser's behaviour when it encounters a validtion constraint error. <a href="#1e582e31531c645181c220c9ccbbe904"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Progressive scan methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c">parseFirst</a> (const XMLCh *const systemId, XMLPScanToken &amp;toFill)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begin a progressive parse operation. <a href="#e3be1a347fa03c6f6c08d6298702905c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#ad62c959271689d53d14fc772350ba41">parseFirst</a> (const char *const systemId, XMLPScanToken &amp;toFill)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begin a progressive parse operation. <a href="#ad62c959271689d53d14fc772350ba41"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#b3bd9b161c22c87564697edc56560c38">parseFirst</a> (const <a class="el" href="classInputSource.html">InputSource</a> &amp;source, XMLPScanToken &amp;toFill)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begin a progressive parse operation. <a href="#b3bd9b161c22c87564697edc56560c38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#f5369c76d498e87fdb24c36fc4100fb0">parseNext</a> (XMLPScanToken &amp;token)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Continue a progressive parse operation. <a href="#f5369c76d498e87fdb24c36fc4100fb0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#58e67a11484763eb0eb705d4cfc3cbf5">parseReset</a> (XMLPScanToken &amp;token)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the parser after a progressive parse. <a href="#58e67a11484763eb0eb705d4cfc3cbf5"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Grammar preparsing interface's.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#668eb6326a1e434e606bee19e7c9ceda">loadGrammar</a> (const <a class="el" href="classInputSource.html">InputSource</a> &amp;source, const short grammarType, const bool toCache=false)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Preparse schema grammar (XML Schema, DTD, etc. <a href="#668eb6326a1e434e606bee19e7c9ceda"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#ce230b9160b2e61c77ca3ae2352b0752">loadGrammar</a> (const XMLCh *const systemId, const short grammarType, const bool toCache=false)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Preparse schema grammar (XML Schema, DTD, etc. <a href="#ce230b9160b2e61c77ca3ae2352b0752"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#bd2e964ce9a4288012dc925ce9036397">loadGrammar</a> (const char *const systemId, const short grammarType, const bool toCache=false)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Preparse schema grammar (XML Schema, DTD, etc. <a href="#bd2e964ce9a4288012dc925ce9036397"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#8ade5e379ef8233584695786d5851714">resetCachedGrammarPool</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the cached grammar pool. <a href="#8ade5e379ef8233584695786d5851714"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#54d0271485abd542b21d3982966d7ff9">setInputBufferSize</a> (const size_t bufferSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set maximum input buffer size. <a href="#54d0271485abd542b21d3982966d7ff9"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Advanced document handler list maintenance methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#5235f668aea5d4a799258338d01d7636">installAdvDocHandler</a> (<a class="el" href="classXMLDocumentHandler.html">XMLDocumentHandler</a> *const toInstall)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method installs the specified 'advanced' document callback handler, thereby allowing the user to customize the processing, if they choose to do so. <a href="#5235f668aea5d4a799258338d01d7636"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSAX2XMLReader.html#46885254749d80ef2dfb19ad8d48e1e0">removeAdvDocHandler</a> (<a class="el" href="classXMLDocumentHandler.html">XMLDocumentHandler</a> *const toRemove)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method removes the 'advanced' document handler callback from the underlying parser scanner. <a href="#46885254749d80ef2dfb19ad8d48e1e0"></a><br></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="d6be26566ce8e2f65b95849247d10853"></a><!-- doxytag: member="SAX2XMLReader::ValSchemes" ref="d6be26566ce8e2f65b95849247d10853" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classSAX2XMLReader.html#d6be26566ce8e2f65b95849247d10853">SAX2XMLReader::ValSchemes</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ValScheme enum used in setValidationScheme Val_Never: Do not report validation errors.
<p>
Val_Always: The parser will always report validation errors. Val_Auto: The parser will report validation errors only if a grammar is specified.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>setValidationScheme </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="d6be26566ce8e2f65b95849247d108537b5317560a7f1130511148b7750d6244"></a><!-- doxytag: member="Val_Never" ref="d6be26566ce8e2f65b95849247d108537b5317560a7f1130511148b7750d6244" args="" -->Val_Never</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d6be26566ce8e2f65b95849247d1085395ad9c6bc78a2ce7fa2a8db410b1dc39"></a><!-- doxytag: member="Val_Always" ref="d6be26566ce8e2f65b95849247d1085395ad9c6bc78a2ce7fa2a8db410b1dc39" args="" -->Val_Always</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d6be26566ce8e2f65b95849247d1085357143e99019f8302ea26965e26ce7cb0"></a><!-- doxytag: member="Val_Auto" ref="d6be26566ce8e2f65b95849247d1085357143e99019f8302ea26965e26ce7cb0" args="" -->Val_Auto</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="faad9a21efa3e2626e80a7045c3a39b1"></a><!-- doxytag: member="SAX2XMLReader::SAX2XMLReader" ref="faad9a21efa3e2626e80a7045c3a39b1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SAX2XMLReader::SAX2XMLReader </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="65eac731ad3537122d86bf5826fe8047"></a><!-- doxytag: member="SAX2XMLReader::~SAX2XMLReader" ref="65eac731ad3537122d86bf5826fe8047" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual SAX2XMLReader::~SAX2XMLReader </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9fda35bb540194c1a8a5a4a95c0bcdb7"></a><!-- doxytag: member="SAX2XMLReader::getContentHandler" ref="9fda35bb540194c1a8a5a4a95c0bcdb7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classContentHandler.html">ContentHandler</a>* SAX2XMLReader::getContentHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the installed content handler.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the installed content handler object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="89f6ad6b94dce1d82f86d88084cafeaf"></a><!-- doxytag: member="SAX2XMLReader::getDTDHandler" ref="89f6ad6b94dce1d82f86d88084cafeaf" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDTDHandler.html">DTDHandler</a>* SAX2XMLReader::getDTDHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the installed DTD handler.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the installed DTD handler object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ef939a6a68ded3d000f8ecbd80cc5089"></a><!-- doxytag: member="SAX2XMLReader::getEntityResolver" ref="ef939a6a68ded3d000f8ecbd80cc5089" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classEntityResolver.html">EntityResolver</a>* SAX2XMLReader::getEntityResolver </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the installed entity resolver.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the installed entity resolver object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="96bb93cd1b62dd75068325cbcdfbb581"></a><!-- doxytag: member="SAX2XMLReader::getErrorHandler" ref="96bb93cd1b62dd75068325cbcdfbb581" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classErrorHandler.html">ErrorHandler</a>* SAX2XMLReader::getErrorHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the installed error handler.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the installed error handler object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6a704107fbb8c3552589236e959238be"></a><!-- doxytag: member="SAX2XMLReader::getFeature" ref="6a704107fbb8c3552589236e959238be" args="(const XMLCh *const name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::getFeature </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the current state of any feature in a SAX2 XMLReader.
<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>name</em>&nbsp;</td><td>The unique identifier (URI) of the feature being set. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The current state of the feature. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXNotRecognizedException.html">SAXNotRecognizedException</a></em>&nbsp;</td><td>If the requested feature is not known. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="909627968ffa64bb14e673d5e2caf6f7"></a><!-- doxytag: member="SAX2XMLReader::getProperty" ref="909627968ffa64bb14e673d5e2caf6f7" args="(const XMLCh *const name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* SAX2XMLReader::getProperty </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the current value of a property in a SAX2 XMLReader.
<p>
The parser owns the returned pointer. The memory allocated for the returned pointer will be destroyed when the parser is deleted.<p>
To ensure assessiblity of the returned information after the parser is deleted, callers need to copy and store the returned information somewhere else; otherwise you may get unexpected result. Since the returned pointer is a generic void pointer, see <a href="http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties">http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties</a> to learn exactly what type of property value each property returns for replication.<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>name</em>&nbsp;</td><td>The unique identifier (URI) of the property being set. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The current value of the property. The pointer spans the same life-time as the parser. A null pointer is returned if nothing was specified externally. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXNotRecognizedException.html">SAXNotRecognizedException</a></em>&nbsp;</td><td>If the requested property is not known. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a1885becac34443e9648ccaeeed733f5"></a><!-- doxytag: member="SAX2XMLReader::setContentHandler" ref="a1885becac34443e9648ccaeeed733f5" args="(ContentHandler *const handler)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setContentHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classContentHandler.html">ContentHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>handler</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow an application to register a document event handler.
<p>
If the application does not register a document handler, all document events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers.">HandlerBase</a>).<p>
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.<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>handler</em>&nbsp;</td><td>The document handler. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classDocumentHandler.html#c24bb98e06d7db2b0823816eec2f6c19" title="Default constructor.">DocumentHandler::DocumentHandler</a> <p>
<a class="el" href="classHandlerBase.html#a9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b862874149da5e744a04f1bc6de60ff4"></a><!-- doxytag: member="SAX2XMLReader::setDTDHandler" ref="b862874149da5e744a04f1bc6de60ff4" args="(DTDHandler *const handler)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setDTDHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDTDHandler.html">DTDHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>handler</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow an application to register a DTD event handler.
<p>
If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers.">HandlerBase</a>).<p>
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.<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>handler</em>&nbsp;</td><td>The DTD handler. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classDTDHandler.html#1d17e15d976164f6d55f542759eea182" title="Default Constructor.">DTDHandler::DTDHandler</a> <p>
<a class="el" href="classHandlerBase.html#a9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b4621486a9776d480ec10e596a4d66a6"></a><!-- doxytag: member="SAX2XMLReader::setEntityResolver" ref="b4621486a9776d480ec10e596a4d66a6" args="(EntityResolver *const resolver)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setEntityResolver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classEntityResolver.html">EntityResolver</a> *const &nbsp;</td>
<td class="paramname"> <em>resolver</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow an application to register a custom entity resolver.
<p>
If the application does not register an entity resolver, the SAX parser will resolve system identifiers and open connections to entities itself (this is the default behaviour implemented in <a class="el" href="classDefaultHandler.html" title="Default base class for SAX2 handlers.">DefaultHandler</a>).<p>
Applications may register a new or different entity resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.<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>resolver</em>&nbsp;</td><td>The object for resolving entities. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classEntityResolver.html#14e534eb2170015056ccd71458e1058c" title="Default Constructor.">EntityResolver::EntityResolver</a> <p>
<a class="el" href="classDefaultHandler.html#b3aff728663a1c0aa9a1c0ed517f6806">DefaultHandler::DefaultHandler</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="910e9acbec9c8bbd4ff3fdb92c76cf0e"></a><!-- doxytag: member="SAX2XMLReader::setErrorHandler" ref="910e9acbec9c8bbd4ff3fdb92c76cf0e" args="(ErrorHandler *const handler)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setErrorHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classErrorHandler.html">ErrorHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>handler</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow an application to register an error event handler.
<p>
If the application does not register an error event handler, all error events reported by the SAX parser will be silently ignored, except for fatalError, which will throw a <a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a> (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers.">HandlerBase</a>).<p>
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.<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>handler</em>&nbsp;</td><td>The error handler. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classErrorHandler.html#7e5f379bd231442b898cef94556b2107" title="Default constructor.">ErrorHandler::ErrorHandler</a> <p>
<a class="el" href="classSAXException.html#e1c8ab9b99e3c43572c1567e72c652e4" title="Default constructor.">SAXException::SAXException</a> <p>
<a class="el" href="classHandlerBase.html#a9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="a597ea87071e1a0aa1288567e4bfd6d7"></a><!-- doxytag: member="SAX2XMLReader::setFeature" ref="a597ea87071e1a0aa1288567e4bfd6d7" args="(const XMLCh *const name, const bool value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setFeature </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool&nbsp;</td>
<td class="paramname"> <em>value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the state of any feature in a SAX2 XMLReader.
<p>
Supported features in SAX2 for xerces-c are: <br>
(See <a href="http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Features">http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Features</a> for detail description).<p>
<br>
<a href="http://xml.org/sax/features/validation">http://xml.org/sax/features/validation</a> (default: true) <br>
<a href="http://xml.org/sax/features/namespaces">http://xml.org/sax/features/namespaces</a> (default: true) <br>
<a href="http://xml.org/sax/features/namespace-prefixes">http://xml.org/sax/features/namespace-prefixes</a> (default: false) <br>
<a href="http://apache.org/xml/features/validation/dynamic">http://apache.org/xml/features/validation/dynamic</a> (default: false) <br>
<a href="http://apache.org/xml/features/validation/reuse-grammar">http://apache.org/xml/features/validation/reuse-grammar</a> (default: false) <br>
<a href="http://apache.org/xml/features/validation/schema">http://apache.org/xml/features/validation/schema</a> (default: true) <br>
<a href="http://apache.org/xml/features/validation/schema-full-checking">http://apache.org/xml/features/validation/schema-full-checking</a> (default: false) <br>
<a href="http://apache.org/xml/features/nonvalidating/load-external-dtd">http://apache.org/xml/features/nonvalidating/load-external-dtd</a> (default: true) <br>
<a href="http://apache.org/xml/features/continue-after-fatal-error">http://apache.org/xml/features/continue-after-fatal-error</a> (default: false) <br>
<a href="http://apache.org/xml/features/validation-error-as-fatal">http://apache.org/xml/features/validation-error-as-fatal</a> (default: false) <br>
<a href="http://apache.org/xml/features/validation/reuse-validator">http://apache.org/xml/features/validation/reuse-validator</a> (Deprecated) (default: false)<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>name</em>&nbsp;</td><td>The unique identifier (URI) of the feature. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The requested state of the feature (true or false). </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXNotRecognizedException.html">SAXNotRecognizedException</a></em>&nbsp;</td><td>If the requested feature is not known. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXNotSupportedException.html">SAXNotSupportedException</a></em>&nbsp;</td><td>Feature modification is not supported during parse </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="02a51d39bbb1241cef2f6dab1ec56947"></a><!-- doxytag: member="SAX2XMLReader::setProperty" ref="02a51d39bbb1241cef2f6dab1ec56947" args="(const XMLCh *const name, void *value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setProperty </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the value of any property in a SAX2 XMLReader.
<p>
Supported properties in SAX2 for xerces-c are: <br>
(See <a href="http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties">http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties</a> for detail description).<p>
<br>
<a href="http://apache.org/xml/properties/schema/external-schemaLocation">http://apache.org/xml/properties/schema/external-schemaLocation</a> <br>
<a href="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation.">http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation.</a><p>
It takes a void pointer as the property value. Application is required to initialize this void pointer to a correct type. See <a href="http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties">http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties</a> to learn exactly what type of property value each property expects for processing. Passing a void pointer that was initialized with a wrong type will lead to unexpected result. If the same property is set more than once, the last one takes effect.<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>name</em>&nbsp;</td><td>The unique identifier (URI) of the property being set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The requested value for the property. See <a href="http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties">http://xerces.apache.org/xerces-c/program-sax2.html#SAX2Properties</a> to learn exactly what type of property value each property expects for processing. Passing a void pointer that was initialized with a wrong type will lead to unexpected result. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXNotRecognizedException.html">SAXNotRecognizedException</a></em>&nbsp;</td><td>If the requested property is not known. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXNotSupportedException.html">SAXNotSupportedException</a></em>&nbsp;</td><td>Property modification is not supported during parse </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="284811d3b9785e0898093638ab17662d"></a><!-- doxytag: member="SAX2XMLReader::parse" ref="284811d3b9785e0898093638ab17662d" args="(const InputSource &amp;source)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classInputSource.html">InputSource</a> &amp;&nbsp;</td>
<td class="paramname"> <em>source</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse an XML document.
<p>
The application can use this method to instruct the SAX parser to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).<p>
Applications may not invoke this method while a parse is in progress (they should create a new <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers.">Parser</a> instead for each additional XML document). Once a parse is complete, an application may reuse the same <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers.">Parser</a> object, possibly with a different input source.<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>source</em>&nbsp;</td><td>The input source for the top-level of the XML document. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em>&nbsp;</td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>An exception from the parser or client handler code. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classInputSource.html#601a7aa7124e2d8e9664eda9aea6b622" title="Default constructor.">InputSource::InputSource</a> <p>
<a class="el" href="classSAX2XMLReader.html#b4621486a9776d480ec10e596a4d66a6" title="Allow an application to register a custom entity resolver.">setEntityResolver</a> <p>
<a class="el" href="classSAX2XMLReader.html#b862874149da5e744a04f1bc6de60ff4" title="Allow an application to register a DTD event handler.">setDTDHandler</a> <p>
setDocumentHandler <p>
<a class="el" href="classSAX2XMLReader.html#910e9acbec9c8bbd4ff3fdb92c76cf0e" title="Allow an application to register an error event handler.">setErrorHandler</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="faa08affc814631f5a6059e9611b84e3"></a><!-- doxytag: member="SAX2XMLReader::parse" ref="faa08affc814631f5a6059e9611b84e3" args="(const XMLCh *const systemId)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::parse </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>systemId</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse an XML document from a system identifier (URI).
<p>
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:<p>
parse(new URLInputSource(systemId));<p>
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.<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>&nbsp;</td><td>The system identifier (URI). </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em>&nbsp;</td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>An exception from the parser or client handler code. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>parse(InputSource) </dd></dl>
</div>
</div><p>
<a class="anchor" name="b063964b062ebbb98a74347354877f45"></a><!-- doxytag: member="SAX2XMLReader::parse" ref="b063964b062ebbb98a74347354877f45" args="(const char *const systemId)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::parse </td>
<td>(</td>
<td class="paramtype">const char *const &nbsp;</td>
<td class="paramname"> <em>systemId</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse an XML document from a system identifier (URI).
<p>
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:<p>
parse(new URLInputSource(systemId));<p>
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.<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>&nbsp;</td><td>The system identifier (URI). </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em>&nbsp;</td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>An exception from the parser or client handler code. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>parse(InputSource) </dd></dl>
</div>
</div><p>
<a class="anchor" name="8f814c6f2a2b1750ea6672de7c2392cd"></a><!-- doxytag: member="SAX2XMLReader::getDeclarationHandler" ref="8f814c6f2a2b1750ea6672de7c2392cd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDeclHandler.html">DeclHandler</a>* SAX2XMLReader::getDeclarationHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the installed declaration handler.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the installed declaration handler object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2279a6a050eef26c67ba11620044a0ec"></a><!-- doxytag: member="SAX2XMLReader::getLexicalHandler" ref="2279a6a050eef26c67ba11620044a0ec" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classLexicalHandler.html">LexicalHandler</a>* SAX2XMLReader::getLexicalHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the installed lexical handler.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the installed lexical handler object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="60b5233e334c78920a8361cec2a81429"></a><!-- doxytag: member="SAX2XMLReader::setDeclarationHandler" ref="60b5233e334c78920a8361cec2a81429" args="(DeclHandler *const handler)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setDeclarationHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDeclHandler.html">DeclHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>handler</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow an application to register a declaration event handler.
<p>
If the application does not register a declaration handler, all events reported by the SAX parser will be silently ignored. (this is the default behaviour implemented by <a class="el" href="classDefaultHandler.html" title="Default base class for SAX2 handlers.">DefaultHandler</a>).<p>
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.<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>handler</em>&nbsp;</td><td>The DTD declaration handler. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classDeclHandler.html#3155ea1a3555f906321735d78e330f05" title="Default constructor.">DeclHandler::DeclHandler</a> <p>
<a class="el" href="classSAXException.html#e1c8ab9b99e3c43572c1567e72c652e4" title="Default constructor.">SAXException::SAXException</a> <p>
<a class="el" href="classDefaultHandler.html#b3aff728663a1c0aa9a1c0ed517f6806">DefaultHandler::DefaultHandler</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="397fd37a21987186c6e4e63211f5d118"></a><!-- doxytag: member="SAX2XMLReader::setLexicalHandler" ref="397fd37a21987186c6e4e63211f5d118" args="(LexicalHandler *const handler)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setLexicalHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLexicalHandler.html">LexicalHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>handler</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow an application to register a lexical event handler.
<p>
If the application does not register a lexical handler, all events reported by the SAX parser will be silently ignored. (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers.">HandlerBase</a>).<p>
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.<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>handler</em>&nbsp;</td><td>The error handler. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLexicalHandler.html#355f99e04837f54f0041a29c86530fa0" title="Default constructor.">LexicalHandler::LexicalHandler</a> <p>
<a class="el" href="classSAXException.html#e1c8ab9b99e3c43572c1567e72c652e4" title="Default constructor.">SAXException::SAXException</a> <p>
<a class="el" href="classHandlerBase.html#a9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="a9fd92dd2a348d0884c2ec8156c755db"></a><!-- doxytag: member="SAX2XMLReader::getValidator" ref="a9fd92dd2a348d0884c2ec8156c755db" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXMLValidator.html">XMLValidator</a>* SAX2XMLReader::getValidator </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is used to get the current validator.
<p>
<b><a class="el" href="classSAX2XMLReader.html">SAX2XMLReader</a> assumes responsibility for the validator. It will be deleted when the XMLReader is destroyed.</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the validator. An application should not deleted the object returned. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6a6f6b7af13342e221b8cac6335af05c"></a><!-- doxytag: member="SAX2XMLReader::getErrorCount" ref="6a6f6b7af13342e221b8cac6335af05c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int SAX2XMLReader::getErrorCount </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get error count from the last parse operation.
<p>
This method returns the error count from the last parse operation. Note that this count is actually stored in the scanner, so this method simply returns what the scanner reports.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>number of errors encountered during the latest parse operation. </dd></dl>
</div>
</div><p>
<a class="anchor" name="693dae9983a6d951c1fb36f0a9eab111"></a><!-- doxytag: member="SAX2XMLReader::getExitOnFirstFatalError" ref="693dae9983a6d951c1fb36f0a9eab111" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::getExitOnFirstFatalError </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the state of the parser's exit-on-First-Fatal-Error flag.
<p>
Or you can query the feature "http://apache.org/xml/features/continue-after-fatal-error" which indicates the opposite state.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true, if the parser is currently configured to exit on the first fatal error, false otherwise.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#ceaca940ae26cc40234074f338632872" title="This method allows users to set the parser&#39;s behaviour when it encounters the...">setExitOnFirstFatalError</a> <p>
<a class="el" href="classSAX2XMLReader.html#6a704107fbb8c3552589236e959238be" title="Query the current state of any feature in a SAX2 XMLReader.">getFeature</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f2d257d62e2b044095409d84181c6424"></a><!-- doxytag: member="SAX2XMLReader::getValidationConstraintFatal" ref="f2d257d62e2b044095409d84181c6424" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::getValidationConstraintFatal </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the state of the parser's validation-constraint-fatal flag.
<p>
Or you can query the feature "http://apache.org/xml/features/validation-error-as-fatal" which means the same thing.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true, if the parser is currently configured to set validation constraint errors as fatal, false otherwise.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>setValidationContraintFatal <p>
<a class="el" href="classSAX2XMLReader.html#6a704107fbb8c3552589236e959238be" title="Query the current state of any feature in a SAX2 XMLReader.">getFeature</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="edc75b118c38b2beb51cb074f25c04b5"></a><!-- doxytag: member="SAX2XMLReader::getGrammar" ref="edc75b118c38b2beb51cb074f25c04b5" args="(const XMLCh *const nameSpaceKey)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Grammar* SAX2XMLReader::getGrammar </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>nameSpaceKey</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the grammar that is associated with the specified namespace key.
<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>nameSpaceKey</em>&nbsp;</td><td>Namespace key </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Grammar associated with the Namespace key. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a294a6a334a9bfd2b5ec048419875f5f"></a><!-- doxytag: member="SAX2XMLReader::getRootGrammar" ref="a294a6a334a9bfd2b5ec048419875f5f" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Grammar* SAX2XMLReader::getRootGrammar </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the grammar where the root element is declared.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Grammar where root element declared </dd></dl>
</div>
</div><p>
<a class="anchor" name="f20b4b419f902f2fc46bb2d7043077da"></a><!-- doxytag: member="SAX2XMLReader::getURIText" ref="f20b4b419f902f2fc46bb2d7043077da" args="(unsigned int uriId) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* SAX2XMLReader::getURIText </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>uriId</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the string corresponding to a URI id from the URI string pool.
<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>uriId</em>&nbsp;</td><td>id of the string in the URI string pool. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>URI string corresponding to the URI id. </dd></dl>
</div>
</div><p>
<a class="anchor" name="62b318d390f6c99bc254a2c7a2892230"></a><!-- doxytag: member="SAX2XMLReader::getSrcOffset" ref="62b318d390f6c99bc254a2c7a2892230" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int SAX2XMLReader::getSrcOffset </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the current src offset within the input source.
<p>
To be used only while parsing is in progress.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>offset within the input source </dd></dl>
</div>
</div><p>
<a class="anchor" name="2ee07410cc0f6488eeada730471990ae"></a><!-- doxytag: member="SAX2XMLReader::setValidator" ref="2ee07410cc0f6488eeada730471990ae" args="(XMLValidator *valueToAdopt)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setValidator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXMLValidator.html">XMLValidator</a> *&nbsp;</td>
<td class="paramname"> <em>valueToAdopt</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is used to set a validator.
<p>
<b><a class="el" href="classSAX2XMLReader.html">SAX2XMLReader</a> assumes responsibility for the validator. It will be deleted when the XMLReader is destroyed.</b><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>valueToAdopt</em>&nbsp;</td><td>A pointer to the validator that the reader should use. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ceaca940ae26cc40234074f338632872"></a><!-- doxytag: member="SAX2XMLReader::setExitOnFirstFatalError" ref="ceaca940ae26cc40234074f338632872" args="(const bool newState)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setExitOnFirstFatalError </td>
<td>(</td>
<td class="paramtype">const bool&nbsp;</td>
<td class="paramname"> <em>newState</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method allows users to set the parser's behaviour when it encounters the first fatal error.
<p>
If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.<p>
The default value is 'true' and the parser exits on the first fatal error.<p>
Or you can set the feature "http://apache.org/xml/features/continue-after-fatal-error" which has the opposite behaviour.<p>
If both the feature above and this function are used, the latter takes effect.<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>newState</em>&nbsp;</td><td>The value specifying whether the parser should continue or exit when it encounters the first fatal error.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#693dae9983a6d951c1fb36f0a9eab111" title="This method returns the state of the parser&#39;s exit-on-First-Fatal-Error flag...">getExitOnFirstFatalError</a> <p>
<a class="el" href="classSAX2XMLReader.html#a597ea87071e1a0aa1288567e4bfd6d7" title="Set the state of any feature in a SAX2 XMLReader.">setFeature</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1e582e31531c645181c220c9ccbbe904"></a><!-- doxytag: member="SAX2XMLReader::setValidationConstraintFatal" ref="1e582e31531c645181c220c9ccbbe904" args="(const bool newState)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::setValidationConstraintFatal </td>
<td>(</td>
<td class="paramtype">const bool&nbsp;</td>
<td class="paramname"> <em>newState</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method allows users to set the parser's behaviour when it encounters a validtion constraint error.
<p>
If set to true, and the the parser will treat validation error as fatal and will exit depends on the state of "getExitOnFirstFatalError". If false, then it will report the error and continue processing.<p>
Note: setting this true does not mean the validation error will be printed with the word "Fatal Error". It is still printed as "Error", but the parser will exit if "setExitOnFirstFatalError" is set to true.<p>
The default value is 'false'.<p>
Or you can set the feature "http://apache.org/xml/features/validation-error-as-fatal" which means the same thing.<p>
If both the feature above and this function are used, the latter takes effect.<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>newState</em>&nbsp;</td><td>If true, the parser will exit if "setExitOnFirstFatalError" is set to true.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#f2d257d62e2b044095409d84181c6424" title="This method returns the state of the parser&#39;s validation-constraint-fatal flag...">getValidationConstraintFatal</a> <p>
<a class="el" href="classSAX2XMLReader.html#ceaca940ae26cc40234074f338632872" title="This method allows users to set the parser&#39;s behaviour when it encounters the...">setExitOnFirstFatalError</a> <p>
<a class="el" href="classSAX2XMLReader.html#a597ea87071e1a0aa1288567e4bfd6d7" title="Set the state of any feature in a SAX2 XMLReader.">setFeature</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="e3be1a347fa03c6f6c08d6298702905c"></a><!-- doxytag: member="SAX2XMLReader::parseFirst" ref="e3be1a347fa03c6f6c08d6298702905c" args="(const XMLCh *const systemId, XMLPScanToken &amp;toFill)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::parseFirst </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>systemId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMLPScanToken &amp;&nbsp;</td>
<td class="paramname"> <em>toFill</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Begin a progressive parse operation.
<p>
This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.<p>
It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls.<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>&nbsp;</td><td>A pointer to a Unicode string represting the path to the XML file to be parsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toFill</em>&nbsp;</td><td>A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could parse the prolog (which means the token will not be valid.)</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#f5369c76d498e87fdb24c36fc4100fb0" title="Continue a progressive parse operation.">parseNext</a> <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(char*,...) <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(<a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a>&amp;,...) </dd></dl>
</div>
</div><p>
<a class="anchor" name="ad62c959271689d53d14fc772350ba41"></a><!-- doxytag: member="SAX2XMLReader::parseFirst" ref="ad62c959271689d53d14fc772350ba41" args="(const char *const systemId, XMLPScanToken &amp;toFill)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::parseFirst </td>
<td>(</td>
<td class="paramtype">const char *const &nbsp;</td>
<td class="paramname"> <em>systemId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMLPScanToken &amp;&nbsp;</td>
<td class="paramname"> <em>toFill</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Begin a progressive parse operation.
<p>
This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.<p>
It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls.<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>&nbsp;</td><td>A pointer to a regular native string represting the path to the XML file to be parsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toFill</em>&nbsp;</td><td>A token maintaing state information to maintain internal consIstency between invocation of 'parseNext' calls.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#f5369c76d498e87fdb24c36fc4100fb0" title="Continue a progressive parse operation.">parseNext</a> <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(XMLCh*,...) <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(<a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a>&amp;,...) </dd></dl>
</div>
</div><p>
<a class="anchor" name="b3bd9b161c22c87564697edc56560c38"></a><!-- doxytag: member="SAX2XMLReader::parseFirst" ref="b3bd9b161c22c87564697edc56560c38" args="(const InputSource &amp;source, XMLPScanToken &amp;toFill)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::parseFirst </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classInputSource.html">InputSource</a> &amp;&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMLPScanToken &amp;&nbsp;</td>
<td class="paramname"> <em>toFill</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Begin a progressive parse operation.
<p>
This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.<p>
It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls.<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>source</em>&nbsp;</td><td>A const reference to the <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> object which points to the XML file to be parsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toFill</em>&nbsp;</td><td>A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#f5369c76d498e87fdb24c36fc4100fb0" title="Continue a progressive parse operation.">parseNext</a> <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(XMLCh*,...) <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(char*,...) </dd></dl>
</div>
</div><p>
<a class="anchor" name="f5369c76d498e87fdb24c36fc4100fb0"></a><!-- doxytag: member="SAX2XMLReader::parseNext" ref="f5369c76d498e87fdb24c36fc4100fb0" args="(XMLPScanToken &amp;token)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::parseNext </td>
<td>(</td>
<td class="paramtype">XMLPScanToken &amp;&nbsp;</td>
<td class="paramname"> <em>token</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Continue a progressive parse operation.
<p>
This method is used to continue with progressive parsing of XML files started by a call to 'parseFirst' method.<p>
It parses the XML file and stops as soon as it comes across a XML token (as defined in the XML specification). Relevant callback handlers are invoked as required by the SAX specification.<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>token</em>&nbsp;</td><td>A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>'true', if successful in parsing the next XML token. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not find next token as per the XML specification production rule.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(XMLCh*,...) <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(char*,...) <p>
<a class="el" href="classSAX2XMLReader.html#e3be1a347fa03c6f6c08d6298702905c" title="Begin a progressive parse operation.">parseFirst</a>(<a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a>&amp;,...) </dd></dl>
</div>
</div><p>
<a class="anchor" name="58e67a11484763eb0eb705d4cfc3cbf5"></a><!-- doxytag: member="SAX2XMLReader::parseReset" ref="58e67a11484763eb0eb705d4cfc3cbf5" args="(XMLPScanToken &amp;token)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::parseReset </td>
<td>(</td>
<td class="paramtype">XMLPScanToken &amp;&nbsp;</td>
<td class="paramname"> <em>token</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the parser after a progressive parse.
<p>
If a progressive parse loop exits before the end of the document is reached, the parser has no way of knowing this. So it will leave open any files or sockets or memory buffers that were in use at the time that the parse loop exited.<p>
The next parse operation will cause these open files and such to be closed, but the next parse operation might occur at some unknown future point. To avoid this problem, you should reset the parser if you exit the loop early.<p>
If you exited because of an error, then this cleanup will be done for you. Its only when you exit the file prematurely of your own accord, because you've found what you wanted in the file most likely.<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>token</em>&nbsp;</td><td>A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="668eb6326a1e434e606bee19e7c9ceda"></a><!-- doxytag: member="SAX2XMLReader::loadGrammar" ref="668eb6326a1e434e606bee19e7c9ceda" args="(const InputSource &amp;source, const short grammarType, const bool toCache=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Grammar* SAX2XMLReader::loadGrammar </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classInputSource.html">InputSource</a> &amp;&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const short&nbsp;</td>
<td class="paramname"> <em>grammarType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool&nbsp;</td>
<td class="paramname"> <em>toCache</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Preparse schema grammar (XML Schema, DTD, etc.
<p>
) via an input source object.<p>
This method invokes the preparsing process on a schema grammar XML file specified by the SAX <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> parameter. If the 'toCache' flag is enabled, the parser will cache the grammars for re-use. If a grammar key is found in the pool, no caching of any grammar will take place.<p>
<b>"Experimental - subject to change"</b><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>A const reference to the SAX <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> object which points to the schema grammar file to be preparsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>grammarType</em>&nbsp;</td><td>The grammar type (Schema or DTD). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toCache</em>&nbsp;</td><td>If <code>true</code>, we cache the preparsed grammar, otherwise, no chaching. Default is <code>false</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The preparsed schema grammar object (SchemaGrammar or DTDGrammar). That grammar object is owned by the parser.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em>&nbsp;</td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>An exception from the parser or client handler code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>A DOM exception as per DOM spec.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classInputSource.html#601a7aa7124e2d8e9664eda9aea6b622" title="Default constructor.">InputSource::InputSource</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ce230b9160b2e61c77ca3ae2352b0752"></a><!-- doxytag: member="SAX2XMLReader::loadGrammar" ref="ce230b9160b2e61c77ca3ae2352b0752" args="(const XMLCh *const systemId, const short grammarType, const bool toCache=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Grammar* SAX2XMLReader::loadGrammar </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>systemId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const short&nbsp;</td>
<td class="paramname"> <em>grammarType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool&nbsp;</td>
<td class="paramname"> <em>toCache</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Preparse schema grammar (XML Schema, DTD, etc.
<p>
) via a file path or URL<p>
This method invokes the preparsing process on a schema grammar XML file specified by the file path parameter. If the 'toCache' flag is enabled, the parser will cache the grammars for re-use. If a grammar key is found in the pool, no caching of any grammar will take place.<p>
<b>"Experimental - subject to change"</b><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>systemId</em>&nbsp;</td><td>A const XMLCh pointer to the Unicode string which contains the path to the XML grammar file to be preparsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>grammarType</em>&nbsp;</td><td>The grammar type (Schema or DTD). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toCache</em>&nbsp;</td><td>If <code>true</code>, we cache the preparsed grammar, otherwise, no chaching. Default is <code>false</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The preparsed schema grammar object (SchemaGrammar or DTDGrammar). That grammar object is owned by the parser.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em>&nbsp;</td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>An exception from the parser or client handler code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>A DOM exception as per DOM spec. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="bd2e964ce9a4288012dc925ce9036397"></a><!-- doxytag: member="SAX2XMLReader::loadGrammar" ref="bd2e964ce9a4288012dc925ce9036397" args="(const char *const systemId, const short grammarType, const bool toCache=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Grammar* SAX2XMLReader::loadGrammar </td>
<td>(</td>
<td class="paramtype">const char *const &nbsp;</td>
<td class="paramname"> <em>systemId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const short&nbsp;</td>
<td class="paramname"> <em>grammarType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool&nbsp;</td>
<td class="paramname"> <em>toCache</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Preparse schema grammar (XML Schema, DTD, etc.
<p>
) via a file path or URL<p>
This method invokes the preparsing process on a schema grammar XML file specified by the file path parameter. If the 'toCache' flag is enabled, the parser will cache the grammars for re-use. If a grammar key is found in the pool, no caching of any grammar will take place.<p>
<b>"Experimental - subject to change"</b><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>systemId</em>&nbsp;</td><td>A const char pointer to a native string which contains the path to the XML grammar file to be preparsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>grammarType</em>&nbsp;</td><td>The grammar type (Schema or DTD). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toCache</em>&nbsp;</td><td>If <code>true</code>, we cache the preparsed grammar, otherwise, no chaching. Default is <code>false</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The preparsed schema grammar object (SchemaGrammar or DTDGrammar). That grammar object is owned by the parser.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em>&nbsp;</td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>An exception from the parser or client handler code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>A DOM exception as per DOM spec. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8ade5e379ef8233584695786d5851714"></a><!-- doxytag: member="SAX2XMLReader::resetCachedGrammarPool" ref="8ade5e379ef8233584695786d5851714" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::resetCachedGrammarPool </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear the cached grammar pool.
<p>
</div>
</div><p>
<a class="anchor" name="54d0271485abd542b21d3982966d7ff9"></a><!-- doxytag: member="SAX2XMLReader::setInputBufferSize" ref="54d0271485abd542b21d3982966d7ff9" args="(const size_t bufferSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SAX2XMLReader::setInputBufferSize </td>
<td>(</td>
<td class="paramtype">const size_t&nbsp;</td>
<td class="paramname"> <em>bufferSize</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set maximum input buffer size.
<p>
This method allows users to limit the size of buffers used in parsing XML character data. The effect of setting this size is to limit the size of a <a class="el" href="classContentHandler.html#37b7cc388847f9407417eabde0af9c0a" title="Receive notification of character data.">ContentHandler::characters()</a> call.<p>
The parser's default input buffer size is 1 megabyte.<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>bufferSize</em>&nbsp;</td><td>The maximum input buffer size </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5235f668aea5d4a799258338d01d7636"></a><!-- doxytag: member="SAX2XMLReader::installAdvDocHandler" ref="5235f668aea5d4a799258338d01d7636" args="(XMLDocumentHandler *const toInstall)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SAX2XMLReader::installAdvDocHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXMLDocumentHandler.html">XMLDocumentHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>toInstall</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method installs the specified 'advanced' document callback handler, thereby allowing the user to customize the processing, if they choose to do so.
<p>
Any number of advanced callback handlers maybe installed.<p>
The methods in the advanced callback interface represent Xerces-C extensions. There is no specification for this interface.<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>toInstall</em>&nbsp;</td><td>A pointer to the users advanced callback handler.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#46885254749d80ef2dfb19ad8d48e1e0" title="This method removes the &#39;advanced&#39; document handler callback from the underlying...">removeAdvDocHandler</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="46885254749d80ef2dfb19ad8d48e1e0"></a><!-- doxytag: member="SAX2XMLReader::removeAdvDocHandler" ref="46885254749d80ef2dfb19ad8d48e1e0" args="(XMLDocumentHandler *const toRemove)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SAX2XMLReader::removeAdvDocHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXMLDocumentHandler.html">XMLDocumentHandler</a> *const &nbsp;</td>
<td class="paramname"> <em>toRemove</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method removes the 'advanced' document handler callback from the underlying parser scanner.
<p>
If no handler is installed, advanced callbacks are not invoked by the scanner. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toRemove</em>&nbsp;</td><td>A pointer to the advanced callback handler which should be removed.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#5235f668aea5d4a799258338d01d7636" title="This method installs the specified &#39;advanced&#39; document callback handler,...">installAdvDocHandler</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SAX2XMLReader_8hpp-source.html">SAX2XMLReader.hpp</a></ul>
</FONT></TD></TR></TABLE><BR>
</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>
Copyright &copy; 1994-2004 The Apache Software Foundation.
All Rights Reserved.
</I></FONT></TD></TR></TABLE></BODY></HTML>