All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.w3c.dom.Node

public interface Node
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.


Variable Index

 o ATTRIBUTE_NODE
 o CDATA_SECTION_NODE
 o COMMENT_NODE
 o DOCUMENT_FRAGMENT_NODE
 o DOCUMENT_NODE
 o DOCUMENT_TYPE_NODE
 o ELEMENT_NODE
 o ENTITY_NODE
 o ENTITY_REFERENCE_NODE
 o NOTATION_NODE
 o PROCESSING_INSTRUCTION_NODE
 o TEXT_NODE

Method Index

 o appendChild(Node)
Adds the node newChild to the end of the list of children of this node.
 o cloneNode(boolean)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
 o getAttributes()
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
 o getChildNodes()
A NodeList that contains all children of this node.
 o getFirstChild()
The first child of this node.
 o getLastChild()
The last child of this node.
 o getNextSibling()
The node immediately following this node.
 o getNodeName()
The name of this node, depending on its type; see the table above.
 o getNodeType()
A code representing the type of the underlying object, as defined above.
 o getNodeValue()
The value of this node, depending on its type; see the table above.
 o getOwnerDocument()
The Document object associated with this node.
 o getParentNode()
The parent of this node.
 o getPreviousSibling()
The node immediately preceding this node.
 o hasChildNodes()
This is a convenience method to allow easy determination of whether a node has any children.
 o insertBefore(Node, Node)
Inserts the node newChild before the existing child node refChild.
 o removeChild(Node)
Removes the child node indicated by oldChild from the list of children, and returns it.
 o replaceChild(Node, Node)
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
 o setNodeValue(String)

Variables

 o ELEMENT_NODE
 public static final short ELEMENT_NODE
 o ATTRIBUTE_NODE
 public static final short ATTRIBUTE_NODE
 o TEXT_NODE
 public static final short TEXT_NODE
 o CDATA_SECTION_NODE
 public static final short CDATA_SECTION_NODE
 o ENTITY_REFERENCE_NODE
 public static final short ENTITY_REFERENCE_NODE
 o ENTITY_NODE
 public static final short ENTITY_NODE
 o PROCESSING_INSTRUCTION_NODE
 public static final short PROCESSING_INSTRUCTION_NODE
 o COMMENT_NODE
 public static final short COMMENT_NODE
 o DOCUMENT_NODE
 public static final short DOCUMENT_NODE
 o DOCUMENT_TYPE_NODE
 public static final short DOCUMENT_TYPE_NODE
 o DOCUMENT_FRAGMENT_NODE
 public static final short DOCUMENT_FRAGMENT_NODE
 o NOTATION_NODE
 public static final short NOTATION_NODE

Methods

 o getNodeName
 public abstract String getNodeName()
The name of this node, depending on its type; see the table above.

 o getNodeValue
 public abstract String getNodeValue() throws DOMException
The value of this node, depending on its type; see the table above.

Throws: DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Throws: DOMException
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
 o setNodeValue
 public abstract void setNodeValue(String nodeValue) throws DOMException
 o getNodeType
 public abstract short getNodeType()
A code representing the type of the underlying object, as defined above.

 o getParentNode
 public abstract Node getParentNode()
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, this is null.

 o getChildNodes
 public abstract NodeList getChildNodes()
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.

 o getFirstChild
 public abstract Node getFirstChild()
The first child of this node. If there is no such node, this returns null.

 o getLastChild
 public abstract Node getLastChild()
The last child of this node. If there is no such node, this returns null.

 o getPreviousSibling
 public abstract Node getPreviousSibling()
The node immediately preceding this node. If there is no such node, this returns null.

 o getNextSibling
 public abstract Node getNextSibling()
The node immediately following this node. If there is no such node, this returns null.

 o getAttributes
 public abstract NamedNodeMap getAttributes()
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

 o getOwnerDocument
 public abstract Document getOwnerDocument()
The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document this is null.

 o insertBefore
 public abstract Node insertBefore(Node newChild,
                                   Node refChild) throws DOMException
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.

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.
Throws: 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 is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.
 o replaceChild
 public abstract Node replaceChild(Node newChild,
                                   Node oldChild) throws DOMException
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. 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.
Throws: 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 is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
 o removeChild
 public abstract Node removeChild(Node oldChild) throws DOMException
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.
Throws: DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
 o appendChild
 public abstract Node appendChild(Node newChild) throws DOMException
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.
Throws: 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 is readonly.
 o hasChildNodes
 public abstract boolean hasChildNodes()
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.
 o cloneNode
 public abstract Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index