Logo Search packages:      
Sourcecode: poco version File versions  Download package

Poco::XML::Entity Class Reference

#include <Entity.h>

Inheritance diagram for Poco::XML::Entity:

Poco::XML::AbstractContainerNode Poco::XML::AbstractNode Poco::XML::Node Poco::XML::EventTarget Poco::XML::DOMObject

List of all members.


Detailed Description

This interface represents an entity, either parsed or unparsed, in an XML document. Note that this models the entity itself not the entity declaration. Entity declaration modeling has been left for a later Level of the DOM specification.

The nodeName attribute that is inherited from Node contains the name of the entity.

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 EntityReference nodes in the document tree.

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 Entity node's child list represents the structure of that replacement text. Otherwise, the child list is empty.

The resolution of the children of the Entity (the replacement value) may be lazily evaluated; actions by the user (such as calling the childNodes method on the Entity Node) are assumed to trigger the evaluation.

The DOM Level 1 does not support editing Entity nodes; if a user wants to make changes to the contents of an Entity, every related EntityReference node has to be replaced in the structure model by a clone of the Entity's contents, and then the desired changes must be made to each of those clones instead. Entity nodes and all their descendants are readonly.

An Entity node does not have any parent.

Definition at line 52 of file Entity.h.


Public Types

enum  {
  ELEMENT_NODE = 1, ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE,
  ENTITY_REFERENCE_NODE, ENTITY_NODE, PROCESSING_INSTRUCTION_NODE, COMMENT_NODE,
  DOCUMENT_NODE, DOCUMENT_TYPE_NODE, DOCUMENT_FRAGMENT_NODE, NOTATION_NODE
}

Public Member Functions

void addEventListener (const XMLString &type, EventListener *listener, bool useCapture)
NodeappendChild (Node *newChild)
NamedNodeMapattributes () const
virtual void autoRelease ()
NodeListchildNodes () const
NodecloneNode (bool deep) const
bool dispatchEvent (Event *evt)
void duplicate () const
NodefirstChild () const
const XMLString & getNodeValue () const
 Returns the value of this node, depending on its type.
bool hasAttributes () const
 Returns the local name of the node.
bool hasChildNodes () const
XMLString innerText () const
 Returns whether this node (if it is an element) has any attributes.
NodeinsertBefore (Node *newChild, Node *refChild)
bool isSupported (const XMLString &feature, const XMLString &version) const
NodelastChild () const
const XMLString & localName () const
 Returns the namespace prefix from the qualified name of the node.
const XMLString & namespaceURI () const
NodenextSibling () const
const XMLString & nodeName () const
unsigned short nodeType () const
const XMLString & nodeValue () const
 Returns the name of this node, depending on its type.
void normalize ()
const XMLString & notationName () const
DocumentownerDocument () const
NodeparentNode () const
 Returns a code representing the type of the underlying object.
XMLString prefix () const
NodepreviousSibling () const
const XMLString & publicId () const
void release () const
 Increases the object's reference count.
NoderemoveChild (Node *oldChild)
void removeEventListener (const XMLString &type, EventListener *listener, bool useCapture)
NodereplaceChild (Node *newChild, Node *oldChild)
void setNodeValue (const XMLString &value)
 Returns the value of this node, depending on its type.
const XMLString & systemId () const

Protected Member Functions

void bubbleEvent (Event *evt)
void captureEvent (Event *evt)
NodecopyNode (bool deep, Document *pOwnerDocument) const
void dispatchAttrModified (Attr *pAttr, MutationEvent::AttrChangeType changeType, const XMLString &prevValue, const XMLString &newValue)
void dispatchCharacterDataModified (const XMLString &prevValue, const XMLString &newValue)
void dispatchNodeInserted ()
void dispatchNodeInsertedIntoDocument ()
void dispatchNodeRemoved ()
void dispatchNodeRemovedFromDocument ()
void dispatchSubtreeModified ()
 Entity (Document *pOwnerDocument, const Entity &entity)
 Entity (Document *pOwnerDocument, const XMLString &name, const XMLString &publicId, const XMLString &systemId, const XMLString &notationName)
virtual bool events () const
virtual bool eventsSuspended () const
void setOwnerDocument (Document *pOwnerDocument)

Static Protected Attributes

static const XMLString EMPTY_STRING

Private Attributes

XMLString _name
XMLString _notationName
XMLString _publicId
XMLString _systemId

Static Private Attributes

static const XMLString NODE_NAME = toXMLString("#entity")

Friends

class Document

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index