xmldom::DomEntity Class Reference

#include <DomEntity.h>

Inherits xmldom::DomNode.

Inheritance diagram for xmldom::DomEntity:

[legend]List of all members.

---

Detailed Description

This interface represents a known entity, either parsed or unparsed, in an XML document.

Note that this models the entity itself not the entity declaration. The getNodeName() attribute that is inherited from DomNode 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 DomEntityReference 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 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 text of the entity may not be available. When the replacement text is available, the corresponding Entity node’s child list represents the structure of that replacement value. Otherwise, the child list is empty.

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

An DomEntity node does not have any parent.

Note:

If the entity contains an unbound namespace prefix, the getNamespaceURI() of the corresponding node in the DomEntity node subtree is null. The same is true for DomEntityReference nodes that refer to this entity, when they are created using the DomDocument::createEntityReference() method of the DomDocument interface.

See also:

More Informations About the DOM 3 standard.

Public Member Functions
	DomEntity ()
	ctor
	DomEntity (const DomEntity &copy)
	copy ctor
virtual	~DomEntity ()
	dtor
const DomEntity &	operator= (const DomEntity &assign)
	assign
DOM Level 1
DomString	getPublicId () const
	The public identifier associated with the entity if specified, and null otherwise.
DomString	getSystemId () const
	The system identifier associated with the entity if specified, and null otherwise.
DomString	getNotationName () const
	For unparsed entities, the name of the notation for the entity.

---

Constructor & Destructor Documentation

xmldom::DomEntity::DomEntity

(

)

ctor

xmldom::DomEntity::DomEntity

(

const DomEntity &

copy

)

copy ctor

xmldom::DomEntity::~DomEntity

(

)

[virtual]

dtor

---

Member Function Documentation

const DomEntity & xmldom::DomEntity::operator=

(

const DomEntity &

assign

)

assign

DomString xmldom::DomEntity::getPublicId

(

)

const

The public identifier associated with the entity if specified, and null otherwise.

DomString xmldom::DomEntity::getSystemId

(

)

const

The system identifier associated with the entity if specified, and null otherwise.

This may be an absolute URI or not.

DomString xmldom::DomEntity::getNotationName

(

)

const

For unparsed entities, the name of the notation for the entity.

For parsed entities, this is null.

---

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

• D:/Development/Sapphire_08_V1/InternalLibrary/Src/XMLDOM/V0/Src/XMLDOM/DomEntity.h
• D:/Development/Sapphire_08_V1/InternalLibrary/Src/XMLDOM/V0/Src/XMLDOM/DomEntity.cpp

---