File: Poco.XML.Entity.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (96 lines) | stat: -rw-r--r-- 15,536 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::XML::Entity</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1>
<h1 class="symbol">class Entity</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> DOM<br />
<b>Header:</b> Poco/DOM/Entity.h</p>
<h2>Description</h2>
<div class="description">
<p>This interface represents an entity, either parsed or unparsed, in an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document. Note that this models the entity itself not the entity declaration. <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> declaration modeling has been left for a later Level of the DOM specification. </p>
<p>The nodeName attribute that is inherited from <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> contains the name of the entity. </p>
<p>An <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> processor may choose to completely expand entities before the structure model is passed to the DOM; in this case there will be no <a href="Poco.XML.EntityReference.html" title="class Poco::XML::EntityReference">EntityReference</a> nodes in the document tree. </p>
<p><a href="Poco.XML.html" title="namespace Poco::XML">XML</a> does not mandate that a non-validating <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> 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 <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> node's child list represents the structure of that replacement text. Otherwise, the child list is empty. </p>
<p>The resolution of the children of the <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> (the replacement value) may be lazily evaluated; actions by the user (such as calling the childNodes method on the <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a>) are assumed to trigger the evaluation. </p>
<p>The DOM Level 1 does not support editing <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> nodes; if a user wants to make changes to the contents of an <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a>, every related <a href="Poco.XML.EntityReference.html" title="class Poco::XML::EntityReference">EntityReference</a> node has to be replaced in the structure model by a clone of the <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a>'s contents, and then the desired changes must be made to each of those clones instead. <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> nodes and all their descendants are readonly. </p>
<p>An <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> node does not have any parent. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.XML.AbstractContainerNode.html" title="class Poco::XML::AbstractContainerNode">AbstractContainerNode</a></p>
<p><b>All Base Classes: </b><a href="Poco.XML.AbstractContainerNode.html" title="class Poco::XML::AbstractContainerNode">AbstractContainerNode</a>, <a href="Poco.XML.AbstractNode.html" title="class Poco::XML::AbstractNode">AbstractNode</a>, <a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a>, <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a>, <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.Entity.html#18290" title="Poco::XML::Entity::copyNode()">copyNode</a>, <a href="Poco.XML.Entity.html#18278" title="Poco::XML::Entity::nodeName()">nodeName</a>, <a href="Poco.XML.Entity.html#18279" title="Poco::XML::Entity::nodeType()">nodeType</a>, <a href="Poco.XML.Entity.html#18277" title="Poco::XML::Entity::notationName()">notationName</a>, <a href="Poco.XML.Entity.html#18275" title="Poco::XML::Entity::publicId()">publicId</a>, <a href="Poco.XML.Entity.html#18276" title="Poco::XML::Entity::systemId()">systemId</a></p>
<p><b>Inherited Functions: </b><a href="Poco.XML.AbstractNode.html#17561" title="Poco::XML::AbstractNode::addEventListener()">addEventListener</a>, <a href="Poco.XML.AbstractContainerNode.html#17514" title="Poco::XML::AbstractContainerNode::appendChild()">appendChild</a>, <a href="Poco.XML.AbstractNode.html#17538" title="Poco::XML::AbstractNode::attributes()">attributes</a>, <a href="Poco.XML.AbstractNode.html#17572" title="Poco::XML::AbstractNode::autoRelease()">autoRelease</a>, <a href="Poco.XML.AbstractNode.html#17586" title="Poco::XML::AbstractNode::bubbleEvent()">bubbleEvent</a>, <a href="Poco.XML.AbstractNode.html#17584" title="Poco::XML::AbstractNode::captureEvent()">captureEvent</a>, <a href="Poco.XML.AbstractNode.html#17533" title="Poco::XML::AbstractNode::childNodes()">childNodes</a>, <a href="Poco.XML.AbstractNode.html#17551" title="Poco::XML::AbstractNode::cloneNode()">cloneNode</a>, <a href="Poco.XML.AbstractNode.html#17579" title="Poco::XML::AbstractNode::copyNode()">copyNode</a>, <a href="Poco.XML.AbstractNode.html#17593" title="Poco::XML::AbstractNode::dispatchAttrModified()">dispatchAttrModified</a>, <a href="Poco.XML.AbstractNode.html#17598" title="Poco::XML::AbstractNode::dispatchCharacterDataModified()">dispatchCharacterDataModified</a>, <a href="Poco.XML.AbstractNode.html#17569" title="Poco::XML::AbstractNode::dispatchEvent()">dispatchEvent</a>, <a href="Poco.XML.AbstractNode.html#17589" title="Poco::XML::AbstractNode::dispatchNodeInserted()">dispatchNodeInserted</a>, <a href="Poco.XML.AbstractContainerNode.html#17525" title="Poco::XML::AbstractContainerNode::dispatchNodeInsertedIntoDocument()">dispatchNodeInsertedIntoDocument</a>, <a href="Poco.XML.AbstractNode.html#17590" title="Poco::XML::AbstractNode::dispatchNodeRemoved()">dispatchNodeRemoved</a>, <a href="Poco.XML.AbstractContainerNode.html#17524" title="Poco::XML::AbstractContainerNode::dispatchNodeRemovedFromDocument()">dispatchNodeRemovedFromDocument</a>, <a href="Poco.XML.AbstractNode.html#17588" title="Poco::XML::AbstractNode::dispatchSubtreeModified()">dispatchSubtreeModified</a>, <a href="Poco.XML.DOMObject.html#17881" title="Poco::XML::DOMObject::duplicate()">duplicate</a>, <a href="Poco.XML.AbstractNode.html#17582" title="Poco::XML::AbstractNode::events()">events</a>, <a href="Poco.XML.AbstractNode.html#17583" title="Poco::XML::AbstractNode::eventsSuspended()">eventsSuspended</a>, <a href="Poco.XML.AbstractContainerNode.html#17504" title="Poco::XML::AbstractContainerNode::firstChild()">firstChild</a>, <a href="Poco.XML.AbstractNode.html#17529" title="Poco::XML::AbstractNode::getNodeValue()">getNodeValue</a>, <a href="Poco.XML.AbstractContainerNode.html#17517" title="Poco::XML::AbstractContainerNode::hasAttributes()">hasAttributes</a>, <a href="Poco.XML.AbstractContainerNode.html#17516" title="Poco::XML::AbstractContainerNode::hasChildNodes()">hasChildNodes</a>, <a href="Poco.XML.AbstractNode.html#17571" title="Poco::XML::AbstractNode::innerText()">innerText</a>, <a href="Poco.XML.AbstractContainerNode.html#17506" title="Poco::XML::AbstractContainerNode::insertBefore()">insertBefore</a>, <a href="Poco.XML.AbstractNode.html#17554" title="Poco::XML::AbstractNode::isSupported()">isSupported</a>, <a href="Poco.XML.AbstractContainerNode.html#17505" title="Poco::XML::AbstractContainerNode::lastChild()">lastChild</a>, <a href="Poco.XML.AbstractNode.html#17559" title="Poco::XML::AbstractNode::localName()">localName</a>, <a href="Poco.XML.AbstractNode.html#17557" title="Poco::XML::AbstractNode::namespaceURI()">namespaceURI</a>, <a href="Poco.XML.AbstractNode.html#17537" title="Poco::XML::AbstractNode::nextSibling()">nextSibling</a>, <a href="Poco.XML.AbstractNode.html#17528" title="Poco::XML::AbstractNode::nodeName()">nodeName</a>, <a href="Poco.XML.Node.html#18504" title="Poco::XML::Node::nodeType()">nodeType</a>, <a href="Poco.XML.Node.html#18500" title="Poco::XML::Node::nodeValue()">nodeValue</a>, <a href="Poco.XML.AbstractNode.html#17553" title="Poco::XML::AbstractNode::normalize()">normalize</a>, <a href="Poco.XML.AbstractNode.html#17539" title="Poco::XML::AbstractNode::ownerDocument()">ownerDocument</a>, <a href="Poco.XML.AbstractNode.html#17532" title="Poco::XML::AbstractNode::parentNode()">parentNode</a>, <a href="Poco.XML.AbstractNode.html#17558" title="Poco::XML::AbstractNode::prefix()">prefix</a>, <a href="Poco.XML.AbstractNode.html#17536" title="Poco::XML::AbstractNode::previousSibling()">previousSibling</a>, <a href="Poco.XML.DOMObject.html#17882" title="Poco::XML::DOMObject::release()">release</a>, <a href="Poco.XML.AbstractContainerNode.html#17512" title="Poco::XML::AbstractContainerNode::removeChild()">removeChild</a>, <a href="Poco.XML.AbstractNode.html#17565" title="Poco::XML::AbstractNode::removeEventListener()">removeEventListener</a>, <a href="Poco.XML.AbstractContainerNode.html#17509" title="Poco::XML::AbstractContainerNode::replaceChild()">replaceChild</a>, <a href="Poco.XML.AbstractNode.html#17530" title="Poco::XML::AbstractNode::setNodeValue()">setNodeValue</a>, <a href="Poco.XML.AbstractNode.html#17601" title="Poco::XML::AbstractNode::setOwnerDocument()">setOwnerDocument</a></p>
<h2>Constructors</h2>
<h3><a name="18286">Entity</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> &amp; entity<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="18280">Entity</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; publicId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; notationName<br />);</p>
<div class="description">
<p></p>
</div>
<h2>Destructor</h2>
<h3><a name="18289">~Entity</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18278">nodeName</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; nodeName() const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17528" title="Poco::XML::AbstractNode::nodeName()">Poco::XML::AbstractNode::nodeName()</a></p></div>
<h3><a name="18279">nodeType</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">unsigned short nodeType() const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.Node.html#18504" title="Poco::XML::Node::nodeType()">Poco::XML::Node::nodeType()</a></p></div>
<h3><a name="18277">notationName</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; notationName() const;</p>
<div class="description">
<p>Returns, for unparsed entities, the name of the notation for the entity. For parsed entities, this is the empty string. </p>
</div>
<h3><a name="18275">publicId</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; publicId() const;</p>
<div class="description">
<p>Returns the public identifier associated with the entity, if specified. If the public identifier was not specified, this is the empty string. </p>
</div>
<h3><a name="18276">systemId</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId() const;</p>
<div class="description">
<p>Returns the system identifier associated with the entity, if specified. If the system identifier was not specified, this is the empty string. </p>
</div>
<h3><a name="18290">copyNode</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * copyNode(<br />&nbsp;&nbsp;&nbsp;&nbsp;bool deep,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument<br />) const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17579" title="Poco::XML::AbstractNode::copyNode()">Poco::XML::AbstractNode::copyNode()</a></p></div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>