All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oracle.xml.parser.v2.XMLNode

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

public class XMLNode

extends Object

implements Node, XMLConstants, Cloneable, Serializable

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.

ATTRDECL

A attribute declaration node

ELEMENTDECL

An element declaration node.

appendChild(Node)

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

cloneNode(boolean)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

getAttributes()

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

getChildNodes()

Gets a NodeList that contains all children of this node.

getColumnNumber()

Get column number debug information

getDebugMode()

Get debug information mode

getFirstChild()

Gets the first child of this node.

getLastChild()

Gets the last child of this node.

getLineNumber()

Get line number debug information

getNextSibling()

Gets The node immediately following this node.

getNodeName()

Gets the name of this node, depending on its type

getNodeType()

Gets a code representing the type of the underlying object

getNodeValue()

Gets the value of this node, depending on its type

getOwnerDocument()

Gets the Document object associated with this node.

getParentNode()

Gets the parent of this node.

getPreviousSibling()

Gets the node immediately preceding this node.

getSystemId()

Get the system id of the entity contain this node

hasChildNodes()

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

insertBefore(Node, Node)

Inserts the node newChild before the existing child node refChild.

print(OutputStream)

Writes the contents of this node to the given output stream.

print(OutputStream, String)

Writes the contents of this node to the given output stream.

print(PrintWriter)

Writes the contents of this node using the given print writer.

removeChild(Node)

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

replaceChild(Node, Node)

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

selectNodes(String)

Selects nodes from the tree which match the given pattern.

selectNodes(String, NSResolver)

Selects nodes from the tree which match the given pattern

selectSingleNode(String)

Selects the first node from the tree that matches the given pattern

selectSingleNode(String, NSResolver)

Selects the first node from the tree that matches the given pattern

setDebugInfo(int, int, String)

Set debug information in the node

setNodeValue(String)

Sets the value of this node, depending on its type

transformNode(XSLStylesheet)

Transforms a node in the tree using the given stylesheet

valueOf(String)

Selects the value of the first node from the tree that matches the given pattern

valueOf(String, NSResolver)

Selects the value of the first node from the tree that matches the given pattern

 public static final short ELEMENTDECL

An element declaration node.

 public static final short ATTRDECL

A attribute declaration node

 public String getNodeName()

Gets the name of this node, depending on its type

Returns:

Name of this node

 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.

 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.

 public short getNodeType()

Gets a code representing the type of the underlying object

Returns:

type of the node

 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

 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

 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

 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

 public Node getPreviousSibling()

Gets the node immediately preceding this node. If there is no such node, this returns null.

Returns:

the previous node

 public Node getNextSibling()

Gets The node immediately following this node. If there is no such node, this returns null.

Returns:

the next node

 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

 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

 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.

 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.

 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.

 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.

 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.

 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.

 public DocumentFragment transformNode(XSLStylesheet xsl) throws XSLException

Transforms a node in the tree using the given stylesheet

Parameters:

xsl - XSLStylesheet to be used for transformation

Returns:

a document fragment

Throws: XSLException

Raised if there is an error while doing the XSL transformation.

 public NodeList selectNodes(String pattern,
                             NSResolver nsr) throws XSLException

Selects nodes from the tree which match the given pattern

Parameters:

pattern - XSL pattern to match

nsr - NSResolver to resolve any namespace prefixes that occur in the given pattern

Returns:

a list of matching nodes

Throws: XSLException

Raised if there is an error while doing the match

 public NodeList selectNodes(String pattern) throws XSLException

Selects nodes from the tree which match the given pattern. This method assumes that the pattern does not contain namespace prefixes.

Parameters:

pattern - XSL pattern to match

Returns:

a list of matching nodes

Throws: XSLException

Raised if there is an error while doing the match

 public Node selectSingleNode(String pattern,
                              NSResolver nsr) throws XSLException

Selects the first node from the tree that matches the given pattern

Parameters:

pattern - XSL pattern to match

nsr - NSResolver to resolve any prefixes that occur in given pattern

Returns:

matching node

Throws: XSLException

Raised if there is an error while doing the match

 public Node selectSingleNode(String pattern) throws XSLException

Selects the first node from the tree that matches the given pattern

Parameters:

pattern - XSL pattern to match

Returns:

matching node

Throws: XSLException

Raised if there is an error while doing the match

 public String valueOf(String pattern,
                       NSResolver nsr) throws XSLException

Selects the value of the first node from the tree that matches the given pattern

Parameters:

pattern - XSL pattern to match

nsr - NSResolver to resolve any prefixes that occur in given pattern

Returns:

value of the matching node

Throws: XSLException

Raised if there is an error while doing the match

 public String valueOf(String pattern) throws XSLException

Selects the value of the first node from the tree that matches the given pattern

Parameters:

pattern - XSL pattern to match

Returns:

value of the matching node

Throws: XSLException

Raised if there is an error while doing the match

 public void print(PrintWriter out) throws IOException

Writes the contents of this node using the given print writer.

Parameters:

out - PrintWriter to use

Throws: IOException

if an error occurs

 public void print(OutputStream out) throws IOException

Writes the contents of this node to the given output stream.

Parameters:

out - OutputStream to write to

Throws: IOException

if an error occurs

 public void print(OutputStream out,
                   String enc) throws IOException

Writes the contents of this node to the given output stream.

Parameters:

out - OutputStream to write to

enc - Encoding to use for the output

Throws: IOException

if an invalid encoding was specified or if any other error occurs

 public void setDebugInfo(int line,
                          int col,
                          String sysid)

Set debug information in the node

Parameters:

line - the line number

col - the col number

sysid - the system id

 public boolean getDebugMode()

Get debug information mode

Returns:

flag debugging mode

 public int getLineNumber()

Get line number debug information

Returns:

line the line number

 public int getColumnNumber()

Get column number debug information

Returns:

column the column number

 public String getSystemId()

Get the system id of the entity contain this node

Returns:

sysid the system id

All Packages  Class Hierarchy  This Package  Previous  Next  Index