XMLNode - Oracle 9i

Syntax

Direct Known Subclasses
AttrDecl, oracle.xml.parser.v2.CharData, DTD, ElementDecl, XMLAttr, XMLDocument,
XMLDocumentFragment, XMLElement, XMLEntityReference

All Implemented Interfaces
java.lang.Cloneable, org.w3c.dom.Node, java.io.Serializable,
oracle.xml.parser.v2.XMLConstants

Description
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.

XML Node

XML Node

XML Node

XML Node

Fields
ATTRDECL

public static final short ATTRDECL

A attribute declaration node

ELEMENTDECL

public static final short ELEMENTDECL

An element declaration node.

Methods
appendChild(Node)

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)

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.

Specified By

org.w3c.dom.Node.appendChild(Node) in interface org.w3c.dom.Node

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
org.w3c.dom.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.

cloneNode(boolean)

public org.w3c.dom.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.

Specified By

org.w3c.dom.Node.cloneNode(boolean) in interface org.w3c.dom.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.

getAttributes()

public org.w3c.dom.NamedNodeMap getAttributes()

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

Specified By

org.w3c.dom.Node.getAttributes() in interface org.w3c.dom.Node

Returns
the attributes of this node

getChildNodes()

public org.w3c.dom.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.

Specified By

org.w3c.dom.Node.getChildNodes() in interface org.w3c.dom.Node

Returns
The children of this node

getFirstChild()

public org.w3c.dom.Node getFirstChild()

Gets the first child of this node. If there is no such node, this returns null.

Specified By

org.w3c.dom.Node.getFirstChild() in interface org.w3c.dom.Node

Returns
The first child of this node

getLastChild()

public org.w3c.dom.Node getLastChild()

Gets the last child of this node. If there is no such node, this returns null.

Specified By

org.w3c.dom.Node.getLastChild() in interface org.w3c.dom.Node

Returns
The last child of this node

getNextSibling()

public org.w3c.dom.Node getNextSibling()

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

Specified By

org.w3c.dom.Node.getNextSibling() in interface org.w3c.dom.Node

Returns
the next node

getNodeName()

public java.lang.String getNodeName()

Gets the name of this node, depending on its type

Specified By
org.w3c.dom.Node.getNodeName() in interface org.w3c.dom.Node

Returns
Name of this node

getNodeType()

public short getNodeType()

Gets a code representing the type of the underlying object

Specified By

org.w3c.dom.Node.getNodeType() in interface org.w3c.dom.Node

Returns
type of the node

getNodeValue()

public java.lang.String getNodeValue()

Gets the value of this node, depending on its type

Specified By

org.w3c.dom.Node.getNodeValue() in interface org.w3c.dom.Node

Returns
Value of this node

Throws
org.w3c.dom.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.

getOwnerDocument()

public org.w3c.dom.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.

Specified By

org.w3c.dom.Node.getOwnerDocument() in interface org.w3c.dom.Node

Returns
The document associated with this node

getParentNode()

public org.w3c.dom.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.

Specified By

org.w3c.dom.Node.getParentNode() in interface org.w3c.dom.Node

Returns
The parent of this node

getPreviousSibling()

public org.w3c.dom.Node getPreviousSibling()

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

Specified By

org.w3c.dom.Node.getPreviousSibling() in interface org.w3c.dom.Node

Returns
the previous node

hasChildNodes()

public boolean hasChildNodes()

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

Specified By

org.w3c.dom.Node.hasChildNodes() in interface org.w3c.dom.Node

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

insertBefore(Node, Node)

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)

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.

Specified By

org.w3c.dom.Node.insertBefore(Node, Node) in interface org.w3c.dom.Node

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
org.w3c.dom.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.

print(OutputStream)

public void print(java.io.OutputStream out)

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

Parameters

out - OutputStream to write to

Throws

IOException - if an error occurs

print(OutputStream, String)

public void print(java.io.OutputStream out, java.lang.String enc)

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

print(PrintWriter)

public void print(java.io.PrintWriter out)

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

Parameters

out - PrintWriter to use

Throws

IOException - if an error occurs

removeChild(Node)

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)

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

Specified By

org.w3c.dom.Node.removeChild(Node) in interface org.w3c.dom.Node

Parameters

oldChild - The node being removed.

Returns
The node removed.

Throws
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

replaceChild(Node, Node)

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild org.w3c.dom.Node oldChild)

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.

Specified By

org.w3c.dom.Node.replaceChild(Node, Node) in interface org.w3c.dom.Node

Parameters

newChild - The new node to put in the child list.
oldChild - The node being replaced in the list.

Returns
The node replaced.

Throws
org.w3c.dom.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.

selectNodes(String, NSResolver)

public org.w3c.dom.NodeList selectNodes(java.lang.String pattern, NSResolvernsr)

Selects nodes from the tree which match the given pattern

Parameters

pattern - XSL pattern to match

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

Returns
a list of matching nodes

Throws

XSLException - Raised if there is an error while doing the match

selectSingleNode(String, NSResolver)

public org.w3c.dom.Node selectSingleNode(java.lang.String pattern, NSResolvernsr)

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

setNodeValue(String)

public void setNodeValue(java.lang.String nodeValue)

Sets the value of this node, depending on its type

Specified By

org.w3c.dom.Node.setNodeValue(String) in interface org.w3c.dom.Node

Throws
org.w3c.dom.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.

transformNode(XSLStylesheet)

public org.w3c.dom.DocumentFragment transformNode(XSLStylesheet xsl)

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.

valueOf(String, NSResolver)

public java.lang.String valueOf(java.lang.String pattern, NSResolver nsr)

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

All rights reserved © 2018 Wisdom IT Services India Pvt. Ltd DMCA.com Protection Status

Oracle 9i Topics