class DOM_Entity : public DOM_Node

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

Inheritance:


Public

Constructors and assignment operator
DOM_Entity ()
Default constructor for DOM_Entity
DOM_Entity (const DOM_Entity &other)
Copy constructor
DOM_Entity& operator = (const DOM_Entity &other)
Assignment operator
DOM_Entity& operator = (const DOM_NullPtr *val)
Assignment operator
Destructor.
~DOM_Entity ()
Destructor for DOM_Entity
Get functions.
DOMString getPublicId () const
The public identifier associated with the entity, if specified
DOMString getSystemId () const
The system identifier associated with the entity, if specified
DOMString getNotationName () const
For unparsed entities, the name of the notation for the entity
Set functions.
void setNotationName (const DOMString &name)
Set the Notation name
void setPublicId (const DOMString &Id)
Set the public ID
void setSystemId (const DOMString &Id)
Set the system ID

Inherited from DOM_Node:

Public

Cloning function.

DOM_Node cloneNode(bool deep) const
Returns a duplicate of this node

Constructors and assignment operators

DOM_Node()
Default constructor for DOM_Node
DOM_Node(const DOM_Node &other)
Copy constructor
DOM_Node& operator = (const DOM_Node &other)
Assignment operator
DOM_Node& operator = (const DOM_NullPtr *val)
Assignment operator

Equality and Inequality operators.

bool operator == (const DOM_Node & other) const
The equality operator
bool operator == (const DOM_NullPtr *other) const
Compare with a pointer
bool operator != (const DOM_Node & other) const
The inequality operator
bool operator != (const DOM_NullPtr * other) const
Compare with a pointer

Functions to modify the DOM Node.

DOM_Node insertBefore(const DOM_Node &newChild, const DOM_Node &refChild)
Inserts the node newChild before the existing child node refChild
DOM_Node replaceChild(const DOM_Node &newChild, const DOM_Node &oldChild)
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node
DOM_Node removeChild(const DOM_Node &oldChild)
Removes the child node indicated by oldChild from the list of children, and returns it
DOM_Node appendChild(const DOM_Node &newChild)
Adds the node newChild to the end of the list of children of this node

Query functions.

bool hasChildNodes() const
This is a convenience method to allow easy determination of whether a node has any children
bool isNull() const
Test whether this node is null

Documentation

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.

Note: the first release of this parser does not create entity nodes when reading an XML document. Entities may be programatically created using DOM_Document::createEntity().

Constructors and assignment operator

DOM_Entity()
Default constructor for DOM_Entity

DOM_Entity(const DOM_Entity &other)
Copy constructor.
Parameters:
other - The object to be copied.

DOM_Entity& operator = (const DOM_Entity &other)
Assignment operator.
Parameters:
other - The object to be copied.

DOM_Entity& operator = (const DOM_NullPtr *val)
Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_Node reference variable to zero. Nulling out a reference variable in this way will decrement the reference count on the underlying Node object that the variable formerly referenced. This effect is normally obtained when reference variable goes out of scope, but zeroing them can be useful for global instances, or for local instances that will remain in scope for an extended time, when the storage belonging to the underlying node needs to be reclaimed.
Parameters:
val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_Entity()
Destructor for DOM_Entity

Get functions.

DOMString getPublicId() const
The public identifier associated with the entity, if specified. If the public identifier was not specified, this is null.

DOMString getSystemId() const
The system identifier associated with the entity, if specified. If the system identifier was not specified, this is null.

DOMString getNotationName() const
For unparsed entities, the name of the notation for the entity. For parsed entities, this is null.

Set functions.

void setNotationName(const DOMString &name)
Set the Notation name. This is a non-standard IBM extension

void setPublicId(const DOMString &Id)
Set the public ID. This is a non-standard IBM extension.

void setSystemId(const DOMString &Id)
Set the system ID. This is a non-standard IBM extension.


This class has no child classes.

alphabetic index hierarchy of classes


XML Parser for C++ 2.0
Copyright © IBM Corp, 1999
Center for Java Technology
10275 N. De Anza Blvd.
Cupertino CA 95014 USA
Email: xml4c@us.ibm.com

IBM Logo