All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oracle.xml.parser.XMLNode

java.lang.Object
   |
   +----oracle.xml.parser.XMLNode

public class XMLNode
extends Object
implements Node, EntityReference, Cloneable, Serializable
Implements the DOM Node interface and serves as the primary datatype for the entire Document Object Model. It represents a single node in the document tree.

The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived instance. 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 derived classes may contain additional and more convenient mechanisms to get and set the relevant information.


Variable Index

 o ATTRDECL
A attribute declaration node
 o ELEMENTDECL
An element declaration node.
 o IGNORESECTION
IGNORE conditional section
 o INCLUDESECTION
INCLUDE conditional section

Constructor Index

 o XMLNode(String, short)
Constructs a new XMLNode having the given name and type

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()
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
 o getChildNodes()
Gets a NodeList that contains all children of this node.
 o getFirstChild()
Gets the first child of this node.
 o getLastChild()
Gets the last child of this node.
 o getNextSibling()
Gets The node immediately following this node.
 o getNodeName()
Gets the name of this node, depending on its type
 o getNodeType()
Gets a code representing the type of the underlying object
 o getNodeValue()
Gets the value of this node, depending on its type
 o getOwnerDocument()
Gets the Document object associated with this node.
 o getParentNode()
Gets the parent of this node.
 o getPreviousSibling()
Gets 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)
Sets the value of this node, depending on its type

Variables

 o ELEMENTDECL
 public static final short ELEMENTDECL
An element declaration node.

 o ATTRDECL
 public static final short ATTRDECL
A attribute declaration node

 o INCLUDESECTION
 public static final short INCLUDESECTION
INCLUDE conditional section

 o IGNORESECTION
 public static final short IGNORESECTION
IGNORE conditional section

Constructors

 o XMLNode
 public XMLNode(String tag,
                short type)
Constructs a new XMLNode having the given name and type

Parameters:
tag - Name of the node
type - Type of the node

Methods

 o getNodeName
 public String getNodeName()
Gets the name of this node, depending on its type

Returns:
Name of this node
 o getNodeValue
 public String getNodeValue() throws DOMException
Gets the value of this node, depending on its type

Returns:
Value of this node
Throws: DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
 o setNodeValue
 public void setNodeValue(String nodeValue) throws DOMException
Sets the value of this node, depending on its type

Throws: DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
 o getNodeType
 public short getNodeType()
Gets a code representing the type of the underlying object

Returns:
type of the node
 o getParentNode
 public Node getParentNode()
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, this is null.

Returns:
The parent of this node
 o getChildNodes
 public NodeList getChildNodes()
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.

Returns:
The children of this node
 o getFirstChild
 public Node getFirstChild()
Gets the first child of this node. If there is no such node, this returns null.

Returns:
The first child of this node
 o getLastChild
 public Node getLastChild()
Gets the last child of this node. If there is no such node, this returns null.

Returns:
The last child of this node
 o getPreviousSibling
 public Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no such node, this returns null.

Returns:
the previous node
 o getNextSibling
 public Node getNextSibling()
Gets The node immediately following this node. If there is no such node, this returns null.

Returns:
the next node
 o getAttributes
 public NamedNodeMap getAttributes()
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Returns:
the attributes of this node
 o getOwnerDocument
 public Document getOwnerDocument()
Gets 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.

Returns:
The document associated with this node
 o insertBefore
 public 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 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 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 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 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 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