Package net.sf.saxon.dom
Class NodeOverNodeInfo
- java.lang.Object
-
- net.sf.saxon.dom.NodeOverNodeInfo
-
- All Implemented Interfaces:
org.w3c.dom.Node
- Direct Known Subclasses:
AttrOverNodeInfo,DocumentOverNodeInfo,ElementOverNodeInfo,PIOverNodeInfo,TextOverNodeInfo
public abstract class NodeOverNodeInfo extends java.lang.Object implements org.w3c.dom.NodeThis 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
Fields Modifier and Type Field Description protected NodeInfonode-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Constructor Summary
Constructors Constructor Description NodeOverNodeInfo()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description org.w3c.dom.NodeappendChild(org.w3c.dom.Node newChild)Adds the nodenewChildto the end of the list of children of this node.org.w3c.dom.NodecloneNode(boolean deep)Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.shortcompareDocumentPosition(org.w3c.dom.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 allowedbooleanequals(java.lang.Object obj)The equals() method returns true for two Node objects that represent the same conceptual DOM Node.org.w3c.dom.NamedNodeMapgetAttributes()Return aNamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.java.lang.StringgetBaseURI()Get the base URI for the node.org.w3c.dom.NodeListgetChildNodes()Return aNodeListthat contains all children of this node.java.lang.ObjectgetFeature(java.lang.String feature, java.lang.String version)Get a feature of this node.org.w3c.dom.NodegetFirstChild()Get first childorg.w3c.dom.NodegetLastChild()Get last childjava.lang.StringgetLocalName()Get the local name of this node, following the DOM rulesjava.lang.StringgetNamespaceURI()The namespace URI of this node, ornullif it is unspecified.org.w3c.dom.NodegetNextSibling()Get next sibling nodejava.lang.StringgetNodeName()Get the name of this node, following the DOM rulesshortgetNodeType()Get the type of this node (node kind, in XPath terminology).java.lang.StringgetNodeValue()Get the node value (as defined in the DOM).org.w3c.dom.DocumentgetOwnerDocument()Return theDocumentobject associated with this node.org.w3c.dom.NodegetParentNode()Find the parent node of this node.java.lang.StringgetPrefix()The namespace prefix of this node, ornullif it is unspecified.org.w3c.dom.NodegetPreviousSibling()Get the previous sibling of the nodejava.lang.StringgetTextContent()Get the text content of a node.NodeInfogetUnderlyingNodeInfo()Get the Saxon NodeInfo object representing this nodejava.lang.ObjectgetUserData(java.lang.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.inthashCode()Return a hashCodeorg.w3c.dom.NodeinsertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)Insert the nodenewChildbefore the existing child noderefChild.booleanisDefaultNamespace(java.lang.String namespaceURI)Test whether a particular namespace is the default namespace.booleanisEqualNode(org.w3c.dom.Node arg)Compare whether two nodes have the same content.booleanisSameNode(org.w3c.dom.Node other)Determine whether this is the same node as another node.booleanisSupported(java.lang.String feature, java.lang.String version)Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.java.lang.StringlookupNamespaceURI(java.lang.String prefix)Find the URI corresponding to a given in-scope prefixjava.lang.StringlookupPrefix(java.lang.String namespaceURI)Get the (first) prefix assigned to a specified namespace URI, or null if the namespace is not in scope.voidnormalize()Puts allTextnodes in the full depth of the sub-tree underneath thisNode, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesTextnodes, i.e., there are neither adjacentTextnodes nor emptyTextnodes.org.w3c.dom.NoderemoveChild(org.w3c.dom.Node oldChild)Remove the child node indicated byoldChildfrom the list of children, and returns it.org.w3c.dom.NodereplaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)Replace the child nodeoldChildwithnewChildin the list of children, and returns theoldChildnode.voidsetNodeValue(java.lang.String nodeValue)Set the node value.voidsetPrefix(java.lang.String prefix)Set the namespace prefix of this node.voidsetTextContent(java.lang.String textContent)Set the text content of a node.java.lang.ObjectsetUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.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
-
getUnderlyingNodeInfo
public NodeInfo getUnderlyingNodeInfo()
Get the Saxon NodeInfo object representing this node- Returns:
- the Saxon NodeInfo object
-
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
-
isSameNode
public final boolean isSameNode(org.w3c.dom.Node other)
Determine whether this is the same node as another node. DOM Level 3 method.- Specified by:
isSameNodein interfaceorg.w3c.dom.Node- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
-
equals
public boolean equals(java.lang.Object obj)
The equals() method returns true for two Node objects that represent the same conceptual DOM Node. This is a concession to the Xalan IdentityTransformer, which relies on equals() for DOM Nodes having this behaviour, even though it is not defined in the specification- Overrides:
equalsin classjava.lang.Object- Parameters:
obj- the object to be compared- Returns:
- if this node and obj represent the same conceptual DOM node. That is, return true if isSameNode((Node)obj) returns true
-
hashCode
public int hashCode()
Return a hashCode- Overrides:
hashCodein classjava.lang.Object- Returns:
- a hashCode such that two wrappers over the same underlying node have the same hashCode.
-
getBaseURI
public java.lang.String getBaseURI()
Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.- Specified by:
getBaseURIin interfaceorg.w3c.dom.Node
-
getNodeName
public java.lang.String getNodeName()
Get the name of this node, following the DOM rules- Specified by:
getNodeNamein interfaceorg.w3c.dom.Node- 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"
-
getLocalName
public java.lang.String getLocalName()
Get the local name of this node, following the DOM rules- Specified by:
getLocalNamein interfaceorg.w3c.dom.Node- 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.
-
hasChildNodes
public boolean hasChildNodes()
Determine whether the node has any children.- Specified by:
hasChildNodesin interfaceorg.w3c.dom.Node- Returns:
trueif this node has any attributes,falseotherwise.
-
hasAttributes
public boolean hasAttributes()
Returns whether this node has any attributes. We treat the declaration of the XML namespace as being present on every element, and since namespace declarations are treated as attributes, every element has at least one attribute. This method therefore returns true.- Specified by:
hasAttributesin interfaceorg.w3c.dom.Node- Returns:
trueif this node has any attributes,falseotherwise.- Since:
- DOM Level 2
-
getNodeType
public short getNodeType()
Get the type of this node (node kind, in XPath terminology). Note, the numbers assigned to node kinds in Saxon (seeType) are the same as those assigned in the DOM- Specified by:
getNodeTypein interfaceorg.w3c.dom.Node
-
getParentNode
public org.w3c.dom.Node getParentNode()
Find the parent node of this node.- Specified by:
getParentNodein interfaceorg.w3c.dom.Node- Returns:
- The Node object describing the containing element or root node.
-
getPreviousSibling
public org.w3c.dom.Node getPreviousSibling()
Get the previous sibling of the node- Specified by:
getPreviousSiblingin interfaceorg.w3c.dom.Node- Returns:
- The previous sibling node. Returns null if the current node is the first child of its parent.
-
getNextSibling
public org.w3c.dom.Node getNextSibling()
Get next sibling node- Specified by:
getNextSiblingin interfaceorg.w3c.dom.Node- Returns:
- The next sibling node. Returns null if the current node is the last child of its parent.
-
getFirstChild
public org.w3c.dom.Node getFirstChild()
Get first child- Specified by:
getFirstChildin interfaceorg.w3c.dom.Node- Returns:
- the first child node of this node, or null if it has no children
-
getLastChild
public org.w3c.dom.Node getLastChild()
Get last child- Specified by:
getLastChildin interfaceorg.w3c.dom.Node- Returns:
- last child of this node, or null if it has no children
-
getNodeValue
public java.lang.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.- Specified by:
getNodeValuein interfaceorg.w3c.dom.Node
-
setNodeValue
public void setNodeValue(java.lang.String nodeValue) throws org.w3c.dom.DOMExceptionSet the node value. Always fails- Specified by:
setNodeValuein interfaceorg.w3c.dom.Node- Throws:
org.w3c.dom.DOMException
-
getChildNodes
public org.w3c.dom.NodeList getChildNodes()
Return aNodeListthat contains all children of this node. If there are no children, this is aNodeListcontaining no nodes.- Specified by:
getChildNodesin interfaceorg.w3c.dom.Node
-
getAttributes
public org.w3c.dom.NamedNodeMap getAttributes()
Return aNamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.- Specified by:
getAttributesin interfaceorg.w3c.dom.Node
-
getOwnerDocument
public org.w3c.dom.Document getOwnerDocument()
Return theDocumentobject associated with this node.- Specified by:
getOwnerDocumentin interfaceorg.w3c.dom.Node
-
insertBefore
public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) throws org.w3c.dom.DOMExceptionInsert the nodenewChildbefore the existing child noderefChild. Always fails.- Specified by:
insertBeforein interfaceorg.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- NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
replaceChild
public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMExceptionReplace the child nodeoldChildwithnewChildin the list of children, and returns theoldChildnode. Always fails.- Specified by:
replaceChildin interfaceorg.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- NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
removeChild
public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMExceptionRemove the child node indicated byoldChildfrom the list of children, and returns it. Always fails.- Specified by:
removeChildin interfaceorg.w3c.dom.Node- Parameters:
oldChild- The node being removed.- Returns:
- The node removed.
- Throws:
org.w3c.dom.DOMException- NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
appendChild
public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild) throws org.w3c.dom.DOMExceptionAdds the nodenewChildto the end of the list of children of this node. Always fails.- Specified by:
appendChildin interfaceorg.w3c.dom.Node- Parameters:
newChild- The node to add.- Returns:
- The node added.
- Throws:
org.w3c.dom.DOMException-
NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
cloneNode
public org.w3c.dom.Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. Always fails.- Specified by:
cloneNodein interfaceorg.w3c.dom.Node- Parameters:
deep- Iftrue, recursively clone the subtree under the specified node; iffalse, clone only the node itself (and its attributes, if it is anElement).- Returns:
- The duplicate node.
-
normalize
public void normalize()
Puts allTextnodes in the full depth of the sub-tree underneath thisNode, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesTextnodes, i.e., there are neither adjacentTextnodes nor emptyTextnodes.- Specified by:
normalizein interfaceorg.w3c.dom.Node- Since:
- DOM Level 2
-
isSupported
public boolean isSupported(java.lang.String feature, java.lang.String version)Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.- Specified by:
isSupportedin interfaceorg.w3c.dom.Node- Parameters:
feature- The name of the feature to test. This is the same name which can be passed to the methodhasFeatureonDOMImplementation.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 returntrue.- Returns:
- Returns
trueif the specified feature is supported on this node,falseotherwise. - Since:
- DOM Level 2
-
getNamespaceURI
public java.lang.String getNamespaceURI()
The namespace URI of this node, ornullif 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 thanELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDocumentinterface, this is alwaysnull. 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.- Specified by:
getNamespaceURIin interfaceorg.w3c.dom.Node- Since:
- DOM Level 2
-
getPrefix
public java.lang.String getPrefix()
The namespace prefix of this node, ornullif it is unspecified.
For nodes of any type other thanELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDocumentinterface, this is alwaysnull.- Specified by:
getPrefixin interfaceorg.w3c.dom.Node- Since:
- DOM Level 2
-
setPrefix
public void setPrefix(java.lang.String prefix) throws org.w3c.dom.DOMExceptionSet the namespace prefix of this node. Always fails.- Specified by:
setPrefixin interfaceorg.w3c.dom.Node- Throws:
org.w3c.dom.DOMException
-
compareDocumentPosition
public short compareDocumentPosition(org.w3c.dom.Node other) throws org.w3c.dom.DOMExceptionCompare the position of the (other) node in document order with the reference node (this node). DOM Level 3 method.- Specified by:
compareDocumentPositionin interfaceorg.w3c.dom.Node- Parameters:
other- the other node.- Returns:
- Returns how the node is positioned relatively to the reference node.
- Throws:
org.w3c.dom.DOMException- if an error occurs
-
getTextContent
public java.lang.String getTextContent() throws org.w3c.dom.DOMExceptionGet 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.- Specified by:
getTextContentin interfaceorg.w3c.dom.Node- Returns:
- the string value of the node, or null in the case of document nodes.
- Throws:
org.w3c.dom.DOMException- if a dynamic error occurs
-
setTextContent
public void setTextContent(java.lang.String textContent) throws java.lang.UnsupportedOperationExceptionSet the text content of a node. Always fails.- Specified by:
setTextContentin interfaceorg.w3c.dom.Node- Parameters:
textContent- the new text content of the node- Throws:
java.lang.UnsupportedOperationException- always
-
lookupPrefix
public java.lang.String lookupPrefix(java.lang.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.- Specified by:
lookupPrefixin interfaceorg.w3c.dom.Node- Parameters:
namespaceURI- the namespace whose prefix is required- Returns:
- the corresponding prefix, if there is one, or null if not.
-
isDefaultNamespace
public boolean isDefaultNamespace(java.lang.String namespaceURI)
Test whether a particular namespace is the default namespace. DOM Level 3 method.- Specified by:
isDefaultNamespacein interfaceorg.w3c.dom.Node- Parameters:
namespaceURI- the namespace to be tested- Returns:
- true if this is the default namespace
-
lookupNamespaceURI
public java.lang.String lookupNamespaceURI(java.lang.String prefix)
Find the URI corresponding to a given in-scope prefix- Specified by:
lookupNamespaceURIin interfaceorg.w3c.dom.Node- Parameters:
prefix- The namespace prefix whose namespace URI is required.- Returns:
- the corresponding namespace URI, or null if the prefix is not declared.
-
isEqualNode
public boolean isEqualNode(org.w3c.dom.Node arg)
Compare whether two nodes have the same content. This is a DOM Level 3 method.- Specified by:
isEqualNodein interfaceorg.w3c.dom.Node- Parameters:
arg- The node to be compared. This must wrap a Saxon NodeInfo.- Returns:
- true if the two nodes are deep-equal.
-
getFeature
public java.lang.Object getFeature(java.lang.String feature, java.lang.String version)Get a feature of this node. DOM Level 3 method, always returns null.- Specified by:
getFeaturein interfaceorg.w3c.dom.Node- Parameters:
feature- the required featureversion- the version of the required feature- Returns:
- the value of the feature. Always null in this implementation
-
setUserData
public java.lang.Object setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)Set user data. Always throws UnsupportedOperationException in this implementation- Specified by:
setUserDatain interfaceorg.w3c.dom.Node- Parameters:
key- name of the user datadata- value of the user datahandler- handler for the user data- Returns:
- This implementation always throws an exception
-
getUserData
public java.lang.Object getUserData(java.lang.String key)
Get user data associated with this node. DOM Level 3 method, always returns null in this implementation- Specified by:
getUserDatain interfaceorg.w3c.dom.Node- Parameters:
key- identifies the user data required- Returns:
- always null in this implementation
-
disallowUpdate
protected static void disallowUpdate() throws org.w3c.dom.DOMExceptionInternal method used to indicate that update operations are not allowed- Throws:
org.w3c.dom.DOMException- always, to indicate that update is not supported in this DOM implementation
-
-