net.sf.saxon.dom

Class NodeOverNodeInfo

public abstract class NodeOverNodeInfo extends Object implements Node

This class implements the DOM Node interface as a wrapper around a Saxon NodeInfo object.

The class provides read-only access to the tree; methods that request updates all fail with an UnsupportedOperationException.

Field Summary
protected NodeInfonode
Method Summary
NodeappendChild(Node newChild)
Adds the node newChild to the end of the list of children of this node.
NodecloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
shortcompareDocumentPosition(Node other)
Compare the position of the (other) node in document order with the reference node (this node).
protected static voiddisallowUpdate()
Internal method used to indicate that update operations are not allowed
NamedNodeMapgetAttributes()
Return a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
StringgetBaseURI()
Get the base URI for the node.
NodeListgetChildNodes()
Return a NodeList that contains all children of this node.
ObjectgetFeature(String feature, String version)
Get a feature of this node.
NodegetFirstChild()
Get first child
NodegetLastChild()
Get last child
StringgetLocalName()
Get the local name of this node, following the DOM rules
StringgetNamespaceURI()
The namespace URI of this node, or null if it is unspecified.
NodegetNextSibling()
Get next sibling node
StringgetNodeName()
Get the name of this node, following the DOM rules
shortgetNodeType()
Get the type of this node (node kind, in XPath terminology).
StringgetNodeValue()
Get the node value (as defined in the DOM).
DocumentgetOwnerDocument()
Return the Document object associated with this node.
NodegetParentNode()
Find the parent node of this node.
StringgetPrefix()
The namespace prefix of this node, or null if it is unspecified.
NodegetPreviousSibling()
Get the previous sibling of the node
StringgetTextContent()
Get the text content of a node.
NodeInfogetUnderlyingNodeInfo()
Get the Saxon NodeInfo object representing this node
ObjectgetUserData(String key)
Get user data associated with this node.
booleanhasAttributes()
Returns whether this node has any attributes.
booleanhasChildNodes()
Determine whether the node has any children.
NodeinsertBefore(Node newChild, Node refChild)
Insert the node newChild before the existing child node refChild.
booleanisDefaultNamespace(String namespaceURI)
Test whether a particular namespace is the default namespace.
booleanisEqualNode(Node arg)
Compare whether two nodes have the same content.
booleanisSameNode(Node other)
Determine whether this is the same node as another node.
booleanisSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
StringlookupNamespaceURI(String prefix)
Find the URI corresponding to a given in-scope prefix
StringlookupPrefix(String namespaceURI)
Get the (first) prefix assigned to a specified namespace URI, or null if the namespace is not in scope.
voidnormalize()
Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.
NoderemoveChild(Node oldChild)
Remove the child node indicated by oldChild from the list of children, and returns it.
NodereplaceChild(Node newChild, Node oldChild)
Replace the child node oldChild with newChild in the list of children, and returns the oldChild node.
voidsetNodeValue(String nodeValue)
Set the node value.
voidsetPrefix(String prefix)
Set the namespace prefix of this node.
voidsetTextContent(String textContent)
Set the text content of a node.
ObjectsetUserData(String key, Object data, UserDataHandler handler)
Set user data.
static NodeOverNodeInfowrap(NodeInfo node)
Factory method to construct a DOM node that wraps an underlying Saxon NodeInfo

Field Detail

node

protected NodeInfo node

Method Detail

appendChild

public Node appendChild(Node newChild)
Adds the node newChild to the end of the list of children of this node. Always fails.

Parameters: newChild The node to add.

Returns: The node added.

Throws: org.w3c.dom.DOMException
NO_MODIFICATION_ALLOWED_ERR: Always raised.

cloneNode

public Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. Always fails.

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.

compareDocumentPosition

public short compareDocumentPosition(Node other)
Compare the position of the (other) node in document order with the reference node (this node). DOM Level 3 method.

Parameters: other the other node.

Returns: Returns how the node is positioned relatively to the reference node.

Throws: org.w3c.dom.DOMException

disallowUpdate

protected static void disallowUpdate()
Internal method used to indicate that update operations are not allowed

getAttributes

public NamedNodeMap getAttributes()
Return a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. Note that this implementation does not treat namespace declarations as attributes.

getBaseURI

public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.

getChildNodes

public NodeList getChildNodes()
Return a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

getFeature

public Object getFeature(String feature, String version)
Get a feature of this node. DOM Level 3 method, always returns null.

Parameters: feature the required feature version the version of the required feature

Returns: the value of the feature. Always null in this implementation

getFirstChild

public Node getFirstChild()
Get first child

Returns: the first child node of this node, or null if it has no children

getLastChild

public Node getLastChild()
Get last child

Returns: last child of this node, or null if it has no children

getLocalName

public String getLocalName()
Get the local name of this node, following the DOM rules

Returns: The local name of the node. For an element this is the local part of the element name, for an attribute it is the local part of the attribute name. Other node types return null.

getNamespaceURI

public String getNamespaceURI()
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 Document interface, this is always null . Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

Since: DOM Level 2

getNextSibling

public Node getNextSibling()
Get next sibling node

Returns: The next sibling node. Returns null if the current node is the last child of its parent.

getNodeName

public String getNodeName()
Get the name of this node, following the DOM rules

Returns: The name of the node. For an element this is the element name, for an attribute it is the attribute name, as a lexical QName. Other node types return conventional names such as "#text" or "#comment"

getNodeType

public short getNodeType()
Get the type of this node (node kind, in XPath terminology). Note, the numbers assigned to node kinds in Saxon (see Type) are the same as those assigned in the DOM

getNodeValue

public String getNodeValue()
Get the node value (as defined in the DOM). This is not generally the same as the XPath string-value: in particular, the node value of an element node is null.

getOwnerDocument

public Document getOwnerDocument()
Return the Document object associated with this node.

getParentNode

public Node getParentNode()
Find the parent node of this node.

Returns: The Node object describing the containing element or root node.

getPrefix

public String getPrefix()
The namespace prefix of this node, or null if it is unspecified.
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 Document interface, this is always null.

Since: DOM Level 2

getPreviousSibling

public Node getPreviousSibling()
Get the previous sibling of the node

Returns: The previous sibling node. Returns null if the current node is the first child of its parent.

getTextContent

public String getTextContent()
Get the text content of a node. This is a DOM Level 3 method. The definition is the same as the definition of the string value of a node in XPath, except in the case of document nodes.

Returns: the string value of the node, or null in the case of document nodes.

Throws: org.w3c.dom.DOMException

getUnderlyingNodeInfo

public NodeInfo getUnderlyingNodeInfo()
Get the Saxon NodeInfo object representing this node

Returns: the Saxon NodeInfo object

getUserData

public Object getUserData(String key)
Get user data associated with this node. DOM Level 3 method, always returns null in this implementation

Parameters: key identifies the user data required

Returns: always null in this implementation

hasAttributes

public boolean hasAttributes()
Returns whether this node has any attributes. Note that this implementation does not treat namespace declarations as attributes.

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

Since: DOM Level 2

hasChildNodes

public boolean hasChildNodes()
Determine whether the node has any children.

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

insertBefore

public Node insertBefore(Node newChild, Node refChild)
Insert the node newChild before the existing child node refChild. Always fails.

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 NO_MODIFICATION_ALLOWED_ERR: Always raised.

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)
Test whether a particular namespace is the default namespace. DOM Level 3 method.

Parameters: namespaceURI the namespace to be tested

Returns: true if this is the default namespace

isEqualNode

public boolean isEqualNode(Node arg)
Compare whether two nodes have the same content. This is a DOM Level 3 method.

Parameters: arg The node to be compared. This must wrap a Saxon NodeInfo.

Returns: true if the two nodes are deep-equal.

isSameNode

public final boolean isSameNode(Node other)
Determine whether this is the same node as another node. DOM Level 3 method.

Returns: true if this Node object and the supplied Node object represent the same node in the tree.

isSupported

public boolean isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Parameters: feature The name of the feature to test. This is the same name which can be passed to the method hasFeature on 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.

Since: DOM Level 2

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)
Find the URI corresponding to a given in-scope prefix

Parameters: prefix The namespace prefix whose namespace URI is required.

Returns: the corresponding namespace URI, or null if the prefix is not declared.

lookupPrefix

public String lookupPrefix(String namespaceURI)
Get the (first) prefix assigned to a specified namespace URI, or null if the namespace is not in scope. DOM Level 3 method.

Parameters: namespaceURI the namespace whose prefix is required

Returns: the corresponding prefix, if there is one, or null if not.

normalize

public void normalize()
Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

Since: DOM Level 2

removeChild

public Node removeChild(Node oldChild)
Remove the child node indicated by oldChild from the list of children, and returns it. Always fails.

Parameters: oldChild The node being removed.

Returns: The node removed.

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Always raised.

replaceChild

public Node replaceChild(Node newChild, Node oldChild)
Replace the child node oldChild with newChild in the list of children, and returns the oldChild node. Always fails.

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 NO_MODIFICATION_ALLOWED_ERR: Always raised.

setNodeValue

public void setNodeValue(String nodeValue)
Set the node value. Always fails

setPrefix

public void setPrefix(String prefix)
Set the namespace prefix of this node. Always fails.

setTextContent

public void setTextContent(String textContent)
Set the text content of a node. Always fails.

Parameters: textContent

Throws: org.w3c.dom.DOMException

setUserData

public Object setUserData(String key, Object data, UserDataHandler handler)
Set user data. Always throws UnsupportedOperationException in this implementation

Parameters: key data handler

Returns: This implementation always throws an exception

wrap

public static NodeOverNodeInfo wrap(NodeInfo node)
Factory method to construct a DOM node that wraps an underlying Saxon NodeInfo

Parameters: node the Saxon NodeInfo object

Returns: the DOM wrapper node