<!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.6.1 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMEntity.html">DOMEntity</a>
</div>
</div>
<div class="contents">
<h1>xercesc::DOMEntity Class Reference</h1><!-- doxytag: class="xercesc::DOMEntity" --><!-- doxytag: inherits="xercesc::DOMNode" -->
<p>This interface represents an entity, either parsed or unparsed, in an XML document.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="DOMEntity_8hpp_source.html">DOMEntity.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for xercesc::DOMEntity:</div>
<div class="dynsection">
<div class="center"><img src="classxercesc_1_1DOMEntity__inherit__graph.png" border="0" usemap="#xercesc_1_1DOMEntity_inherit__map" alt="Inheritance graph"/></div>
<map name="xercesc_1_1DOMEntity_inherit__map" id="xercesc_1_1DOMEntity_inherit__map">
<area shape="rect" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model..." alt="" coords="7,5,143,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classxercesc_1_1DOMEntity-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp22a8ec108d963f279c6a6a95aa960a57"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#a389542c0d9ba055be62eef9c789ee909">~DOMEntity</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a389542c0d9ba055be62eef9c789ee909"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 1</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp24249042249e54f2e7b060cef8bc9ec0"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#a180e4a1b00e12046e9096274b20dfed7">getPublicId</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The public identifier associated with the entity, if specified. <a href="#a180e4a1b00e12046e9096274b20dfed7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#abd0c3de8709feb4c4ece99c65b48d19f">getSystemId</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The system identifier associated with the entity, if specified. <a href="#abd0c3de8709feb4c4ece99c65b48d19f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#a92e67138ab2d20ac4cbaeadc608ceff7">getNotationName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For unparsed entities, the name of the notation for the entity. <a href="#a92e67138ab2d20ac4cbaeadc608ceff7"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3.</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp24c278d8f8612550f82b59dac8fab429"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#a78dadcd54e86c2688ec8e8df29026d83">getInputEncoding</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity. <a href="#a78dadcd54e86c2688ec8e8df29026d83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#aee0f6f9604098a6b1198089054c96fc0">getXmlEncoding</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. <a href="#aee0f6f9604098a6b1198089054c96fc0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#a2b5b32249cc65cecd940060b6b80c90c">getXmlVersion</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. <a href="#a2b5b32249cc65cecd940060b6b80c90c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp7d629e77fff660516f7d86e8f54695d0"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#a3fef4d3039a481c496ebfa1a3cbccf0f">DOMEntity</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMEntity.html#adc0c244c03464eb7a3a1717251d27a28">DOMEntity</a> (const <a class="el" href="classxercesc_1_1DOMEntity.html">DOMEntity</a> &other)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This interface represents an entity, either parsed or unparsed, in an XML document. </p>
<p>Note that this models the entity itself not the entity declaration. <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code> declaration modeling has been left for a later Level of the DOM specification. </p>
<p>The <code>nodeName</code> attribute that is inherited from <code><a class="el" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a></code> contains the name of the entity. </p>
<p>An XML processor may choose to completely expand entities before the structure model is passed to the DOM; in this case there will be no <code><a class="el" href="classxercesc_1_1DOMEntityReference.html" title="DOMEntityReference objects may be inserted into the structure model when an entity...">DOMEntityReference</a></code> nodes in the document tree. </p>
<p>XML does not mandate that a non-validating XML processor read and process entity declarations made in the external subset or declared in external parameter entities. This means that parsed entities declared in the external subset need not be expanded by some classes of applications, and that the replacement value of the entity may not be available. When the replacement value is available, the corresponding <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code> node's child list represents the structure of that replacement text. Otherwise, the child list is empty. </p>
<p>The DOM Level 2 does not support editing <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code> nodes; if a user wants to make changes to the contents of an <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code>, every related <code><a class="el" href="classxercesc_1_1DOMEntityReference.html" title="DOMEntityReference objects may be inserted into the structure model when an entity...">DOMEntityReference</a></code> node has to be replaced in the structure model by a clone of the <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code>'s contents, and then the desired changes must be made to each of those clones instead. <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code> nodes and all their descendants are readonly. </p>
<p>An <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code> node does not have any parent.If the entity contains an unbound namespace prefix, the <code>namespaceURI</code> of the corresponding node in the <code><a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document...">DOMEntity</a></code> node subtree is <code>null</code>. The same is true for <code><a class="el" href="classxercesc_1_1DOMEntityReference.html" title="DOMEntityReference objects may be inserted into the structure model when an entity...">DOMEntityReference</a></code> nodes that refer to this entity, when they are created using the <code>createEntityReference</code> method of the <code><a class="el" href="classxercesc_1_1DOMDocument.html" title="The DOMDocument interface represents the entire XML document.">DOMDocument</a></code> interface. The DOM Level 2 does not support any mechanism to resolve namespace prefixes. </p>
<p>See also the <a href="http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113">Document Object Model (DOM) Level 2 Core Specification</a>.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3fef4d3039a481c496ebfa1a3cbccf0f"></a><!-- doxytag: member="xercesc::DOMEntity::DOMEntity" ref="a3fef4d3039a481c496ebfa1a3cbccf0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMEntity::DOMEntity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="adc0c244c03464eb7a3a1717251d27a28"></a><!-- doxytag: member="xercesc::DOMEntity::DOMEntity" ref="adc0c244c03464eb7a3a1717251d27a28" args="(const DOMEntity &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMEntity::DOMEntity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMEntity.html">DOMEntity</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a389542c0d9ba055be62eef9c789ee909"></a><!-- doxytag: member="xercesc::DOMEntity::~DOMEntity" ref="a389542c0d9ba055be62eef9c789ee909" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMEntity::~DOMEntity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a78dadcd54e86c2688ec8e8df29026d83"></a><!-- doxytag: member="xercesc::DOMEntity::getInputEncoding" ref="a78dadcd54e86c2688ec8e8df29026d83" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMEntity::getInputEncoding </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity. </p>
<p>This is <code>null</code> if it an entity from the internal subset or if it is not known.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a92e67138ab2d20ac4cbaeadc608ceff7"></a><!-- doxytag: member="xercesc::DOMEntity::getNotationName" ref="a92e67138ab2d20ac4cbaeadc608ceff7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMEntity::getNotationName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For unparsed entities, the name of the notation for the entity. </p>
<p>For parsed entities, this is <code>null</code>.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div>
<a class="anchor" id="a180e4a1b00e12046e9096274b20dfed7"></a><!-- doxytag: member="xercesc::DOMEntity::getPublicId" ref="a180e4a1b00e12046e9096274b20dfed7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMEntity::getPublicId </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The public identifier associated with the entity, if specified. </p>
<p>If the public identifier was not specified, this is <code>null</code>.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div>
<a class="anchor" id="abd0c3de8709feb4c4ece99c65b48d19f"></a><!-- doxytag: member="xercesc::DOMEntity::getSystemId" ref="abd0c3de8709feb4c4ece99c65b48d19f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMEntity::getSystemId </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The system identifier associated with the entity, if specified. </p>
<p>If the system identifier was not specified, this is <code>null</code>.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div>
<a class="anchor" id="aee0f6f9604098a6b1198089054c96fc0"></a><!-- doxytag: member="xercesc::DOMEntity::getXmlEncoding" ref="aee0f6f9604098a6b1198089054c96fc0" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMEntity::getXmlEncoding </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. </p>
<p>This is <code>null</code> otherwise.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a2b5b32249cc65cecd940060b6b80c90c"></a><!-- doxytag: member="xercesc::DOMEntity::getXmlVersion" ref="a2b5b32249cc65cecd940060b6b80c90c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMEntity::getXmlVersion </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. </p>
<p>This is <code>null</code> otherwise.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMEntity_8hpp_source.html">DOMEntity.hpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 29 Apr 2011 for XQilla DOM Level 3 API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
