1230 lines
75 KiB
HTML
1230 lines
75 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>XQilla DOM3 API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.5.1 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul></div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul></div>
|
|
<div class="nav">
|
|
<a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a></div>
|
|
<h1>xercesc::DOMBuilder Class Reference</h1><!-- doxytag: class="xercesc::DOMBuilder" --><a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> provides an API for parsing XML documents and building the corresponding DOM document tree.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="DOMBuilder_8hpp-source.html">DOMBuilder.hpp</a>></code>
|
|
<p>
|
|
<a href="classxercesc_1_1DOMBuilder-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc6">ActionType</a> { <a class="el" href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc6183d80141cd7ab0c439c3e4b7af2aa3f">ACTION_REPLACE</a> = 1,
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc6898c7032a853550f72060685eebbbedb">ACTION_APPEND_AS_CHILDREN</a> = 2,
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc60296e60a5eb7909187a711d09d6a1c15">ACTION_INSERT_AFTER</a> = 3,
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc69c4dfd98557798b31ffb0b8afa4cd5e1">ACTION_INSERT_BEFORE</a> = 4
|
|
}</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Action types for use in parseWithContext. <a href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc6">More...</a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#df245ee7ae818e31daba8c25e1f460ae">getErrorHandler</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the error handler. <a href="#df245ee7ae818e31daba8c25e1f460ae"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#236600dd33baea6ae4ed45a2776b0df2">getErrorHandler</a> () const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a const pointer to the error handler. <a href="#236600dd33baea6ae4ed45a2776b0df2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#d74aa08f0ed0837c1109c46b422e4381">getEntityResolver</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the entity resolver. <a href="#d74aa08f0ed0837c1109c46b422e4381"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#979d91c9f7f5747d9dfa8394ac178ebf">getEntityResolver</a> () const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a const pointer to the entity resolver. <a href="#979d91c9f7f5747d9dfa8394ac178ebf"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual DOMBuilderFilter * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#689c0865e7f9b2a2d41bb3377ee2b823">getFilter</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the application filter. <a href="#689c0865e7f9b2a2d41bb3377ee2b823"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const DOMBuilderFilter * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#c1404c60969b4df0a6ae0ecbf116d69c">getFilter</a> () const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a const pointer to the application filter. <a href="#c1404c60969b4df0a6ae0ecbf116d69c"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#6d54cffceeffc6d37636a65b9f94cc9d">setErrorHandler</a> (<a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> *const handler)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error handler. <a href="#6d54cffceeffc6d37636a65b9f94cc9d"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#1d2c6058e5d3c02c6c66b0f8c39d9b7d">setEntityResolver</a> (<a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a> *const handler)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the entity resolver. <a href="#1d2c6058e5d3c02c6c66b0f8c39d9b7d"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#563c0aad9ee86319408fd246f1389bcd">setFilter</a> (DOMBuilderFilter *const filter)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the application filter. <a href="#563c0aad9ee86319408fd246f1389bcd"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#0ce20798491e011bf1b2a2440699b807">setFeature</a> (const XMLCh *const name, const bool state)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the state of a feature. <a href="#0ce20798491e011bf1b2a2440699b807"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#ca0f947d9c558b3d4c45ce9e1700dbad">getFeature</a> (const XMLCh *const name) const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Look up the value of a feature. <a href="#ca0f947d9c558b3d4c45ce9e1700dbad"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#7ec4f31c034159b1ce87a58ef8e429f6">canSetFeature</a> (const XMLCh *const name, const bool state) const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query whether setting a feature to a specific value is supported. <a href="#7ec4f31c034159b1ce87a58ef8e429f6"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#c29f5cc524ca1e294a455c9b5c86e138">parse</a> (const <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> &source)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse via an input source object. <a href="#c29f5cc524ca1e294a455c9b5c86e138"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#6f44d6e15b9d54f9ea0d13c48a0cb6e4">parseURI</a> (const XMLCh *const systemId)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse via a file path or URL. <a href="#6f44d6e15b9d54f9ea0d13c48a0cb6e4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#5bca735be382c22a5899be47e009d23d">parseURI</a> (const char *const systemId)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse via a file path or URL (in the local code page). <a href="#5bca735be382c22a5899be47e009d23d"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#3951d3fed1752230f76c8543a961eeb3">parseWithContext</a> (const <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> &source, <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *const contextNode, const short action)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse via an input source object. <a href="#3951d3fed1752230f76c8543a961eeb3"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#f18f8d95da01f5b494e4c6c7f0967d36">getProperty</a> (const XMLCh *const name) const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the current value of a property in a <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a>. <a href="#f18f8d95da01f5b494e4c6c7f0967d36"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#faf95c6b5df9cf20a5443222bb45941f">setProperty</a> (const XMLCh *const name, void *value)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of any property in a <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a>. <a href="#faf95c6b5df9cf20a5443222bb45941f"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#04330cf09a9c92278aef99e2645b7f9c">release</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that this <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#04330cf09a9c92278aef99e2645b7f9c"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#7a0929e36b3acb03873acbfb42262926">resetDocumentPool</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the documents vector pool and release all the associated memory back to the system. <a href="#7a0929e36b3acb03873acbfb42262926"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#024005d73c8756422c3cdd85baffb8a8">loadGrammar</a> (const <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> &source, const short grammarType, const bool toCache=false)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Preparse schema grammar (XML Schema, DTD, etc. <a href="#024005d73c8756422c3cdd85baffb8a8"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#25b1ddecff8768646b88af4822de1ea1">loadGrammar</a> (const XMLCh *const systemId, const short grammarType, const bool toCache=false)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Preparse schema grammar (XML Schema, DTD, etc. <a href="#25b1ddecff8768646b88af4822de1ea1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#274515eff86c728c0c6edf87f5689ae8">loadGrammar</a> (const char *const systemId, const short grammarType, const bool toCache=false)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Preparse schema grammar (XML Schema, DTD, etc. <a href="#274515eff86c728c0c6edf87f5689ae8"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#95c70a1822767a9d4e80198830c2db4d">getGrammar</a> (const XMLCh *const nameSpaceKey) const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the grammar that is associated with the specified namespace key. <a href="#95c70a1822767a9d4e80198830c2db4d"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Grammar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#8c2966d33830cfa3fc86e00ece14b30e">getRootGrammar</a> () const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the grammar where the root element is declared. <a href="#8c2966d33830cfa3fc86e00ece14b30e"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#ec9aedc1001f14f421dc16763b465867">getURIText</a> (unsigned int uriId) const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string corresponding to a URI id from the URI string pool. <a href="#ec9aedc1001f14f421dc16763b465867"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#9b6affd174edc8c7b503e781a27b1eb7">resetCachedGrammarPool</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the cached grammar pool. <a href="#9b6affd174edc8c7b503e781a27b1eb7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMBuilder.html#7f05e64b568d5bd285eea7c7e6ad4cd5">getSrcOffset</a> () const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current src offset within the input source. <a href="#7f05e64b568d5bd285eea7c7e6ad4cd5"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> provides an API for parsing XML documents and building the corresponding DOM document tree.
|
|
<p>
|
|
A <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> instance is obtained from the <a class="el" href="classxercesc_1_1DOMImplementationLS.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).<p>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
<p>
|
|
<hr><h2>Member Enumeration Documentation</h2>
|
|
<a class="anchor" name="e291bcc6e2a316a21aafab8555b6cbc6"></a><!-- doxytag: member="xercesc::DOMBuilder::ActionType" ref="e291bcc6e2a316a21aafab8555b6cbc6" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classxercesc_1_1DOMBuilder.html#e291bcc6e2a316a21aafab8555b6cbc6">xercesc::DOMBuilder::ActionType</a> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Action types for use in parseWithContext.
|
|
<p>
|
|
<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="classxercesc_1_1DOMElement.html">DOMElement</a></code>, <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code>, <code><a class="el" href="classxercesc_1_1DOMCDATASection.html">DOMCDATASection</a></code>, <code><a class="el" href="classxercesc_1_1DOMComment.html">DOMComment</a></code>, <code><a class="el" href="classxercesc_1_1DOMProcessingInstruction.html">DOMProcessingInstruction</a></code>, or <code><a class="el" href="classxercesc_1_1DOMEntityReference.html">DOMEntityReference</a></code> node.<p>
|
|
<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="classxercesc_1_1DOMElement.html">DOMElement</a></code>.<p>
|
|
<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="classxercesc_1_1DOMElement.html">DOMElement</a></code>.<p>
|
|
<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="classxercesc_1_1DOMElement.html">DOMElement</a></code>.<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#3951d3fed1752230f76c8543a961eeb3">parseWithContext</a>(...) </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </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="e291bcc6e2a316a21aafab8555b6cbc6183d80141cd7ab0c439c3e4b7af2aa3f"></a><!-- doxytag: member="ACTION_REPLACE" ref="e291bcc6e2a316a21aafab8555b6cbc6183d80141cd7ab0c439c3e4b7af2aa3f" args="" -->ACTION_REPLACE</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="e291bcc6e2a316a21aafab8555b6cbc6898c7032a853550f72060685eebbbedb"></a><!-- doxytag: member="ACTION_APPEND_AS_CHILDREN" ref="e291bcc6e2a316a21aafab8555b6cbc6898c7032a853550f72060685eebbbedb" args="" -->ACTION_APPEND_AS_CHILDREN</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="e291bcc6e2a316a21aafab8555b6cbc60296e60a5eb7909187a711d09d6a1c15"></a><!-- doxytag: member="ACTION_INSERT_AFTER" ref="e291bcc6e2a316a21aafab8555b6cbc60296e60a5eb7909187a711d09d6a1c15" args="" -->ACTION_INSERT_AFTER</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="e291bcc6e2a316a21aafab8555b6cbc69c4dfd98557798b31ffb0b8afa4cd5e1"></a><!-- doxytag: member="ACTION_INSERT_BEFORE" ref="e291bcc6e2a316a21aafab8555b6cbc69c4dfd98557798b31ffb0b8afa4cd5e1" args="" -->ACTION_INSERT_BEFORE</em> </td><td>
|
|
</td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="68d87a7d2ae0c206c7d743512b440192"></a><!-- doxytag: member="xercesc::DOMBuilder::DOMBuilder" ref="68d87a7d2ae0c206c7d743512b440192" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::DOMBuilder::DOMBuilder </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0d64d41e603c4fc6a6aa33c23b24fd5e"></a><!-- doxytag: member="xercesc::DOMBuilder::~DOMBuilder" ref="0d64d41e603c4fc6a6aa33c23b24fd5e" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::DOMBuilder::~DOMBuilder </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="68d87a7d2ae0c206c7d743512b440192"></a><!-- doxytag: member="xercesc::DOMBuilder::DOMBuilder" ref="68d87a7d2ae0c206c7d743512b440192" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::DOMBuilder::DOMBuilder </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0d64d41e603c4fc6a6aa33c23b24fd5e"></a><!-- doxytag: member="xercesc::DOMBuilder::~DOMBuilder" ref="0d64d41e603c4fc6a6aa33c23b24fd5e" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::DOMBuilder::~DOMBuilder </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="df245ee7ae818e31daba8c25e1f460ae"></a><!-- doxytag: member="xercesc::DOMBuilder::getErrorHandler" ref="df245ee7ae818e31daba8c25e1f460ae" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a>* xercesc::DOMBuilder::getErrorHandler </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get a pointer to the error handler.
|
|
<p>
|
|
This method returns the installed error handler. If no handler has been installed, then it will be a zero pointer.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer to the installed error handler object. </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="236600dd33baea6ae4ed45a2776b0df2"></a><!-- doxytag: member="xercesc::DOMBuilder::getErrorHandler" ref="236600dd33baea6ae4ed45a2776b0df2" args="() const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const <a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a>* xercesc::DOMBuilder::getErrorHandler </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get a const pointer to the error handler.
|
|
<p>
|
|
This method returns the installed error handler. If no handler has been installed, then it will be a zero pointer.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A const pointer to the installed error handler object. </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d74aa08f0ed0837c1109c46b422e4381"></a><!-- doxytag: member="xercesc::DOMBuilder::getEntityResolver" ref="d74aa08f0ed0837c1109c46b422e4381" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a>* xercesc::DOMBuilder::getEntityResolver </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get a pointer to the entity resolver.
|
|
<p>
|
|
This method returns the installed entity resolver. If no resolver has been installed, then it will be a zero pointer.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer to the installed entity resolver object. </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="979d91c9f7f5747d9dfa8394ac178ebf"></a><!-- doxytag: member="xercesc::DOMBuilder::getEntityResolver" ref="979d91c9f7f5747d9dfa8394ac178ebf" args="() const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const <a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a>* xercesc::DOMBuilder::getEntityResolver </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get a const pointer to the entity resolver.
|
|
<p>
|
|
This method returns the installed entity resolver. If no resolver has been installed, then it will be a zero pointer.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A const pointer to the installed entity resolver object. </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="689c0865e7f9b2a2d41bb3377ee2b823"></a><!-- doxytag: member="xercesc::DOMBuilder::getFilter" ref="689c0865e7f9b2a2d41bb3377ee2b823" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual DOMBuilderFilter* xercesc::DOMBuilder::getFilter </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get a pointer to the application filter.
|
|
<p>
|
|
This method returns the installed application filter. If no filter has been installed, then it will be a zero pointer.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer to the installed application filter. </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c1404c60969b4df0a6ae0ecbf116d69c"></a><!-- doxytag: member="xercesc::DOMBuilder::getFilter" ref="c1404c60969b4df0a6ae0ecbf116d69c" args="() const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const DOMBuilderFilter* xercesc::DOMBuilder::getFilter </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get a const pointer to the application filter.
|
|
<p>
|
|
This method returns the installed application filter. If no filter has been installed, then it will be a zero pointer.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A const pointer to the installed application filter </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6d54cffceeffc6d37636a65b9f94cc9d"></a><!-- doxytag: member="xercesc::DOMBuilder::setErrorHandler" ref="6d54cffceeffc6d37636a65b9f94cc9d" args="(DOMErrorHandler *const handler)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::setErrorHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> *const </td>
|
|
<td class="paramname"> <em>handler</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the error handler.
|
|
<p>
|
|
This method allows applications to install their own error handler to trap error and warning messages.<p>
|
|
<em>Any previously set handler is merely dropped, since the parser does not own them.</em><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>handler</em> </td><td>A const pointer to the user supplied error handler.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#df245ee7ae818e31daba8c25e1f460ae">getErrorHandler</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1d2c6058e5d3c02c6c66b0f8c39d9b7d"></a><!-- doxytag: member="xercesc::DOMBuilder::setEntityResolver" ref="1d2c6058e5d3c02c6c66b0f8c39d9b7d" args="(DOMEntityResolver *const handler)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::setEntityResolver </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMEntityResolver.html">DOMEntityResolver</a> *const </td>
|
|
<td class="paramname"> <em>handler</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the entity resolver.
|
|
<p>
|
|
This 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.<p>
|
|
<em>Any previously set resolver is merely dropped, since the parser does not own them.</em><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>handler</em> </td><td>A const pointer to the user supplied entity resolver.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#d74aa08f0ed0837c1109c46b422e4381">getEntityResolver</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="563c0aad9ee86319408fd246f1389bcd"></a><!-- doxytag: member="xercesc::DOMBuilder::setFilter" ref="563c0aad9ee86319408fd246f1389bcd" args="(DOMBuilderFilter *const filter)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::setFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">DOMBuilderFilter *const </td>
|
|
<td class="paramname"> <em>filter</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set the application filter.
|
|
<p>
|
|
When 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.<p>
|
|
<em>Any previously set filter is merely dropped, since the parser does not own them.</em><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>filter</em> </td><td>A const pointer to the user supplied application filter.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#689c0865e7f9b2a2d41bb3377ee2b823">getFilter</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0ce20798491e011bf1b2a2440699b807"></a><!-- doxytag: member="xercesc::DOMBuilder::setFeature" ref="0ce20798491e011bf1b2a2440699b807" args="(const XMLCh *const name, const bool state)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::setFeature </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>state</em></td><td> </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 a feature.
|
|
<p>
|
|
It is possible for a <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> to recognize a feature name but to be unable to set its value.<p>
|
|
<b>"Experimental - subject to change"</b><p>
|
|
See <a href="http://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures">http://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures</a> for the list of supported features.<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> </td><td>The feature name. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>state</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td>NOT_SUPPORTED_ERR: Raised when the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> recognizes the feature name but cannot set the requested value. <br>
|
|
NOT_FOUND_ERR: Raised when the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> does not recognize the feature name.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#0ce20798491e011bf1b2a2440699b807">setFeature</a> <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#7ec4f31c034159b1ce87a58ef8e429f6">canSetFeature</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ca0f947d9c558b3d4c45ce9e1700dbad"></a><!-- doxytag: member="xercesc::DOMBuilder::getFeature" ref="ca0f947d9c558b3d4c45ce9e1700dbad" args="(const XMLCh *const name) const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool xercesc::DOMBuilder::getFeature </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>name</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Look up the value of a feature.
|
|
<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>name</em> </td><td>The feature name. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The current state of the feature (true or false) </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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td>NOT_FOUND_ERR: Raised when the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> does not recognize the feature name.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#ca0f947d9c558b3d4c45ce9e1700dbad">getFeature</a> <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#7ec4f31c034159b1ce87a58ef8e429f6">canSetFeature</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="7ec4f31c034159b1ce87a58ef8e429f6"></a><!-- doxytag: member="xercesc::DOMBuilder::canSetFeature" ref="7ec4f31c034159b1ce87a58ef8e429f6" args="(const XMLCh *const name, const bool state) const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool xercesc::DOMBuilder::canSetFeature </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>state</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Query whether setting a feature to a specific value is supported.
|
|
<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>name</em> </td><td>The feature name. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>state</em> </td><td>The requested state of the feature (true or false). </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd><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.</dd></dl>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMBuilder.html#ca0f947d9c558b3d4c45ce9e1700dbad">getFeature</a> <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#0ce20798491e011bf1b2a2440699b807">setFeature</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c29f5cc524ca1e294a455c9b5c86e138"></a><!-- doxytag: member="xercesc::DOMBuilder::parse" ref="c29f5cc524ca1e294a455c9b5c86e138" args="(const DOMInputSource &source)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a>* xercesc::DOMBuilder::parse </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> & </td>
|
|
<td class="paramname"> <em>source</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Parse via an input source object.
|
|
<p>
|
|
This method invokes the parsing process on the XML file specified by the <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> parameter. This API is borrowed from the SAX Parser interface.<p>
|
|
The parser owns the returned <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a>. It will be deleted when the parser is released.<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> </td><td>A const reference to the <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> object which points to the XML file to be parsed. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>If the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is a synchronous <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> the newly created and populated <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a> is returned. If the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is asynchronous then <code>null</code> is returned since the document object is not yet parsed when this method returns. </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>SAXException</em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XMLException</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </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="classxercesc_1_1DOMInputSource.html#a9a2f11ce8631967b00c450b2265e08e">DOMInputSource::DOMInputSource</a> <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#1d2c6058e5d3c02c6c66b0f8c39d9b7d">setEntityResolver</a> <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#6d54cffceeffc6d37636a65b9f94cc9d">setErrorHandler</a> <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#7a0929e36b3acb03873acbfb42262926">resetDocumentPool</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6f44d6e15b9d54f9ea0d13c48a0cb6e4"></a><!-- doxytag: member="xercesc::DOMBuilder::parseURI" ref="6f44d6e15b9d54f9ea0d13c48a0cb6e4" args="(const XMLCh *const systemId)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a>* xercesc::DOMBuilder::parseURI </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Parse via a file path or URL.
|
|
<p>
|
|
This method invokes the parsing process on the XML file specified by the Unicode string parameter 'systemId'.<p>
|
|
The parser owns the returned <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a>. It will be deleted when the parser is released.<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> </td><td>A const XMLCh pointer to the Unicode string which contains the path to the XML file to be parsed. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>If the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is a synchronous <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> the newly created and populated <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a> is returned. If the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is asynchronous then <code>null</code> is returned since the document object is not yet parsed when this method returns. </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>SAXException</em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XMLException</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </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="classxercesc_1_1DOMBuilder.html#c29f5cc524ca1e294a455c9b5c86e138">parse</a>(<a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a>,...) <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#7a0929e36b3acb03873acbfb42262926">resetDocumentPool</a> </dd></dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5bca735be382c22a5899be47e009d23d"></a><!-- doxytag: member="xercesc::DOMBuilder::parseURI" ref="5bca735be382c22a5899be47e009d23d" args="(const char *const systemId)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a>* xercesc::DOMBuilder::parseURI </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>systemId</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Parse via a file path or URL (in the local code page).
|
|
<p>
|
|
This method invokes the parsing process on the XML file specified by the native char* string parameter 'systemId'.<p>
|
|
The parser owns the returned <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a>. It will be deleted when the parser is released.<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> </td><td>A const char pointer to a native string which contains the path to the XML file to be parsed. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>If the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is a synchronous <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> the newly created and populated <a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a> is returned. If the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is asynchronous then <code>null</code> is returned since the document object is not yet parsed when this method returns. </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>SAXException</em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XMLException</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </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="classxercesc_1_1DOMBuilder.html#c29f5cc524ca1e294a455c9b5c86e138">parse</a>(<a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a>,...) <p>
|
|
<a class="el" href="classxercesc_1_1DOMBuilder.html#7a0929e36b3acb03873acbfb42262926">resetDocumentPool</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3951d3fed1752230f76c8543a961eeb3"></a><!-- doxytag: member="xercesc::DOMBuilder::parseWithContext" ref="3951d3fed1752230f76c8543a961eeb3" args="(const DOMInputSource &source, DOMNode *const contextNode, const short action)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::parseWithContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> & </td>
|
|
<td class="paramname"> <em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *const </td>
|
|
<td class="paramname"> <em>contextNode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const short </td>
|
|
<td class="paramname"> <em>action</em></td><td> </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>
|
|
Parse via an input source object.
|
|
<p>
|
|
This method invokes the parsing process on the XML file specified by the <a class="el" href="classxercesc_1_1DOMInputSource.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.<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> </td><td>A const reference to the <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> object which points to the XML file to be parsed. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>contextNode</em> </td><td>The 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>
|
|
<tr><td valign="top"></td><td valign="top"><em>action</em> </td><td>This 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>
|
|
</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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td>NOT_SUPPORTED_ERR: Raised when the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> doesn't support this method. <br>
|
|
NO_MODIFICATION_ALLOWED_ERR: Raised if the context node is readonly. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f18f8d95da01f5b494e4c6c7f0967d36"></a><!-- doxytag: member="xercesc::DOMBuilder::getProperty" ref="f18f8d95da01f5b494e4c6c7f0967d36" args="(const XMLCh *const name) const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* xercesc::DOMBuilder::getProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>name</em> </td>
|
|
<td> ) </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 <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a>.
|
|
<p>
|
|
The builder owns the returned pointer. The memory allocated for the returned pointer will be destroyed when the builder is deleted.<p>
|
|
To 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://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderProperties</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> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td><br>
|
|
NOT_FOUND_ERR: Raised when the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> does not recognize the requested property. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="faf95c6b5df9cf20a5443222bb45941f"></a><!-- doxytag: member="xercesc::DOMBuilder::setProperty" ref="faf95c6b5df9cf20a5443222bb45941f" args="(const XMLCh *const name, void *value)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::setProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>value</em></td><td> </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 <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a>.
|
|
<p>
|
|
See <a href="http://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderProperties</a> for the list of supported properties.<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-dom.html#DOMBuilderProperties">http://xerces.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.<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> </td><td>The unique identifier (URI) of the property being set. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The requested value for the property. See <a href="http://xerces.apache.org/xerces-c/program-dom.html#DOMBuilderProperties">http://xerces.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>
|
|
</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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td><br>
|
|
NOT_FOUND_ERR: Raised when the <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> does not recognize the requested property. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="04330cf09a9c92278aef99e2645b7f9c"></a><!-- doxytag: member="xercesc::DOMBuilder::release" ref="04330cf09a9c92278aef99e2645b7f9c" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::release </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Called to indicate that this <a class="el" href="classxercesc_1_1DOMBuilder.html">DOMBuilder</a> is no longer in use and that the implementation may relinquish any resources associated with it.
|
|
<p>
|
|
Access to a released object will lead to unexpected result.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="7a0929e36b3acb03873acbfb42262926"></a><!-- doxytag: member="xercesc::DOMBuilder::resetDocumentPool" ref="7a0929e36b3acb03873acbfb42262926" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::resetDocumentPool </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Reset the documents vector pool and release all the associated memory back to the system.
|
|
<p>
|
|
When parsing a document using a DOM parser, all memory allocated for a DOM tree is associated to the DOM document.<p>
|
|
If 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.<p>
|
|
If 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.<p>
|
|
It 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).<p>
|
|
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>IOException</em> </td><td>An exception from the parser if this function is called when a parse is in progress. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="024005d73c8756422c3cdd85baffb8a8"></a><!-- doxytag: member="xercesc::DOMBuilder::loadGrammar" ref="024005d73c8756422c3cdd85baffb8a8" args="(const DOMInputSource &source, const short grammarType, const bool toCache=false)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Grammar* xercesc::DOMBuilder::loadGrammar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</a> & </td>
|
|
<td class="paramname"> <em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const short </td>
|
|
<td class="paramname"> <em>grammarType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>toCache</em> = <code>false</code></td><td> </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 <a class="el" href="classxercesc_1_1DOMInputSource.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.<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> </td><td>A const reference to the <a class="el" href="classxercesc_1_1DOMInputSource.html">DOMInputSource</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> </td><td>The grammar type (Schema or DTD). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toCache</em> </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>SAXException</em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XMLException</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </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="classxercesc_1_1DOMInputSource.html#a9a2f11ce8631967b00c450b2265e08e">DOMInputSource::DOMInputSource</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="25b1ddecff8768646b88af4822de1ea1"></a><!-- doxytag: member="xercesc::DOMBuilder::loadGrammar" ref="25b1ddecff8768646b88af4822de1ea1" 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* xercesc::DOMBuilder::loadGrammar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const short </td>
|
|
<td class="paramname"> <em>grammarType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>toCache</em> = <code>false</code></td><td> </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> </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> </td><td>The grammar type (Schema or DTD). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toCache</em> </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>SAXException</em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XMLException</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td>A DOM exception as per DOM spec. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="274515eff86c728c0c6edf87f5689ae8"></a><!-- doxytag: member="xercesc::DOMBuilder::loadGrammar" ref="274515eff86c728c0c6edf87f5689ae8" 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* xercesc::DOMBuilder::loadGrammar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>systemId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const short </td>
|
|
<td class="paramname"> <em>grammarType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>toCache</em> = <code>false</code></td><td> </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> </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> </td><td>The grammar type (Schema or DTD). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toCache</em> </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>SAXException</em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XMLException</em> </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="classxercesc_1_1DOMException.html">DOMException</a></em> </td><td>A DOM exception as per DOM spec. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="95c70a1822767a9d4e80198830c2db4d"></a><!-- doxytag: member="xercesc::DOMBuilder::getGrammar" ref="95c70a1822767a9d4e80198830c2db4d" args="(const XMLCh *const nameSpaceKey) const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Grammar* xercesc::DOMBuilder::getGrammar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>nameSpaceKey</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<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> </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="8c2966d33830cfa3fc86e00ece14b30e"></a><!-- doxytag: member="xercesc::DOMBuilder::getRootGrammar" ref="8c2966d33830cfa3fc86e00ece14b30e" args="() const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Grammar* xercesc::DOMBuilder::getRootGrammar </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
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="ec9aedc1001f14f421dc16763b465867"></a><!-- doxytag: member="xercesc::DOMBuilder::getURIText" ref="ec9aedc1001f14f421dc16763b465867" args="(unsigned int uriId) const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const XMLCh* xercesc::DOMBuilder::getURIText </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>uriId</em> </td>
|
|
<td> ) </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> </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="9b6affd174edc8c7b503e781a27b1eb7"></a><!-- doxytag: member="xercesc::DOMBuilder::resetCachedGrammarPool" ref="9b6affd174edc8c7b503e781a27b1eb7" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMBuilder::resetCachedGrammarPool </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="7f05e64b568d5bd285eea7c7e6ad4cd5"></a><!-- doxytag: member="xercesc::DOMBuilder::getSrcOffset" ref="7f05e64b568d5bd285eea7c7e6ad4cd5" args="() const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int xercesc::DOMBuilder::getSrcOffset </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Returns the current src offset within the input source.
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>offset within the input source </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="DOMBuilder_8hpp-source.html">DOMBuilder.hpp</a></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Mon Apr 28 16:41:27 2008 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
|
|
</body>
|
|
</html>
|