Main Page   Class Hierarchy   Compound List   File List   Compound Members  

IDOM_Node Class Reference

Inheritance diagram for IDOM_Node:

IDOM_Attr IDOM_CharacterData IDOM_Document IDOM_DocumentFragment IDOM_DocumentType IDOM_Element IDOM_Entity IDOM_EntityReference IDOM_Notation IDOM_ProcessingInstruction List of all members.

Public Types

enum  NodeType {
  ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4,
  ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8,
  DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12,
  XML_DECL_NODE = 13
}

Public Methods

Destructor.
virtual ~IDOM_Node ()
Get functions.
virtual const XMLCh * getNodeName () const=0
virtual const XMLCh * getNodeValue () const=0
virtual short getNodeType () const=0
virtual IDOM_Node * getParentNode () const=0
virtual IDOM_NodeList * getChildNodes () const=0
virtual IDOM_Node * getFirstChild () const=0
virtual IDOM_Node * getLastChild () const=0
virtual IDOM_Node * getPreviousSibling () const=0
virtual IDOM_Node * getNextSibling () const=0
virtual IDOM_NamedNodeMap * getAttributes () const=0
virtual IDOM_Document * getOwnerDocument () const=0
Cloning function.
virtual IDOM_Node * cloneNode (bool deep) const=0
Functions to modify the DOM Node.
virtual IDOM_Node * insertBefore (IDOM_Node *newChild, IDOM_Node *refChild)=0
virtual IDOM_Node * replaceChild (IDOM_Node *newChild, IDOM_Node *oldChild)=0
virtual IDOM_Node * removeChild (IDOM_Node *oldChild)=0
virtual IDOM_Node * appendChild (IDOM_Node *newChild)=0
Query functions.
virtual bool hasChildNodes () const=0
Set functions.
virtual void setNodeValue (const XMLCh *nodeValue)=0
Functions introduced in DOM Level 2.
virtual void normalize ()=0
virtual bool isSupported (const XMLCh *feature, const XMLCh *version) const=0
virtual const XMLCh * getNamespaceURI () const=0
virtual const XMLCh * getPrefix () const=0
virtual const XMLCh * getLocalName () const=0
virtual void setPrefix (const XMLCh *prefix)=0
virtual bool hasAttributes () const=0

Protected Methods

Constructors and assignment operators
 IDOM_Node ()
 IDOM_Node (const IDOM_Node &other)
IDOM_Node & operator= (const IDOM_Node &other)

Detailed Description

The Node interface is the primary datatype for the entire Document Object Model.

It represents a single node in the document tree. While all objects implementing the Node interface expose methods for dealing with children, not all objects implementing the Node interface may have children. For example, Text nodes may not have children, and adding children to such nodes results in a DOMException being raised.

The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specific nodeType (e.g., nodeValue for an Element or attributes for a Comment), this returns null. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.

Constructor & Destructor Documentation

IDOM_Node::IDOM_Node (    )  [inline, protected]
 

Default constructor for IDOM_Node. Protected, because IDOM_Node is an abstract base class.

IDOM_Node::IDOM_Node (  const IDOM_Node &    other )  [inline, protected]
 

Copy constructor.

Parameters:
other The object to be copied.

virtual IDOM_Node::~IDOM_Node (    )  [inline, virtual]
 

Destructor for IDOM_Node.

Member Function Documentation

virtual IDOM_Node* IDOM_Node::appendChild (  IDOM_Node *    newChild )  [pure virtual]
 

Adds the node newChild to the end of the list of children of this node.

If the newChild is already in the tree, it is first removed.

Parameters:
newChild The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node
Returns:
The node added.
Exceptions:
DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the node being appended is readonly.

virtual IDOM_Node* IDOM_Node::cloneNode (  bool    deep )  const [pure virtual]
 

Returns a duplicate of this node.

This function serves as a generic copy constructor for nodes.

The duplicate node has no parent ( parentNode returns null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.

Parameters:
deep If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

virtual IDOM_NamedNodeMap* IDOM_Node::getAttributes (    )  const [pure virtual]
 

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

virtual IDOM_NodeList* IDOM_Node::getChildNodes (    )  const [pure virtual]
 

Gets a NodeList that contains all children of this node.

If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

virtual IDOM_Node* IDOM_Node::getFirstChild (    )  const [pure virtual]
 

Gets the first child of this node.

If there is no such node, this returns null.

virtual IDOM_Node* IDOM_Node::getLastChild (    )  const [pure virtual]
 

Gets the last child of this node.

If there is no such node, this returns null.

virtual const XMLCh* IDOM_Node::getLocalName (    )  const [pure virtual]
 

Returns the local part of the qualified name of this node.

For nodes created with a DOM Level 1 method, such as createElement from the IDOM_Document interface, it is null.

virtual const XMLCh* IDOM_Node::getNamespaceURI (    )  const [pure virtual]
 

Get the namespace URI of this node, or null if it is unspecified.

This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the IDOM_Document interface, this is always null.

virtual IDOM_Node* IDOM_Node::getNextSibling (    )  const [pure virtual]
 

Gets the node immediately following this node.

If there is no such node, this returns null.

virtual const XMLCh* IDOM_Node::getNodeName (    )  const [pure virtual]
 

The name of this node, depending on its type; see the table above.

virtual short IDOM_Node::getNodeType (    )  const [pure virtual]
 

An enum value representing the type of the underlying object.

virtual const XMLCh* IDOM_Node::getNodeValue (    )  const [pure virtual]
 

Gets the value of this node, depending on its type.

Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

virtual IDOM_Document* IDOM_Node::getOwnerDocument (    )  const [pure virtual]
 

Gets the IDOM_Document object associated with this node.

This is also the IDOM_Document object used to create new nodes. When this node is a IDOM_Document or a IDOM_DocumentType which is not used with any IDOM_Document yet, this is null.

virtual IDOM_Node* IDOM_Node::getParentNode (    )  const [pure virtual]
 

Gets the parent of this node.

All nodes, except Document, DocumentFragment, and Attr may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, a null IDOM_Node is returned.

virtual const XMLCh* IDOM_Node::getPrefix (    )  const [pure virtual]
 

Get the namespace prefix of this node, or null if it is unspecified.

virtual IDOM_Node* IDOM_Node::getPreviousSibling (    )  const [pure virtual]
 

Gets the node immediately preceding this node.

If there is no such node, this returns null.

virtual bool IDOM_Node::hasAttributes (    )  const [pure virtual]
 

Returns whether this node (if it is an element) has any attributes.

Returns:
true if this node has any attributes, false otherwise.

virtual bool IDOM_Node::hasChildNodes (    )  const [pure virtual]
 

This is a convenience method to allow easy determination of whether a node has any children.

Returns:
true if the node has any children, false if the node has no children.

virtual IDOM_Node* IDOM_Node::insertBefore (  IDOM_Node *    newChild,
IDOM_Node *    refChild
)  [pure virtual]
 

Inserts the node newChild before the existing child node refChild.

If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed. Note that a IDOM_Node that has never been assigned to refer to an actual node is == null.

Parameters:
newChild The node to insert.
refChild The reference node, i.e., the node before which the new node must be inserted.
Returns:
The node being inserted.
Exceptions:
DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

virtual bool IDOM_Node::isSupported (  const XMLCh *    feature,
const XMLCh *    version
)  const [pure virtual]
 

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Parameters:
feature The string of the feature to test. This is the same name as what can be passed to the method hasFeature on IDOM_DOMImplementation.
version This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.
Returns:
Returns true if the specified feature is supported on this node, false otherwise.

virtual void IDOM_Node::normalize (    )  [pure virtual]
 

Puts all IDOM_Text nodes in the full depth of the sub-tree underneath this IDOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates IDOM_Text nodes, i.e., there are neither adjacent IDOM_Text nodes nor empty IDOM_Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.

Note: In cases where the document contains IDOM_CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between IDOM_Text nodes and IDOM_CDATASection nodes.

IDOM_Node& IDOM_Node::operator= (  const IDOM_Node &    other )  [inline, protected]
 

Assignment operator.

Parameters:
other The source to be assigned.

virtual IDOM_Node* IDOM_Node::removeChild (  IDOM_Node *    oldChild )  [pure virtual]
 

Removes the child node indicated by oldChild from the list of children, and returns it.

Parameters:
oldChild The node being removed.
Returns:
The node removed.
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

virtual IDOM_Node* IDOM_Node::replaceChild (  IDOM_Node *    newChild,
IDOM_Node *    oldChild
)  [pure virtual]
 

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

If newChild is a IDOM_DocumentFragment object, oldChild is replaced by all of the IDOM_DocumentFragment children, which are inserted in the same order.

If the newChild is already in the tree, it is first removed.

Parameters:
newChild The new node to put in the child list.
oldChild The node being replaced in the list.
Returns:
The node replaced.
Exceptions:
DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or it the node to put in is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

virtual void IDOM_Node::setNodeValue (  const XMLCh *    nodeValue )  [pure virtual]
 

Sets the value of the node.

Any node which can have a nodeValue (

See also:
getNodeValue) will also accept requests to set it to a string. The exact response to this varies from node to node -- Attribute, for example, stores its values in its children and has to replace them with a new Text holding the replacement value.
For most types of Node, value is null and attempting to set it will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will also be thrown if the node is read-only.

virtual void IDOM_Node::setPrefix (  const XMLCh *    prefix )  [pure virtual]
 

Set the namespace prefix of this node.

Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the IDOM_Element and IDOM_Attr interfaces, when applicable.

Note also that changing the prefix of an attribute, that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.

Parameters:
prefix The prefix of this node.
Exceptions:
DOMException INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns".

The documentation for this class was generated from the following file:
Generated on Tue Nov 19 09:36:43 2002 by doxygen1.3-rc1