GdomeCppSmartDOM::Entity

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 DOM Level 2 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.

Note:

If the entity contains an unbound namespace prefix, the namespaceURI of the corresponding node in the Entity node subtree is null. The same is true for EntityReference nodes that refer to this entity, when they are created using the createEntityReference method of the Document interface. The DOM Level 2 does not support any mechanism to resolve namespace prefixes.



Inherits from
Node


Default Constructor
Entity(GdomeEntity* = 0)
Creates a smart pointer for the Gdome element whose pointer is passed as an argument. The user should never pass a non-null pointer to this constructor.


Copy and Cast Constructors
Entity(const Entity&)
Entity(const Node&)
These constructors can be used to copy a smart pointer or to downcast it. If the downcasting is not possible, the resulting smart pointer will be null.


Copy Operator
Entity& operator=(const Entity&)


Equality
bool operator==(const Entity&) const
bool operator!=(const Entity&) const
Two smart pointers are equal if they point to the same Gdome object.


Attributes
DOMString get_publicId(void) const

The public identifier associated with the entity, if specified. If the public identifier was not specified, this is null.

DOMString get_systemId(void) const

The system identifier associated with the entity, if specified. If the system identifier was not specified, this is null.

DOMString get_notationName(void) const

For unparsed entities, the name of the notation for the entity. For parsed entities, this is null.


This file has been generated automatically on Tue Nov 27 17:13:14 EST 2001 as part of GMetaDOM. For more information see the home page of the project, or contact the main author: luca.padovani@cs.unibo.it.