class DOM_Notation : public DOM_Node

This interface represents a notation declared in the DTD

Inheritance:


Public

Constructors and assignment operator
DOM_Notation ()
Default constructor for DOM_Notation
DOM_Notation (const DOM_Notation &other)
Copy constructor
DOM_Notation& operator = (const DOM_Notation &other)
Assignment operator
DOM_Notation& operator = (const DOM_NullPtr *val)
Assignment operator
Destructor.
~DOM_Notation ()
Destructor for DOM_Notation
Get functions.
DOMString getPublicId () const
Get the public identifier of this notation
DOMString getSystemId () const
Get the system identifier of this notation
Set functions.
void setPublicId (const DOMString &id)
Sets the public identifier of this notation
void setSystemId (const DOMString &id)
Sets the system identifier of this notation

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 a notation declared in the DTD. A notation either declares, by name, the format of an unparsed entity (see section 4.7 of the XML 1.0 specification), or is used for formal declaration of Processing Instruction targets (see section 2.6 of the XML 1.0 specification). The nodeName attribute inherited from Node is set to the declared name of the notation.

The DOM Level 1 does not support editing Notation nodes; they are therefore readonly.

A Notation node does not have any parent.

Constructors and assignment operator

DOM_Notation()
Default constructor for DOM_Notation. The resulting object does not refer to an actual Notation node; it will compare == to 0, and is similar to a null object reference variable in Java. It may subsequently be assigned to refer to an actual Notation node.

New notation nodes are created by DOM_Document::createNotation().

DOM_Notation(const DOM_Notation &other)
Copy constructor. Creates a new DOM_Notation that refers to the same underlying node as the original. See also DOM_Node::clone(), which will copy the actual notation node, rather than just creating a new reference to the original node.
Parameters:
other - The object to be copied.

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

DOM_Notation& 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_Notation()
Destructor for DOM_Notation. The object being destroyed is the reference object, not the underlying Notation node itself.

Get functions.

DOMString getPublicId() const
Get the public identifier of this notation. If the public identifier was not specified, this is null.
Returns:
Returns the public identifier of the notation

DOMString getSystemId() const
Get the system identifier of this notation. If the system identifier was not specified, this is null.
Returns:
Returns the system identifier of the notation

Set functions.

void setPublicId(const DOMString &id)
Sets the public identifier of this notation. This function is a non-standard IBM Extension.
Parameters:
id - The string containing the public id to be set

void setSystemId(const DOMString &id)
Sets the system identifier of this notation. This function is a non-standard IBM Extension.
Parameters:
id - The string containing the system id to be set


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