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

Revision 358, 80.7 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>DOMBuilder class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>DOMBuilder  Class Reference</h1>DOMBuilder provides an API for parsing XML documents and building the corresponding DOM document tree.
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMBuilder-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
48<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
49<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
50<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z9_0">ActionType</a> { <a class="el" href="classDOMBuilder.html#z9_0s0">ACTION_REPLACE</a> =  1,
51<a class="el" href="classDOMBuilder.html#z9_0s1">ACTION_APPEND_AS_CHILDREN</a> =  2,
52<a class="el" href="classDOMBuilder.html#z9_0s2">ACTION_INSERT_AFTER</a> =  3,
53<a class="el" href="classDOMBuilder.html#z9_0s3">ACTION_INSERT_BEFORE</a> =  4
54 }</td></tr>
55<tr><td>&nbsp;</td><td><font size=-1><em>Action types for use in parseWithContext.</em> <a href="#z9_0">More...</a><em></em></font><br><br></td></tr>
56<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
57<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
58<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z8_0">~DOMBuilder</a> ()</td></tr>
59<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z8_0">More...</a><em></em></font><br><br></td></tr>
60<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
61<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMErrorHandler.html">DOMErrorHandler</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_0">getErrorHandler</a> ()=0</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Get a pointer to the error handler.</em> <a href="#z10_0">More...</a><em></em></font><br><br></td></tr>
63<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classDOMErrorHandler.html">DOMErrorHandler</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_1">getErrorHandler</a> () const=0</td></tr>
64<tr><td>&nbsp;</td><td><font size=-1><em>Get a const pointer to the error handler.</em> <a href="#z10_1">More...</a><em></em></font><br><br></td></tr>
65<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMEntityResolver.html">DOMEntityResolver</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_2">getEntityResolver</a> ()=0</td></tr>
66<tr><td>&nbsp;</td><td><font size=-1><em>Get a pointer to the entity resolver.</em> <a href="#z10_2">More...</a><em></em></font><br><br></td></tr>
67<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classDOMEntityResolver.html">DOMEntityResolver</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_3">getEntityResolver</a> () const=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>Get a const pointer to the entity resolver.</em> <a href="#z10_3">More...</a><em></em></font><br><br></td></tr>
69<tr><td nowrap align=right valign=top>virtual DOMBuilderFilter *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_4">getFilter</a> ()=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Get a pointer to the application filter.</em> <a href="#z10_4">More...</a><em></em></font><br><br></td></tr>
71<tr><td nowrap align=right valign=top>virtual const DOMBuilderFilter *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_5">getFilter</a> () const=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Get a const pointer to the application filter.</em> <a href="#z10_5">More...</a><em></em></font><br><br></td></tr>
73<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_6">setErrorHandler</a> (<a class="el" href="classDOMErrorHandler.html">DOMErrorHandler</a> *const handler)=0</td></tr>
74<tr><td>&nbsp;</td><td><font size=-1><em>Set the error handler.</em> <a href="#z10_6">More...</a><em></em></font><br><br></td></tr>
75<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_7">setEntityResolver</a> (<a class="el" href="classDOMEntityResolver.html">DOMEntityResolver</a> *const handler)=0</td></tr>
76<tr><td>&nbsp;</td><td><font size=-1><em>Set the entity resolver.</em> <a href="#z10_7">More...</a><em></em></font><br><br></td></tr>
77<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_8">setFilter</a> (DOMBuilderFilter *const filter)=0</td></tr>
78<tr><td>&nbsp;</td><td><font size=-1><em>Set the application filter.</em> <a href="#z10_8">More...</a><em></em></font><br><br></td></tr>
79<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_9">setFeature</a> (const XMLCh *const name, const bool state)=0</td></tr>
80<tr><td>&nbsp;</td><td><font size=-1><em>Set the state of a feature.</em> <a href="#z10_9">More...</a><em></em></font><br><br></td></tr>
81<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_10">getFeature</a> (const XMLCh *const name) const=0</td></tr>
82<tr><td>&nbsp;</td><td><font size=-1><em>Look up the value of a feature.</em> <a href="#z10_10">More...</a><em></em></font><br><br></td></tr>
83<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_11">canSetFeature</a> (const XMLCh *const name, const bool state) const=0</td></tr>
84<tr><td>&nbsp;</td><td><font size=-1><em>Query whether setting a feature to a specific value is supported.</em> <a href="#z10_11">More...</a><em></em></font><br><br></td></tr>
85<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMDocument.html">DOMDocument</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_12">parse</a> (const <a class="el" href="classDOMInputSource.html">DOMInputSource</a> &amp;source)=0</td></tr>
86<tr><td>&nbsp;</td><td><font size=-1><em>Parse via an input source object.</em> <a href="#z10_12">More...</a><em></em></font><br><br></td></tr>
87<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMDocument.html">DOMDocument</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_13">parseURI</a> (const XMLCh *const systemId)=0</td></tr>
88<tr><td>&nbsp;</td><td><font size=-1><em>Parse via a file path or URL.</em> <a href="#z10_13">More...</a><em></em></font><br><br></td></tr>
89<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMDocument.html">DOMDocument</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_14">parseURI</a> (const char *const systemId)=0</td></tr>
90<tr><td>&nbsp;</td><td><font size=-1><em>Parse via a file path or URL (in the local code page).</em> <a href="#z10_14">More...</a><em></em></font><br><br></td></tr>
91<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z10_15">parseWithContext</a> (const <a class="el" href="classDOMInputSource.html">DOMInputSource</a> &amp;source, <a class="el" href="classDOMNode.html">DOMNode</a> *const contextNode, const short action)=0</td></tr>
92<tr><td>&nbsp;</td><td><font size=-1><em>Parse via an input source object.</em> <a href="#z10_15">More...</a><em></em></font><br><br></td></tr>
93<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
94<tr><td nowrap align=right valign=top>virtual void *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_0">getProperty</a> (const XMLCh *const name) const=0</td></tr>
95<tr><td>&nbsp;</td><td><font size=-1><em>Query the current value of a property in a DOMBuilder.</em> <a href="#z11_0">More...</a><em></em></font><br><br></td></tr>
96<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_1">setProperty</a> (const XMLCh *const name, void *value)=0</td></tr>
97<tr><td>&nbsp;</td><td><font size=-1><em>Set the value of any property in a DOMBuilder.</em> <a href="#z11_1">More...</a><em></em></font><br><br></td></tr>
98<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_2">release</a> ()=0</td></tr>
99<tr><td>&nbsp;</td><td><font size=-1><em>Called to indicate that this DOMBuilder is no longer in use and that the implementation may relinquish any resources associated with it.</em> <a href="#z11_2">More...</a><em></em></font><br><br></td></tr>
100<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_3">resetDocumentPool</a> ()=0</td></tr>
101<tr><td>&nbsp;</td><td><font size=-1><em>Reset the documents vector pool and release all the associated memory back to the system.</em> <a href="#z11_3">More...</a><em></em></font><br><br></td></tr>
102<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_4">loadGrammar</a> (const <a class="el" href="classDOMInputSource.html">DOMInputSource</a> &amp;source, const short grammarType, const bool toCache=false)=0</td></tr>
103<tr><td>&nbsp;</td><td><font size=-1><em>Preparse schema grammar (XML Schema, DTD, etc.) via an input source object.</em> <a href="#z11_4">More...</a><em></em></font><br><br></td></tr>
104<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_5">loadGrammar</a> (const XMLCh *const systemId, const short grammarType, const bool toCache=false)=0</td></tr>
105<tr><td>&nbsp;</td><td><font size=-1><em>Preparse schema grammar (XML Schema, DTD, etc.) via a file path or URL.</em> <a href="#z11_5">More...</a><em></em></font><br><br></td></tr>
106<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_6">loadGrammar</a> (const char *const systemId, const short grammarType, const bool toCache=false)=0</td></tr>
107<tr><td>&nbsp;</td><td><font size=-1><em>Preparse schema grammar (XML Schema, DTD, etc.) via a file path or URL.</em> <a href="#z11_6">More...</a><em></em></font><br><br></td></tr>
108<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_7">getGrammar</a> (const XMLCh *const nameSpaceKey) const=0</td></tr>
109<tr><td>&nbsp;</td><td><font size=-1><em>Retrieve the grammar that is associated with the specified namespace key.</em> <a href="#z11_7">More...</a><em></em></font><br><br></td></tr>
110<tr><td nowrap align=right valign=top>virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_8">getRootGrammar</a> () const=0</td></tr>
111<tr><td>&nbsp;</td><td><font size=-1><em>Retrieve the grammar where the root element is declared.</em> <a href="#z11_8">More...</a><em></em></font><br><br></td></tr>
112<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_9">getURIText</a> (unsigned int uriId) const=0</td></tr>
113<tr><td>&nbsp;</td><td><font size=-1><em>Returns the string corresponding to a URI id from the URI string pool.</em> <a href="#z11_9">More...</a><em></em></font><br><br></td></tr>
114<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_10">resetCachedGrammarPool</a> ()=0</td></tr>
115<tr><td>&nbsp;</td><td><font size=-1><em>Clear the cached grammar pool.</em> <a href="#z11_10">More...</a><em></em></font><br><br></td></tr>
116<tr><td nowrap align=right valign=top>virtual unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z11_11">getSrcOffset</a> () const=0</td></tr>
117<tr><td>&nbsp;</td><td><font size=-1><em>Returns the current src offset within the input source.</em> <a href="#z11_11">More...</a><em></em></font><br><br></td></tr>
118<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
119<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
120<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMBuilder.html#z6_0">DOMBuilder</a> ()</td></tr>
121</table>
122<hr><a name="_details"></a><h2>Detailed Description</h2>
123DOMBuilder provides an API for parsing XML documents and building the corresponding DOM document tree.
124<p>
125A DOMBuilder instance is obtained from the <a class="el" href="classDOMImplementationLS.html">DOMImplementationLS</a> interface by invoking its createDOMBuilder method. This implementation also allows the applications to install an error and an entity handler (useful extensions to the DOM specification).
126<p>
127<dl compact><dt><b>
128Since: </b><dd>
129DOM Level 3 </dl>
130<p>
131<hr><h2>Member Enumeration Documentation</h2>
132<a name="z9_0" doxytag="DOMBuilder::ActionType"></a><p>
133<table width="100%" cellpadding="2" cellspacing="0" border="0">
134  <tr>
135    <td class="md">
136      <table cellpadding="0" cellspacing="0" border="0">
137        <tr>
138          <td class="md" nowrap valign="top"> enum DOMBuilder::ActionType
139      </table>
140    </td>
141  </tr>
142</table>
143<table cellspacing=5 cellpadding=0 border=0>
144  <tr>
145    <td>
146      &nbsp;
147    </td>
148    <td>
149
150<p>
151Action types for use in parseWithContext.
152<p>
153
154<p>
155 <code>ACTION_REPLACE</code>: Replace the context node with the result of parsing the input source. For this action to work the context node must be an <code><a class="el" href="classDOMElement.html">DOMElement</a></code>, <code><a class="el" href="classDOMText.html">DOMText</a></code>, <code><a class="el" href="classDOMCDATASection.html">DOMCDATASection</a></code>, <code><a class="el" href="classDOMComment.html">DOMComment</a></code>, <code><a class="el" href="classDOMProcessingInstruction.html">DOMProcessingInstruction</a></code>, or <code><a class="el" href="classDOMEntityReference.html">DOMEntityReference</a></code> node.
156<p>
157
158<p>
159 <code>ACTION_APPEND</code>: Append the result of parsing the input source to the context node. For this action to work, the context node must be an <code><a class="el" href="classDOMElement.html">DOMElement</a></code>.
160<p>
161
162<p>
163 <code>ACTION_INSERT_AFTER</code>: Insert the result of parsing the input source after the context node. For this action to work the context nodes parent must be an <code><a class="el" href="classDOMElement.html">DOMElement</a></code>.
164<p>
165
166<p>
167 <code>ACTION_INSERT_BEFORE</code>: Insert the result of parsing the input source before the context node. For this action to work the context nodes parent must be an <code><a class="el" href="classDOMElement.html">DOMElement</a></code>.
168<p>
169<dl compact><dt><b>
170See also: </b><dd>
171<a class="el" href="classDOMBuilder.html#z10_15">parseWithContext</a>(...) </dl><dl compact><dt><b>
172Since: </b><dd>
173DOM Level 3 </dl><dl compact><dt><b>
174Enumeration values:</b><dd>
175<table border=0 cellspacing=2 cellpadding=0>
176<tr><td valign=top><em><a name="z9_0s0" doxytag="ACTION_REPLACE"></a><em>ACTION_REPLACE</em></em>&nbsp;</td><td>
177</td></tr>
178<tr><td valign=top><em><a name="z9_0s1" doxytag="ACTION_APPEND_AS_CHILDREN"></a><em>ACTION_APPEND_AS_CHILDREN</em></em>&nbsp;</td><td>
179</td></tr>
180<tr><td valign=top><em><a name="z9_0s2" doxytag="ACTION_INSERT_AFTER"></a><em>ACTION_INSERT_AFTER</em></em>&nbsp;</td><td>
181</td></tr>
182<tr><td valign=top><em><a name="z9_0s3" doxytag="ACTION_INSERT_BEFORE"></a><em>ACTION_INSERT_BEFORE</em></em>&nbsp;</td><td>
183</td></tr>
184</table>
185</dl>
186    </td>
187  </tr>
188</table>
189<hr><h2>Constructor &amp; Destructor Documentation</h2>
190<a name="z6_0" doxytag="DOMBuilder::DOMBuilder"></a><p>
191<table width="100%" cellpadding="2" cellspacing="0" border="0">
192  <tr>
193    <td class="md">
194      <table cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td class="md" nowrap valign="top"> DOMBuilder::DOMBuilder </td>
197          <td class="md" valign="top">(&nbsp;</td>
198          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
199          <td class="md" valign="top">)&nbsp;</td>
200          <td class="md" nowrap><code> [protected]</code></td>
201        </tr>
202
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing=5 cellpadding=0 border=0>
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215    </td>
216  </tr>
217</table>
218<a name="z8_0" doxytag="DOMBuilder::~DOMBuilder"></a><p>
219<table width="100%" cellpadding="2" cellspacing="0" border="0">
220  <tr>
221    <td class="md">
222      <table cellpadding="0" cellspacing="0" border="0">
223        <tr>
224          <td class="md" nowrap valign="top"> virtual DOMBuilder::~DOMBuilder </td>
225          <td class="md" valign="top">(&nbsp;</td>
226          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
227          <td class="md" valign="top">)&nbsp;</td>
228          <td class="md" nowrap><code> [virtual]</code></td>
229        </tr>
230
231      </table>
232    </td>
233  </tr>
234</table>
235<table cellspacing=5 cellpadding=0 border=0>
236  <tr>
237    <td>
238      &nbsp;
239    </td>
240    <td>
241
242<p>
243Destructor.
244<p>
245    </td>
246  </tr>
247</table>
248<hr><h2>Member Function Documentation</h2>
249<a name="z10_11" doxytag="DOMBuilder::canSetFeature"></a><p>
250<table width="100%" cellpadding="2" cellspacing="0" border="0">
251  <tr>
252    <td class="md">
253      <table cellpadding="0" cellspacing="0" border="0">
254        <tr>
255          <td class="md" nowrap valign="top"> virtual bool DOMBuilder::canSetFeature </td>
256          <td class="md" valign="top">(&nbsp;</td>
257          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
258          <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
259        </tr>
260        <tr>
261          <td></td>
262          <td></td>
263          <td class="md" nowrap>const bool&nbsp;</td>
264          <td class="mdname" nowrap>&nbsp; <em>state</em></td>
265        </tr>
266        <tr>
267          <td></td>
268          <td class="md">)&nbsp;</td>
269          <td class="md" colspan="2"> const<code> [pure virtual]</code></td>
270        </tr>
271
272      </table>
273    </td>
274  </tr>
275</table>
276<table cellspacing=5 cellpadding=0 border=0>
277  <tr>
278    <td>
279      &nbsp;
280    </td>
281    <td>
282
283<p>
284Query whether setting a feature to a specific value is supported.
285<p>
286
287<p>
288<b>"Experimental - subject to change"</b><dl compact><dt><b>
289Parameters: </b><dd>
290<table border=0 cellspacing=2 cellpadding=0>
291<tr><td valign=top><em>name</em>&nbsp;</td><td>
292The feature name. </td></tr>
293<tr><td valign=top><em>state</em>&nbsp;</td><td>
294The requested state of the feature (true or false). </td></tr>
295</table>
296</dl><dl compact><dt><b>
297Returns: </b><dd>
298<code>true</code> if the feature could be successfully set to the specified value, or <code>false</code> if the feature is not recognized or the requested value is not supported. The value of the feature itself is not changed.</dl><dl compact><dt><b>
299See also: </b><dd>
300<a class="el" href="classDOMBuilder.html#z10_10">getFeature</a> , <a class="el" href="classDOMBuilder.html#z10_9">setFeature</a> </dl><dl compact><dt><b>
301Since: </b><dd>
302DOM Level 3 </dl>    </td>
303  </tr>
304</table>
305<a name="z10_3" doxytag="DOMBuilder::getEntityResolver"></a><p>
306<table width="100%" cellpadding="2" cellspacing="0" border="0">
307  <tr>
308    <td class="md">
309      <table cellpadding="0" cellspacing="0" border="0">
310        <tr>
311          <td class="md" nowrap valign="top"> virtual const <a class="el" href="classDOMEntityResolver.html">DOMEntityResolver</a>* DOMBuilder::getEntityResolver </td>
312          <td class="md" valign="top">(&nbsp;</td>
313          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
314          <td class="md" valign="top">)&nbsp;</td>
315          <td class="md" nowrap> const<code> [pure virtual]</code></td>
316        </tr>
317
318      </table>
319    </td>
320  </tr>
321</table>
322<table cellspacing=5 cellpadding=0 border=0>
323  <tr>
324    <td>
325      &nbsp;
326    </td>
327    <td>
328
329<p>
330Get a const pointer to the entity resolver.
331<p>
332This method returns the installed entity resolver. If no resolver has been installed, then it will be a zero pointer.
333<p>
334
335<p>
336<b>"Experimental - subject to change"</b>
337<p>
338<dl compact><dt><b>
339Returns: </b><dd>
340A const pointer to the installed entity resolver object. </dl><dl compact><dt><b>
341Since: </b><dd>
342DOM Level 3 </dl>    </td>
343  </tr>
344</table>
345<a name="z10_2" doxytag="DOMBuilder::getEntityResolver"></a><p>
346<table width="100%" cellpadding="2" cellspacing="0" border="0">
347  <tr>
348    <td class="md">
349      <table cellpadding="0" cellspacing="0" border="0">
350        <tr>
351          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMEntityResolver.html">DOMEntityResolver</a>* DOMBuilder::getEntityResolver </td>
352          <td class="md" valign="top">(&nbsp;</td>
353          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
354          <td class="md" valign="top">)&nbsp;</td>
355          <td class="md" nowrap><code> [pure virtual]</code></td>
356        </tr>
357
358      </table>
359    </td>
360  </tr>
361</table>
362<table cellspacing=5 cellpadding=0 border=0>
363  <tr>
364    <td>
365      &nbsp;
366    </td>
367    <td>
368
369<p>
370Get a pointer to the entity resolver.
371<p>
372This method returns the installed entity resolver. If no resolver has been installed, then it will be a zero pointer.
373<p>
374
375<p>
376<b>"Experimental - subject to change"</b>
377<p>
378<dl compact><dt><b>
379Returns: </b><dd>
380The pointer to the installed entity resolver object. </dl><dl compact><dt><b>
381Since: </b><dd>
382DOM Level 3 </dl>    </td>
383  </tr>
384</table>
385<a name="z10_1" doxytag="DOMBuilder::getErrorHandler"></a><p>
386<table width="100%" cellpadding="2" cellspacing="0" border="0">
387  <tr>
388    <td class="md">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top"> virtual const <a class="el" href="classDOMErrorHandler.html">DOMErrorHandler</a>* DOMBuilder::getErrorHandler </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
394          <td class="md" valign="top">)&nbsp;</td>
395          <td class="md" nowrap> const<code> [pure virtual]</code></td>
396        </tr>
397
398      </table>
399    </td>
400  </tr>
401</table>
402<table cellspacing=5 cellpadding=0 border=0>
403  <tr>
404    <td>
405      &nbsp;
406    </td>
407    <td>
408
409<p>
410Get a const pointer to the error handler.
411<p>
412This method returns the installed error handler. If no handler has been installed, then it will be a zero pointer.
413<p>
414
415<p>
416<b>"Experimental - subject to change"</b>
417<p>
418<dl compact><dt><b>
419Returns: </b><dd>
420A const pointer to the installed error handler object. </dl><dl compact><dt><b>
421Since: </b><dd>
422DOM Level 3 </dl>    </td>
423  </tr>
424</table>
425<a name="z10_0" doxytag="DOMBuilder::getErrorHandler"></a><p>
426<table width="100%" cellpadding="2" cellspacing="0" border="0">
427  <tr>
428    <td class="md">
429      <table cellpadding="0" cellspacing="0" border="0">
430        <tr>
431          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMErrorHandler.html">DOMErrorHandler</a>* DOMBuilder::getErrorHandler </td>
432          <td class="md" valign="top">(&nbsp;</td>
433          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
434          <td class="md" valign="top">)&nbsp;</td>
435          <td class="md" nowrap><code> [pure virtual]</code></td>
436        </tr>
437
438      </table>
439    </td>
440  </tr>
441</table>
442<table cellspacing=5 cellpadding=0 border=0>
443  <tr>
444    <td>
445      &nbsp;
446    </td>
447    <td>
448
449<p>
450Get a pointer to the error handler.
451<p>
452This method returns the installed error handler. If no handler has been installed, then it will be a zero pointer.
453<p>
454
455<p>
456<b>"Experimental - subject to change"</b>
457<p>
458<dl compact><dt><b>
459Returns: </b><dd>
460The pointer to the installed error handler object. </dl><dl compact><dt><b>
461Since: </b><dd>
462DOM Level 3 </dl>    </td>
463  </tr>
464</table>
465<a name="z10_10" doxytag="DOMBuilder::getFeature"></a><p>
466<table width="100%" cellpadding="2" cellspacing="0" border="0">
467  <tr>
468    <td class="md">
469      <table cellpadding="0" cellspacing="0" border="0">
470        <tr>
471          <td class="md" nowrap valign="top"> virtual bool DOMBuilder::getFeature </td>
472          <td class="md" valign="top">(&nbsp;</td>
473          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
474          <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
475          <td class="md" valign="top">)&nbsp;</td>
476          <td class="md" nowrap> const<code> [pure virtual]</code></td>
477        </tr>
478
479      </table>
480    </td>
481  </tr>
482</table>
483<table cellspacing=5 cellpadding=0 border=0>
484  <tr>
485    <td>
486      &nbsp;
487    </td>
488    <td>
489
490<p>
491Look up the value of a feature.
492<p>
493
494<p>
495<b>"Experimental - subject to change"</b><dl compact><dt><b>
496Parameters: </b><dd>
497<table border=0 cellspacing=2 cellpadding=0>
498<tr><td valign=top><em>name</em>&nbsp;</td><td>
499The feature name. </td></tr>
500</table>
501</dl><dl compact><dt><b>
502Returns: </b><dd>
503The current state of the feature (true or false) </dl><dl compact><dt><b>
504Exceptions: </b><dd>
505<table border=0 cellspacing=2 cellpadding=0>
506<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
507 NOT_FOUND_ERR: Raised when the DOMBuilder does not recognize the feature name.</td></tr>
508</table>
509</dl><dl compact><dt><b>
510See also: </b><dd>
511<a class="el" href="classDOMBuilder.html#z10_10">getFeature</a> , <a class="el" href="classDOMBuilder.html#z10_11">canSetFeature</a> </dl><dl compact><dt><b>
512Since: </b><dd>
513DOM Level 3 </dl>    </td>
514  </tr>
515</table>
516<a name="z10_5" doxytag="DOMBuilder::getFilter"></a><p>
517<table width="100%" cellpadding="2" cellspacing="0" border="0">
518  <tr>
519    <td class="md">
520      <table cellpadding="0" cellspacing="0" border="0">
521        <tr>
522          <td class="md" nowrap valign="top"> virtual const DOMBuilderFilter* DOMBuilder::getFilter </td>
523          <td class="md" valign="top">(&nbsp;</td>
524          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
525          <td class="md" valign="top">)&nbsp;</td>
526          <td class="md" nowrap> const<code> [pure virtual]</code></td>
527        </tr>
528
529      </table>
530    </td>
531  </tr>
532</table>
533<table cellspacing=5 cellpadding=0 border=0>
534  <tr>
535    <td>
536      &nbsp;
537    </td>
538    <td>
539
540<p>
541Get a const pointer to the application filter.
542<p>
543This method returns the installed application filter. If no filter has been installed, then it will be a zero pointer.
544<p>
545
546<p>
547<b>"Experimental - subject to change"</b>
548<p>
549<dl compact><dt><b>
550Returns: </b><dd>
551A const pointer to the installed application filter </dl><dl compact><dt><b>
552Since: </b><dd>
553DOM Level 3 </dl>    </td>
554  </tr>
555</table>
556<a name="z10_4" doxytag="DOMBuilder::getFilter"></a><p>
557<table width="100%" cellpadding="2" cellspacing="0" border="0">
558  <tr>
559    <td class="md">
560      <table cellpadding="0" cellspacing="0" border="0">
561        <tr>
562          <td class="md" nowrap valign="top"> virtual DOMBuilderFilter* DOMBuilder::getFilter </td>
563          <td class="md" valign="top">(&nbsp;</td>
564          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
565          <td class="md" valign="top">)&nbsp;</td>
566          <td class="md" nowrap><code> [pure virtual]</code></td>
567        </tr>
568
569      </table>
570    </td>
571  </tr>
572</table>
573<table cellspacing=5 cellpadding=0 border=0>
574  <tr>
575    <td>
576      &nbsp;
577    </td>
578    <td>
579
580<p>
581Get a pointer to the application filter.
582<p>
583This method returns the installed application filter. If no filter has been installed, then it will be a zero pointer.
584<p>
585
586<p>
587<b>"Experimental - subject to change"</b>
588<p>
589<dl compact><dt><b>
590Returns: </b><dd>
591The pointer to the installed application filter. </dl><dl compact><dt><b>
592Since: </b><dd>
593DOM Level 3 </dl>    </td>
594  </tr>
595</table>
596<a name="z11_7" doxytag="DOMBuilder::getGrammar"></a><p>
597<table width="100%" cellpadding="2" cellspacing="0" border="0">
598  <tr>
599    <td class="md">
600      <table cellpadding="0" cellspacing="0" border="0">
601        <tr>
602          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* DOMBuilder::getGrammar </td>
603          <td class="md" valign="top">(&nbsp;</td>
604          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
605          <td class="mdname1" valign="top" nowrap>&nbsp; <em>nameSpaceKey</em>          </td>
606          <td class="md" valign="top">)&nbsp;</td>
607          <td class="md" nowrap> const<code> [pure virtual]</code></td>
608        </tr>
609
610      </table>
611    </td>
612  </tr>
613</table>
614<table cellspacing=5 cellpadding=0 border=0>
615  <tr>
616    <td>
617      &nbsp;
618    </td>
619    <td>
620
621<p>
622Retrieve the grammar that is associated with the specified namespace key.
623<p>
624<dl compact><dt><b>
625Parameters: </b><dd>
626<table border=0 cellspacing=2 cellpadding=0>
627<tr><td valign=top><em>nameSpaceKey</em>&nbsp;</td><td>
628Namespace key </td></tr>
629</table>
630</dl><dl compact><dt><b>
631Returns: </b><dd>
632Grammar associated with the Namespace key. </dl>    </td>
633  </tr>
634</table>
635<a name="z11_0" doxytag="DOMBuilder::getProperty"></a><p>
636<table width="100%" cellpadding="2" cellspacing="0" border="0">
637  <tr>
638    <td class="md">
639      <table cellpadding="0" cellspacing="0" border="0">
640        <tr>
641          <td class="md" nowrap valign="top"> virtual void* DOMBuilder::getProperty </td>
642          <td class="md" valign="top">(&nbsp;</td>
643          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
644          <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
645          <td class="md" valign="top">)&nbsp;</td>
646          <td class="md" nowrap> const<code> [pure virtual]</code></td>
647        </tr>
648
649      </table>
650    </td>
651  </tr>
652</table>
653<table cellspacing=5 cellpadding=0 border=0>
654  <tr>
655    <td>
656      &nbsp;
657    </td>
658    <td>
659
660<p>
661Query the current value of a property in a DOMBuilder.
662<p>
663The builder owns the returned pointer. The memory allocated for the returned pointer will be destroyed when the builder is deleted.
664<p>
665To ensure assessiblity of the returned information after the builder 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://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties</a> to learn exactly what type of property value each property returns for replication.<dl compact><dt><b>
666Parameters: </b><dd>
667<table border=0 cellspacing=2 cellpadding=0>
668<tr><td valign=top><em>name</em>&nbsp;</td><td>
669The unique identifier (URI) of the property being set. </td></tr>
670</table>
671</dl><dl compact><dt><b>
672Returns: </b><dd>
673The 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. </dl><dl compact><dt><b>
674Exceptions: </b><dd>
675<table border=0 cellspacing=2 cellpadding=0>
676<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
677 <br>
678NOT_FOUND_ERR: Raised when the DOMBuilder does not recognize the requested property. </td></tr>
679</table>
680</dl>    </td>
681  </tr>
682</table>
683<a name="z11_8" doxytag="DOMBuilder::getRootGrammar"></a><p>
684<table width="100%" cellpadding="2" cellspacing="0" border="0">
685  <tr>
686    <td class="md">
687      <table cellpadding="0" cellspacing="0" border="0">
688        <tr>
689          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* DOMBuilder::getRootGrammar </td>
690          <td class="md" valign="top">(&nbsp;</td>
691          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
692          <td class="md" valign="top">)&nbsp;</td>
693          <td class="md" nowrap> const<code> [pure virtual]</code></td>
694        </tr>
695
696      </table>
697    </td>
698  </tr>
699</table>
700<table cellspacing=5 cellpadding=0 border=0>
701  <tr>
702    <td>
703      &nbsp;
704    </td>
705    <td>
706
707<p>
708Retrieve the grammar where the root element is declared.
709<p>
710<dl compact><dt><b>
711Returns: </b><dd>
712Grammar where root element declared </dl>    </td>
713  </tr>
714</table>
715<a name="z11_11" doxytag="DOMBuilder::getSrcOffset"></a><p>
716<table width="100%" cellpadding="2" cellspacing="0" border="0">
717  <tr>
718    <td class="md">
719      <table cellpadding="0" cellspacing="0" border="0">
720        <tr>
721          <td class="md" nowrap valign="top"> virtual unsigned int DOMBuilder::getSrcOffset </td>
722          <td class="md" valign="top">(&nbsp;</td>
723          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
724          <td class="md" valign="top">)&nbsp;</td>
725          <td class="md" nowrap> const<code> [pure virtual]</code></td>
726        </tr>
727
728      </table>
729    </td>
730  </tr>
731</table>
732<table cellspacing=5 cellpadding=0 border=0>
733  <tr>
734    <td>
735      &nbsp;
736    </td>
737    <td>
738
739<p>
740Returns the current src offset within the input source.
741<p>
742<dl compact><dt><b>
743Returns: </b><dd>
744offset within the input source </dl>    </td>
745  </tr>
746</table>
747<a name="z11_9" doxytag="DOMBuilder::getURIText"></a><p>
748<table width="100%" cellpadding="2" cellspacing="0" border="0">
749  <tr>
750    <td class="md">
751      <table cellpadding="0" cellspacing="0" border="0">
752        <tr>
753          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMBuilder::getURIText </td>
754          <td class="md" valign="top">(&nbsp;</td>
755          <td class="md" nowrap valign="top">unsigned int&nbsp;</td>
756          <td class="mdname1" valign="top" nowrap>&nbsp; <em>uriId</em>          </td>
757          <td class="md" valign="top">)&nbsp;</td>
758          <td class="md" nowrap> const<code> [pure virtual]</code></td>
759        </tr>
760
761      </table>
762    </td>
763  </tr>
764</table>
765<table cellspacing=5 cellpadding=0 border=0>
766  <tr>
767    <td>
768      &nbsp;
769    </td>
770    <td>
771
772<p>
773Returns the string corresponding to a URI id from the URI string pool.
774<p>
775<dl compact><dt><b>
776Parameters: </b><dd>
777<table border=0 cellspacing=2 cellpadding=0>
778<tr><td valign=top><em>uriId</em>&nbsp;</td><td>
779id of the string in the URI string pool. </td></tr>
780</table>
781</dl><dl compact><dt><b>
782Returns: </b><dd>
783URI string corresponding to the URI id. </dl>    </td>
784  </tr>
785</table>
786<a name="z11_6" doxytag="DOMBuilder::loadGrammar"></a><p>
787<table width="100%" cellpadding="2" cellspacing="0" border="0">
788  <tr>
789    <td class="md">
790      <table cellpadding="0" cellspacing="0" border="0">
791        <tr>
792          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* DOMBuilder::loadGrammar </td>
793          <td class="md" valign="top">(&nbsp;</td>
794          <td class="md" nowrap valign="top">const char *const&nbsp;</td>
795          <td class="mdname" nowrap>&nbsp; <em>systemId</em>, </td>
796        </tr>
797        <tr>
798          <td></td>
799          <td></td>
800          <td class="md" nowrap>const short&nbsp;</td>
801          <td class="mdname" nowrap>&nbsp; <em>grammarType</em>, </td>
802        </tr>
803        <tr>
804          <td></td>
805          <td></td>
806          <td class="md" nowrap>const bool&nbsp;</td>
807          <td class="mdname" nowrap>&nbsp; <em>toCache</em> = false</td>
808        </tr>
809        <tr>
810          <td></td>
811          <td class="md">)&nbsp;</td>
812          <td class="md" colspan="2"><code> [pure virtual]</code></td>
813        </tr>
814
815      </table>
816    </td>
817  </tr>
818</table>
819<table cellspacing=5 cellpadding=0 border=0>
820  <tr>
821    <td>
822      &nbsp;
823    </td>
824    <td>
825
826<p>
827Preparse schema grammar (XML Schema, DTD, etc.) via a file path or URL.
828<p>
829This 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.
830<p>
831
832<p>
833<b>"Experimental - subject to change"</b><dl compact><dt><b>
834Parameters: </b><dd>
835<table border=0 cellspacing=2 cellpadding=0>
836<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
837A const char pointer to a native string which contains the path to the XML grammar file to be preparsed. </td></tr>
838<tr><td valign=top><em>grammarType</em>&nbsp;</td><td>
839The grammar type (Schema or DTD). </td></tr>
840<tr><td valign=top><em>toCache</em>&nbsp;</td><td>
841If <code>true</code>, we cache the preparsed grammar, otherwise, no chaching. Default is <code>false</code>. </td></tr>
842</table>
843</dl><dl compact><dt><b>
844Returns: </b><dd>
845The preparsed schema grammar object (SchemaGrammar or DTDGrammar). That grammar object is owned by the parser.</dl><dl compact><dt><b>
846Exceptions: </b><dd>
847<table border=0 cellspacing=2 cellpadding=0>
848<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
849 Any SAX exception, possibly wrapping another exception. </td></tr>
850<tr><td valign=top><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>
851 An exception from the parser or client handler code. </td></tr>
852<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
853 A DOM exception as per DOM spec. </td></tr>
854</table>
855</dl>    </td>
856  </tr>
857</table>
858<a name="z11_5" doxytag="DOMBuilder::loadGrammar"></a><p>
859<table width="100%" cellpadding="2" cellspacing="0" border="0">
860  <tr>
861    <td class="md">
862      <table cellpadding="0" cellspacing="0" border="0">
863        <tr>
864          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* DOMBuilder::loadGrammar </td>
865          <td class="md" valign="top">(&nbsp;</td>
866          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
867          <td class="mdname" nowrap>&nbsp; <em>systemId</em>, </td>
868        </tr>
869        <tr>
870          <td></td>
871          <td></td>
872          <td class="md" nowrap>const short&nbsp;</td>
873          <td class="mdname" nowrap>&nbsp; <em>grammarType</em>, </td>
874        </tr>
875        <tr>
876          <td></td>
877          <td></td>
878          <td class="md" nowrap>const bool&nbsp;</td>
879          <td class="mdname" nowrap>&nbsp; <em>toCache</em> = false</td>
880        </tr>
881        <tr>
882          <td></td>
883          <td class="md">)&nbsp;</td>
884          <td class="md" colspan="2"><code> [pure virtual]</code></td>
885        </tr>
886
887      </table>
888    </td>
889  </tr>
890</table>
891<table cellspacing=5 cellpadding=0 border=0>
892  <tr>
893    <td>
894      &nbsp;
895    </td>
896    <td>
897
898<p>
899Preparse schema grammar (XML Schema, DTD, etc.) via a file path or URL.
900<p>
901This 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.
902<p>
903
904<p>
905<b>"Experimental - subject to change"</b><dl compact><dt><b>
906Parameters: </b><dd>
907<table border=0 cellspacing=2 cellpadding=0>
908<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
909A const XMLCh pointer to the Unicode string which contains the path to the XML grammar file to be preparsed. </td></tr>
910<tr><td valign=top><em>grammarType</em>&nbsp;</td><td>
911The grammar type (Schema or DTD). </td></tr>
912<tr><td valign=top><em>toCache</em>&nbsp;</td><td>
913If <code>true</code>, we cache the preparsed grammar, otherwise, no chaching. Default is <code>false</code>. </td></tr>
914</table>
915</dl><dl compact><dt><b>
916Returns: </b><dd>
917The preparsed schema grammar object (SchemaGrammar or DTDGrammar). That grammar object is owned by the parser.</dl><dl compact><dt><b>
918Exceptions: </b><dd>
919<table border=0 cellspacing=2 cellpadding=0>
920<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
921 Any SAX exception, possibly wrapping another exception. </td></tr>
922<tr><td valign=top><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>
923 An exception from the parser or client handler code. </td></tr>
924<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
925 A DOM exception as per DOM spec. </td></tr>
926</table>
927</dl>    </td>
928  </tr>
929</table>
930<a name="z11_4" doxytag="DOMBuilder::loadGrammar"></a><p>
931<table width="100%" cellpadding="2" cellspacing="0" border="0">
932  <tr>
933    <td class="md">
934      <table cellpadding="0" cellspacing="0" border="0">
935        <tr>
936          <td class="md" nowrap valign="top"> virtual <a class="el" href="XSModel_8hpp.html#a1">Grammar</a>* DOMBuilder::loadGrammar </td>
937          <td class="md" valign="top">(&nbsp;</td>
938          <td class="md" nowrap valign="top">const <a class="el" href="classDOMInputSource.html">DOMInputSource</a> &amp;&nbsp;</td>
939          <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
940        </tr>
941        <tr>
942          <td></td>
943          <td></td>
944          <td class="md" nowrap>const short&nbsp;</td>
945          <td class="mdname" nowrap>&nbsp; <em>grammarType</em>, </td>
946        </tr>
947        <tr>
948          <td></td>
949          <td></td>
950          <td class="md" nowrap>const bool&nbsp;</td>
951          <td class="mdname" nowrap>&nbsp; <em>toCache</em> = false</td>
952        </tr>
953        <tr>
954          <td></td>
955          <td class="md">)&nbsp;</td>
956          <td class="md" colspan="2"><code> [pure virtual]</code></td>
957        </tr>
958
959      </table>
960    </td>
961  </tr>
962</table>
963<table cellspacing=5 cellpadding=0 border=0>
964  <tr>
965    <td>
966      &nbsp;
967    </td>
968    <td>
969
970<p>
971Preparse schema grammar (XML Schema, DTD, etc.) via an input source object.
972<p>
973This method invokes the preparsing process on a schema grammar XML file specified by the <a class="el" href="classDOMInputSource.html">DOMInputSource</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.
974<p>
975
976<p>
977<b>"Experimental - subject to change"</b><dl compact><dt><b>
978Parameters: </b><dd>
979<table border=0 cellspacing=2 cellpadding=0>
980<tr><td valign=top><em>source</em>&nbsp;</td><td>
981A const reference to the <a class="el" href="classDOMInputSource.html">DOMInputSource</a> object which points to the schema grammar file to be preparsed. </td></tr>
982<tr><td valign=top><em>grammarType</em>&nbsp;</td><td>
983The grammar type (Schema or DTD). </td></tr>
984<tr><td valign=top><em>toCache</em>&nbsp;</td><td>
985If <code>true</code>, we cache the preparsed grammar, otherwise, no chaching. Default is <code>false</code>. </td></tr>
986</table>
987</dl><dl compact><dt><b>
988Returns: </b><dd>
989The preparsed schema grammar object (SchemaGrammar or DTDGrammar). That grammar object is owned by the parser.</dl><dl compact><dt><b>
990Exceptions: </b><dd>
991<table border=0 cellspacing=2 cellpadding=0>
992<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
993 Any SAX exception, possibly wrapping another exception. </td></tr>
994<tr><td valign=top><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>
995 An exception from the parser or client handler code. </td></tr>
996<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
997 A DOM exception as per DOM spec.</td></tr>
998</table>
999</dl><dl compact><dt><b>
1000See also: </b><dd>
1001<a class="el" href="classDOMInputSource.html#z95_0">DOMInputSource::DOMInputSource</a> </dl>    </td>
1002  </tr>
1003</table>
1004<a name="z10_12" doxytag="DOMBuilder::parse"></a><p>
1005<table width="100%" cellpadding="2" cellspacing="0" border="0">
1006  <tr>
1007    <td class="md">
1008      <table cellpadding="0" cellspacing="0" border="0">
1009        <tr>
1010          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMDocument.html">DOMDocument</a>* DOMBuilder::parse </td>
1011          <td class="md" valign="top">(&nbsp;</td>
1012          <td class="md" nowrap valign="top">const <a class="el" href="classDOMInputSource.html">DOMInputSource</a> &amp;&nbsp;</td>
1013          <td class="mdname1" valign="top" nowrap>&nbsp; <em>source</em>          </td>
1014          <td class="md" valign="top">)&nbsp;</td>
1015          <td class="md" nowrap><code> [pure virtual]</code></td>
1016        </tr>
1017
1018      </table>
1019    </td>
1020  </tr>
1021</table>
1022<table cellspacing=5 cellpadding=0 border=0>
1023  <tr>
1024    <td>
1025      &nbsp;
1026    </td>
1027    <td>
1028
1029<p>
1030Parse via an input source object.
1031<p>
1032This method invokes the parsing process on the XML file specified by the <a class="el" href="classDOMInputSource.html">DOMInputSource</a> parameter. This API is borrowed from the SAX <a class="el" href="classParser.html">Parser</a> interface.
1033<p>
1034The parser owns the returned <a class="el" href="classDOMDocument.html">DOMDocument</a>. It will be deleted when the parser is released.
1035<p>
1036
1037<p>
1038<b>"Experimental - subject to change"</b><dl compact><dt><b>
1039Parameters: </b><dd>
1040<table border=0 cellspacing=2 cellpadding=0>
1041<tr><td valign=top><em>source</em>&nbsp;</td><td>
1042A const reference to the <a class="el" href="classDOMInputSource.html">DOMInputSource</a> object which points to the XML file to be parsed. </td></tr>
1043</table>
1044</dl><dl compact><dt><b>
1045Returns: </b><dd>
1046If the DOMBuilder is a synchronous DOMBuilder the newly created and populated <a class="el" href="classDOMDocument.html">DOMDocument</a> is returned. If the DOMBuilder is asynchronous then <code>null</code> is returned since the document object is not yet parsed when this method returns. </dl><dl compact><dt><b>
1047Exceptions: </b><dd>
1048<table border=0 cellspacing=2 cellpadding=0>
1049<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
1050 Any SAX exception, possibly wrapping another exception. </td></tr>
1051<tr><td valign=top><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>
1052 An exception from the parser or client handler code. </td></tr>
1053<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
1054 A DOM exception as per DOM spec.</td></tr>
1055</table>
1056</dl><dl compact><dt><b>
1057See also: </b><dd>
1058<a class="el" href="classDOMInputSource.html#z95_0">DOMInputSource::DOMInputSource</a> , <a class="el" href="classDOMBuilder.html#z10_7">setEntityResolver</a> , <a class="el" href="classDOMBuilder.html#z10_6">setErrorHandler</a> , <a class="el" href="classDOMBuilder.html#z11_3">resetDocumentPool</a> </dl><dl compact><dt><b>
1059Since: </b><dd>
1060DOM Level 3 </dl>    </td>
1061  </tr>
1062</table>
1063<a name="z10_14" doxytag="DOMBuilder::parseURI"></a><p>
1064<table width="100%" cellpadding="2" cellspacing="0" border="0">
1065  <tr>
1066    <td class="md">
1067      <table cellpadding="0" cellspacing="0" border="0">
1068        <tr>
1069          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMDocument.html">DOMDocument</a>* DOMBuilder::parseURI </td>
1070          <td class="md" valign="top">(&nbsp;</td>
1071          <td class="md" nowrap valign="top">const char *const&nbsp;</td>
1072          <td class="mdname1" valign="top" nowrap>&nbsp; <em>systemId</em>          </td>
1073          <td class="md" valign="top">)&nbsp;</td>
1074          <td class="md" nowrap><code> [pure virtual]</code></td>
1075        </tr>
1076
1077      </table>
1078    </td>
1079  </tr>
1080</table>
1081<table cellspacing=5 cellpadding=0 border=0>
1082  <tr>
1083    <td>
1084      &nbsp;
1085    </td>
1086    <td>
1087
1088<p>
1089Parse via a file path or URL (in the local code page).
1090<p>
1091This method invokes the parsing process on the XML file specified by the native char* string parameter 'systemId'.
1092<p>
1093The parser owns the returned <a class="el" href="classDOMDocument.html">DOMDocument</a>. It will be deleted when the parser is released.
1094<p>
1095
1096<p>
1097<b>"Experimental - subject to change"</b><dl compact><dt><b>
1098Parameters: </b><dd>
1099<table border=0 cellspacing=2 cellpadding=0>
1100<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
1101A const char pointer to a native string which contains the path to the XML file to be parsed. </td></tr>
1102</table>
1103</dl><dl compact><dt><b>
1104Returns: </b><dd>
1105If the DOMBuilder is a synchronous DOMBuilder the newly created and populated <a class="el" href="classDOMDocument.html">DOMDocument</a> is returned. If the DOMBuilder is asynchronous then <code>null</code> is returned since the document object is not yet parsed when this method returns. </dl><dl compact><dt><b>
1106Exceptions: </b><dd>
1107<table border=0 cellspacing=2 cellpadding=0>
1108<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
1109 Any SAX exception, possibly wrapping another exception. </td></tr>
1110<tr><td valign=top><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>
1111 An exception from the parser or client handler code. </td></tr>
1112<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
1113 A DOM exception as per DOM spec.</td></tr>
1114</table>
1115</dl><dl compact><dt><b>
1116See also: </b><dd>
1117<a class="el" href="classDOMBuilder.html#z10_12">parse</a>(<a class="el" href="classDOMInputSource.html">DOMInputSource</a>,...) , <a class="el" href="classDOMBuilder.html#z11_3">resetDocumentPool</a> </dl>    </td>
1118  </tr>
1119</table>
1120<a name="z10_13" doxytag="DOMBuilder::parseURI"></a><p>
1121<table width="100%" cellpadding="2" cellspacing="0" border="0">
1122  <tr>
1123    <td class="md">
1124      <table cellpadding="0" cellspacing="0" border="0">
1125        <tr>
1126          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMDocument.html">DOMDocument</a>* DOMBuilder::parseURI </td>
1127          <td class="md" valign="top">(&nbsp;</td>
1128          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
1129          <td class="mdname1" valign="top" nowrap>&nbsp; <em>systemId</em>          </td>
1130          <td class="md" valign="top">)&nbsp;</td>
1131          <td class="md" nowrap><code> [pure virtual]</code></td>
1132        </tr>
1133
1134      </table>
1135    </td>
1136  </tr>
1137</table>
1138<table cellspacing=5 cellpadding=0 border=0>
1139  <tr>
1140    <td>
1141      &nbsp;
1142    </td>
1143    <td>
1144
1145<p>
1146Parse via a file path or URL.
1147<p>
1148This method invokes the parsing process on the XML file specified by the Unicode string parameter 'systemId'.
1149<p>
1150The parser owns the returned <a class="el" href="classDOMDocument.html">DOMDocument</a>. It will be deleted when the parser is released.
1151<p>
1152
1153<p>
1154<b>"Experimental - subject to change"</b><dl compact><dt><b>
1155Parameters: </b><dd>
1156<table border=0 cellspacing=2 cellpadding=0>
1157<tr><td valign=top><em>systemId</em>&nbsp;</td><td>
1158A const XMLCh pointer to the Unicode string which contains the path to the XML file to be parsed. </td></tr>
1159</table>
1160</dl><dl compact><dt><b>
1161Returns: </b><dd>
1162If the DOMBuilder is a synchronous DOMBuilder the newly created and populated <a class="el" href="classDOMDocument.html">DOMDocument</a> is returned. If the DOMBuilder is asynchronous then <code>null</code> is returned since the document object is not yet parsed when this method returns. </dl><dl compact><dt><b>
1163Exceptions: </b><dd>
1164<table border=0 cellspacing=2 cellpadding=0>
1165<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
1166 Any SAX exception, possibly wrapping another exception. </td></tr>
1167<tr><td valign=top><em><a class="el" href="classXMLException.html">XMLException</a></em>&nbsp;</td><td>
1168 An exception from the parser or client handler code. </td></tr>
1169<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
1170 A DOM exception as per DOM spec.</td></tr>
1171</table>
1172</dl><dl compact><dt><b>
1173See also: </b><dd>
1174<a class="el" href="classDOMBuilder.html#z10_12">parse</a>(<a class="el" href="classDOMInputSource.html">DOMInputSource</a>,...) , <a class="el" href="classDOMBuilder.html#z11_3">resetDocumentPool</a> </dl><dl compact><dt><b>
1175Since: </b><dd>
1176DOM Level 3 </dl>    </td>
1177  </tr>
1178</table>
1179<a name="z10_15" doxytag="DOMBuilder::parseWithContext"></a><p>
1180<table width="100%" cellpadding="2" cellspacing="0" border="0">
1181  <tr>
1182    <td class="md">
1183      <table cellpadding="0" cellspacing="0" border="0">
1184        <tr>
1185          <td class="md" nowrap valign="top"> virtual void DOMBuilder::parseWithContext </td>
1186          <td class="md" valign="top">(&nbsp;</td>
1187          <td class="md" nowrap valign="top">const <a class="el" href="classDOMInputSource.html">DOMInputSource</a> &amp;&nbsp;</td>
1188          <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
1189        </tr>
1190        <tr>
1191          <td></td>
1192          <td></td>
1193          <td class="md" nowrap><a class="el" href="classDOMNode.html">DOMNode</a> *const&nbsp;</td>
1194          <td class="mdname" nowrap>&nbsp; <em>contextNode</em>, </td>
1195        </tr>
1196        <tr>
1197          <td></td>
1198          <td></td>
1199          <td class="md" nowrap>const short&nbsp;</td>
1200          <td class="mdname" nowrap>&nbsp; <em>action</em></td>
1201        </tr>
1202        <tr>
1203          <td></td>
1204          <td class="md">)&nbsp;</td>
1205          <td class="md" colspan="2"><code> [pure virtual]</code></td>
1206        </tr>
1207
1208      </table>
1209    </td>
1210  </tr>
1211</table>
1212<table cellspacing=5 cellpadding=0 border=0>
1213  <tr>
1214    <td>
1215      &nbsp;
1216    </td>
1217    <td>
1218
1219<p>
1220Parse via an input source object.
1221<p>
1222This method invokes the parsing process on the XML file specified by the <a class="el" href="classDOMInputSource.html">DOMInputSource</a> parameter, and inserts the content into an existing document at the position specified with the contextNode and action arguments. When parsing the input stream the context node is used for resolving unbound namespace prefixes.
1223<p>
1224
1225<p>
1226<b>"Experimental - subject to change"</b><dl compact><dt><b>
1227Parameters: </b><dd>
1228<table border=0 cellspacing=2 cellpadding=0>
1229<tr><td valign=top><em>source</em>&nbsp;</td><td>
1230A const reference to the <a class="el" href="classDOMInputSource.html">DOMInputSource</a> object which points to the XML file to be parsed. </td></tr>
1231<tr><td valign=top><em>contextNode</em>&nbsp;</td><td>
1232The node that is used as the context for the data that is being parsed. This node must be a Document node, a DocumentFragment node, or a node of a type that is allowed as a child of an element, e.g. it can not be an attribute node. </td></tr>
1233<tr><td valign=top><em>action</em>&nbsp;</td><td>
1234This parameter describes which action should be taken between the new set of node being inserted and the existing children of the context node. </td></tr>
1235</table>
1236</dl><dl compact><dt><b>
1237Exceptions: </b><dd>
1238<table border=0 cellspacing=2 cellpadding=0>
1239<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
1240 NOT_SUPPORTED_ERR: Raised when the DOMBuilder doesn't support this method. <br>
1241NO_MODIFICATION_ALLOWED_ERR: Raised if the context node is readonly. </td></tr>
1242</table>
1243</dl><dl compact><dt><b>
1244Since: </b><dd>
1245DOM Level 3 </dl>    </td>
1246  </tr>
1247</table>
1248<a name="z11_2" doxytag="DOMBuilder::release"></a><p>
1249<table width="100%" cellpadding="2" cellspacing="0" border="0">
1250  <tr>
1251    <td class="md">
1252      <table cellpadding="0" cellspacing="0" border="0">
1253        <tr>
1254          <td class="md" nowrap valign="top"> virtual void DOMBuilder::release </td>
1255          <td class="md" valign="top">(&nbsp;</td>
1256          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
1257          <td class="md" valign="top">)&nbsp;</td>
1258          <td class="md" nowrap><code> [pure virtual]</code></td>
1259        </tr>
1260
1261      </table>
1262    </td>
1263  </tr>
1264</table>
1265<table cellspacing=5 cellpadding=0 border=0>
1266  <tr>
1267    <td>
1268      &nbsp;
1269    </td>
1270    <td>
1271
1272<p>
1273Called to indicate that this DOMBuilder is no longer in use and that the implementation may relinquish any resources associated with it.
1274<p>
1275Access to a released object will lead to unexpected result.     </td>
1276  </tr>
1277</table>
1278<a name="z11_10" doxytag="DOMBuilder::resetCachedGrammarPool"></a><p>
1279<table width="100%" cellpadding="2" cellspacing="0" border="0">
1280  <tr>
1281    <td class="md">
1282      <table cellpadding="0" cellspacing="0" border="0">
1283        <tr>
1284          <td class="md" nowrap valign="top"> virtual void DOMBuilder::resetCachedGrammarPool </td>
1285          <td class="md" valign="top">(&nbsp;</td>
1286          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
1287          <td class="md" valign="top">)&nbsp;</td>
1288          <td class="md" nowrap><code> [pure virtual]</code></td>
1289        </tr>
1290
1291      </table>
1292    </td>
1293  </tr>
1294</table>
1295<table cellspacing=5 cellpadding=0 border=0>
1296  <tr>
1297    <td>
1298      &nbsp;
1299    </td>
1300    <td>
1301
1302<p>
1303Clear the cached grammar pool.
1304<p>
1305    </td>
1306  </tr>
1307</table>
1308<a name="z11_3" doxytag="DOMBuilder::resetDocumentPool"></a><p>
1309<table width="100%" cellpadding="2" cellspacing="0" border="0">
1310  <tr>
1311    <td class="md">
1312      <table cellpadding="0" cellspacing="0" border="0">
1313        <tr>
1314          <td class="md" nowrap valign="top"> virtual void DOMBuilder::resetDocumentPool </td>
1315          <td class="md" valign="top">(&nbsp;</td>
1316          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
1317          <td class="md" valign="top">)&nbsp;</td>
1318          <td class="md" nowrap><code> [pure virtual]</code></td>
1319        </tr>
1320
1321      </table>
1322    </td>
1323  </tr>
1324</table>
1325<table cellspacing=5 cellpadding=0 border=0>
1326  <tr>
1327    <td>
1328      &nbsp;
1329    </td>
1330    <td>
1331
1332<p>
1333Reset the documents vector pool and release all the associated memory back to the system.
1334<p>
1335When parsing a document using a DOM parser, all memory allocated for a DOM tree is associated to the DOM document.
1336<p>
1337If you do multiple parse using the same DOM parser instance, then multiple DOM documents will be generated and saved in a vector pool. All these documents (and thus all the allocated memory) won't be deleted until the parser instance is destroyed.
1338<p>
1339If you don't need these DOM documents anymore and don't want to destroy the DOM parser instance at this moment, then you can call this method to reset the document vector pool and release all the allocated memory back to the system.
1340<p>
1341It is an error to call this method if you are in the middle of a parse (e.g. in the mid of a progressive parse).<dl compact><dt><b>
1342Exceptions: </b><dd>
1343<table border=0 cellspacing=2 cellpadding=0>
1344<tr><td valign=top><em>IOException</em>&nbsp;</td><td>
1345 An exception from the parser if this function is called when a parse is in progress. </td></tr>
1346</table>
1347</dl>    </td>
1348  </tr>
1349</table>
1350<a name="z10_7" doxytag="DOMBuilder::setEntityResolver"></a><p>
1351<table width="100%" cellpadding="2" cellspacing="0" border="0">
1352  <tr>
1353    <td class="md">
1354      <table cellpadding="0" cellspacing="0" border="0">
1355        <tr>
1356          <td class="md" nowrap valign="top"> virtual void DOMBuilder::setEntityResolver </td>
1357          <td class="md" valign="top">(&nbsp;</td>
1358          <td class="md" nowrap valign="top"><a class="el" href="classDOMEntityResolver.html">DOMEntityResolver</a> *const&nbsp;</td>
1359          <td class="mdname1" valign="top" nowrap>&nbsp; <em>handler</em>          </td>
1360          <td class="md" valign="top">)&nbsp;</td>
1361          <td class="md" nowrap><code> [pure virtual]</code></td>
1362        </tr>
1363
1364      </table>
1365    </td>
1366  </tr>
1367</table>
1368<table cellspacing=5 cellpadding=0 border=0>
1369  <tr>
1370    <td>
1371      &nbsp;
1372    </td>
1373    <td>
1374
1375<p>
1376Set the entity resolver.
1377<p>
1378This method allows applications to install their own entity resolver. By installing an entity resolver, the applications can trap and potentially redirect references to external entities.
1379<p>
1380<em>Any previously set resolver is merely dropped, since the parser does not own them.</em>
1381<p>
1382
1383<p>
1384<b>"Experimental - subject to change"</b><dl compact><dt><b>
1385Parameters: </b><dd>
1386<table border=0 cellspacing=2 cellpadding=0>
1387<tr><td valign=top><em>handler</em>&nbsp;</td><td>
1388A const pointer to the user supplied entity resolver.</td></tr>
1389</table>
1390</dl><dl compact><dt><b>
1391See also: </b><dd>
1392<a class="el" href="classDOMBuilder.html#z10_2">getEntityResolver</a> </dl><dl compact><dt><b>
1393Since: </b><dd>
1394DOM Level 3 </dl>    </td>
1395  </tr>
1396</table>
1397<a name="z10_6" doxytag="DOMBuilder::setErrorHandler"></a><p>
1398<table width="100%" cellpadding="2" cellspacing="0" border="0">
1399  <tr>
1400    <td class="md">
1401      <table cellpadding="0" cellspacing="0" border="0">
1402        <tr>
1403          <td class="md" nowrap valign="top"> virtual void DOMBuilder::setErrorHandler </td>
1404          <td class="md" valign="top">(&nbsp;</td>
1405          <td class="md" nowrap valign="top"><a class="el" href="classDOMErrorHandler.html">DOMErrorHandler</a> *const&nbsp;</td>
1406          <td class="mdname1" valign="top" nowrap>&nbsp; <em>handler</em>          </td>
1407          <td class="md" valign="top">)&nbsp;</td>
1408          <td class="md" nowrap><code> [pure virtual]</code></td>
1409        </tr>
1410
1411      </table>
1412    </td>
1413  </tr>
1414</table>
1415<table cellspacing=5 cellpadding=0 border=0>
1416  <tr>
1417    <td>
1418      &nbsp;
1419    </td>
1420    <td>
1421
1422<p>
1423Set the error handler.
1424<p>
1425This method allows applications to install their own error handler to trap error and warning messages.
1426<p>
1427<em>Any previously set handler is merely dropped, since the parser does not own them.</em>
1428<p>
1429
1430<p>
1431<b>"Experimental - subject to change"</b><dl compact><dt><b>
1432Parameters: </b><dd>
1433<table border=0 cellspacing=2 cellpadding=0>
1434<tr><td valign=top><em>handler</em>&nbsp;</td><td>
1435A const pointer to the user supplied error handler.</td></tr>
1436</table>
1437</dl><dl compact><dt><b>
1438See also: </b><dd>
1439<a class="el" href="classDOMBuilder.html#z10_0">getErrorHandler</a> </dl><dl compact><dt><b>
1440Since: </b><dd>
1441DOM Level 3 </dl>    </td>
1442  </tr>
1443</table>
1444<a name="z10_9" doxytag="DOMBuilder::setFeature"></a><p>
1445<table width="100%" cellpadding="2" cellspacing="0" border="0">
1446  <tr>
1447    <td class="md">
1448      <table cellpadding="0" cellspacing="0" border="0">
1449        <tr>
1450          <td class="md" nowrap valign="top"> virtual void DOMBuilder::setFeature </td>
1451          <td class="md" valign="top">(&nbsp;</td>
1452          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
1453          <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
1454        </tr>
1455        <tr>
1456          <td></td>
1457          <td></td>
1458          <td class="md" nowrap>const bool&nbsp;</td>
1459          <td class="mdname" nowrap>&nbsp; <em>state</em></td>
1460        </tr>
1461        <tr>
1462          <td></td>
1463          <td class="md">)&nbsp;</td>
1464          <td class="md" colspan="2"><code> [pure virtual]</code></td>
1465        </tr>
1466
1467      </table>
1468    </td>
1469  </tr>
1470</table>
1471<table cellspacing=5 cellpadding=0 border=0>
1472  <tr>
1473    <td>
1474      &nbsp;
1475    </td>
1476    <td>
1477
1478<p>
1479Set the state of a feature.
1480<p>
1481It is possible for a DOMBuilder to recognize a feature name but to be unable to set its value.
1482<p>
1483
1484<p>
1485<b>"Experimental - subject to change"</b>
1486<p>
1487See <a href="http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures">http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures</a> for the list of supported features.<dl compact><dt><b>
1488Parameters: </b><dd>
1489<table border=0 cellspacing=2 cellpadding=0>
1490<tr><td valign=top><em>name</em>&nbsp;</td><td>
1491The feature name. </td></tr>
1492<tr><td valign=top><em>state</em>&nbsp;</td><td>
1493The requested state of the feature (true or false). </td></tr>
1494</table>
1495</dl><dl compact><dt><b>
1496Exceptions: </b><dd>
1497<table border=0 cellspacing=2 cellpadding=0>
1498<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
1499 NOT_SUPPORTED_ERR: Raised when the DOMBuilder recognizes the feature name but cannot set the requested value. <br>
1500NOT_FOUND_ERR: Raised when the DOMBuilder does not recognize the feature name.</td></tr>
1501</table>
1502</dl><dl compact><dt><b>
1503See also: </b><dd>
1504<a class="el" href="classDOMBuilder.html#z10_9">setFeature</a> , <a class="el" href="classDOMBuilder.html#z10_11">canSetFeature</a> </dl><dl compact><dt><b>
1505Since: </b><dd>
1506DOM Level 3 </dl>    </td>
1507  </tr>
1508</table>
1509<a name="z10_8" doxytag="DOMBuilder::setFilter"></a><p>
1510<table width="100%" cellpadding="2" cellspacing="0" border="0">
1511  <tr>
1512    <td class="md">
1513      <table cellpadding="0" cellspacing="0" border="0">
1514        <tr>
1515          <td class="md" nowrap valign="top"> virtual void DOMBuilder::setFilter </td>
1516          <td class="md" valign="top">(&nbsp;</td>
1517          <td class="md" nowrap valign="top">DOMBuilderFilter *const&nbsp;</td>
1518          <td class="mdname1" valign="top" nowrap>&nbsp; <em>filter</em>          </td>
1519          <td class="md" valign="top">)&nbsp;</td>
1520          <td class="md" nowrap><code> [pure virtual]</code></td>
1521        </tr>
1522
1523      </table>
1524    </td>
1525  </tr>
1526</table>
1527<table cellspacing=5 cellpadding=0 border=0>
1528  <tr>
1529    <td>
1530      &nbsp;
1531    </td>
1532    <td>
1533
1534<p>
1535Set the application filter.
1536<p>
1537When the application provides a filter, the parser will call out to the filter at the completion of the construction of each Element node. The filter implementation can choose to remove the element from the document being constructed (unless the element is the document element) or to terminate the parse early. If the document is being validated when it's loaded the validation happens before the filter is called.
1538<p>
1539<em>Any previously set filter is merely dropped, since the parser does not own them.</em>
1540<p>
1541
1542<p>
1543<b>"Experimental - subject to change"</b><dl compact><dt><b>
1544Parameters: </b><dd>
1545<table border=0 cellspacing=2 cellpadding=0>
1546<tr><td valign=top><em>filter</em>&nbsp;</td><td>
1547A const pointer to the user supplied application filter.</td></tr>
1548</table>
1549</dl><dl compact><dt><b>
1550See also: </b><dd>
1551<a class="el" href="classDOMBuilder.html#z10_4">getFilter</a> </dl><dl compact><dt><b>
1552Since: </b><dd>
1553DOM Level 3 </dl>    </td>
1554  </tr>
1555</table>
1556<a name="z11_1" doxytag="DOMBuilder::setProperty"></a><p>
1557<table width="100%" cellpadding="2" cellspacing="0" border="0">
1558  <tr>
1559    <td class="md">
1560      <table cellpadding="0" cellspacing="0" border="0">
1561        <tr>
1562          <td class="md" nowrap valign="top"> virtual void DOMBuilder::setProperty </td>
1563          <td class="md" valign="top">(&nbsp;</td>
1564          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
1565          <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
1566        </tr>
1567        <tr>
1568          <td></td>
1569          <td></td>
1570          <td class="md" nowrap>void *&nbsp;</td>
1571          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1572        </tr>
1573        <tr>
1574          <td></td>
1575          <td class="md">)&nbsp;</td>
1576          <td class="md" colspan="2"><code> [pure virtual]</code></td>
1577        </tr>
1578
1579      </table>
1580    </td>
1581  </tr>
1582</table>
1583<table cellspacing=5 cellpadding=0 border=0>
1584  <tr>
1585    <td>
1586      &nbsp;
1587    </td>
1588    <td>
1589
1590<p>
1591Set the value of any property in a DOMBuilder.
1592<p>
1593See <a href="http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties</a> for the list of supported properties.
1594<p>
1595It takes a void pointer as the property value. Application is required to initialize this void pointer to a correct type. See <a href="http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties</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.<dl compact><dt><b>
1596Parameters: </b><dd>
1597<table border=0 cellspacing=2 cellpadding=0>
1598<tr><td valign=top><em>name</em>&nbsp;</td><td>
1599The unique identifier (URI) of the property being set. </td></tr>
1600<tr><td valign=top><em>value</em>&nbsp;</td><td>
1601The requested value for the property. See <a href="http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderProperties</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>
1602</table>
1603</dl><dl compact><dt><b>
1604Exceptions: </b><dd>
1605<table border=0 cellspacing=2 cellpadding=0>
1606<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
1607 <br>
1608NOT_FOUND_ERR: Raised when the DOMBuilder does not recognize the requested property. </td></tr>
1609</table>
1610</dl>    </td>
1611  </tr>
1612</table>
1613<hr>The documentation for this class was generated from the following file:<ul>
1614<li><a class="el" href="DOMBuilder_8hpp-source.html">DOMBuilder.hpp</a></ul>
1615    </FONT></TD></TR></TABLE><BR>
1616</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>
1617              Copyright &copy; 1994-2004 The Apache Software Foundation.
1618              All Rights Reserved.
1619            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.