Class DOMNodeWrapper
- java.lang.Object
-
- net.sf.saxon.tree.wrapper.AbstractNodeWrapper
-
- net.sf.saxon.dom.DOMNodeWrapper
-
- All Implemented Interfaces:
javax.xml.transform.Source,javax.xml.transform.SourceLocator,GroundedValue,Item,NodeInfo,Sequence,Location,SteppingNode<DOMNodeWrapper>,SiblingCountingNode,VirtualNode,org.xml.sax.Locator
public class DOMNodeWrapper extends AbstractNodeWrapper implements SiblingCountingNode, SteppingNode<DOMNodeWrapper>
A node in the XML parse tree representing an XML element, character content, or attribute. This is the implementation of the NodeInfo interface used as a wrapper for DOM nodes.Because the DOM is not thread-safe even when reading, and because Saxon-EE can spawn multiple threads that access the same input tree, all methods that invoke DOM methods are synchronized on the Document object.
-
-
Field Summary
Fields Modifier and Type Field Description protected DocumentWrapperdocWrapperprotected intindexprotected org.w3c.dom.Nodenodeprotected shortnodeKindprotected intspan-
Fields inherited from class net.sf.saxon.tree.wrapper.AbstractNodeWrapper
treeInfo
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
IS_DTD_TYPE, IS_NILLED
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedDOMNodeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper, DOMNodeWrapper parent, int index)This constructor is protected: nodes should be created using the makeWrapper factory method
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareOrder(NodeInfo other)Determine the relative position of this node and another node, in document order.booleanequals(java.lang.Object other)Determine whether this is the same node as another node.static voidexpandStringValue(org.w3c.dom.NodeList list, FastStringBuffer sb)voidgenerateId(FastStringBuffer buffer)Get a character string that uniquely identifies this node.NamespaceMapgetAllNamespaces()Get all the namespace bindings that are in-scope for this element.java.lang.StringgetAttributeValue(java.lang.String uri, java.lang.String local)Get the string value of a given attribute of this nodeNamespaceBinding[]getDeclaredNamespaces(NamespaceBinding[] buffer)Get all namespace undeclarations and undeclarations defined on this element.java.lang.StringgetDisplayName()Get the display name of this node.DOMNodeWrappergetFirstChild()Get the first child of this nodestatic java.lang.StringgetLocalName(org.w3c.dom.Node node)Get the local name of a DOM element or attribute node.java.lang.StringgetLocalPart()Get the local part of the name of this node.DOMNodeWrappergetNextSibling()Get the next sibling of this nodeintgetNodeKind()Return the kind of node.DOMNodeWrappergetParent()Get the NodeInfo object representing the parent of this nodejava.lang.StringgetPrefix()Get the prefix of the name of the node.DOMNodeWrappergetPreviousSibling()Get the previous sibling of this nodeNodeInfogetRoot()Get the root node - always a document node with this tree implementationintgetSiblingPosition()Get the index position of this node among its siblings (starting from 0).java.lang.CharSequencegetStringValueCS()Get the value of the item as a CharSequence.DOMNodeWrappergetSuccessorElement(DOMNodeWrapper anchor, java.lang.String uri, java.lang.String local)Find the next matching element in document order; that is, the first child element with the required name if there is one; otherwise the next sibling element if there is one; otherwise the next sibling element of the parent, grandparent, etc, up to the anchor element.DocumentWrappergetTreeInfo()Get information about the tree to which this NodeInfo belongsorg.w3c.dom.NodegetUnderlyingNode()Get the underlying DOM node, to implement the VirtualNode interfacejava.lang.StringgetURI()Get the URI part of the name of this node.booleanhasChildNodes()Determine whether the node has any children.booleanisId()Determine whether this node has the is-id propertyprotected AxisIteratoriterateAttributes(java.util.function.Predicate<? super NodeInfo> nodeTest)Return an iterator over the attributes of this element node.protected AxisIteratoriterateChildren(java.util.function.Predicate<? super NodeInfo> nodeTest)Return an iterator over the children of this node.protected AxisIteratoriterateDescendants(java.util.function.Predicate<? super NodeInfo> nodeTest, boolean includeSelf)Return an iterator over the descendants of this node.protected AxisIteratoriterateSiblings(java.util.function.Predicate<? super NodeInfo> nodeTest, boolean forwards)Return an iterator over the siblings of this node.protected static DOMNodeWrappermakeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper)Factory method to wrap a DOM node with a wrapper that implements the Saxon NodeInfo interface.protected static DOMNodeWrappermakeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper, DOMNodeWrapper parent, int index)Factory method to wrap a DOM node with a wrapper that implements the Saxon NodeInfo interface.-
Methods inherited from class net.sf.saxon.tree.wrapper.AbstractNodeWrapper
atomize, getBaseURI, getColumnNumber, getFingerprint, getLineNumber, getNamePool, getRealNode, getStringValue, getSystemId, hasFingerprint, hashCode, iterateAxis, iterateAxis, saveLocation, setSystemId
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
getLength, head, itemAt, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.s9api.Location
saveLocation
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
atomize, attributes, children, children, copy, getBaseURI, getColumnNumber, getConfiguration, getFingerprint, getGenre, getLineNumber, getPublicId, getSchemaType, getStringValue, getSystemId, hasFingerprint, hashCode, isIdref, isNilled, isSameNodeInfo, isStreamed, iterateAxis, iterateAxis, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Field Detail
-
node
protected org.w3c.dom.Node node
-
nodeKind
protected short nodeKind
-
docWrapper
protected DocumentWrapper docWrapper
-
index
protected int index
-
span
protected int span
-
-
Constructor Detail
-
DOMNodeWrapper
protected DOMNodeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper, DOMNodeWrapper parent, int index)This constructor is protected: nodes should be created using the makeWrapper factory method- Parameters:
node- The DOM node to be wrappeddocWrapper- The wrapper for the Document node at the root of the DOM tree. Never null except in the case where we are creating the DocumentWrapper itself (which is a subclass).parent- The DOMNodeWrapper that wraps the parent of this node. May be null if unknown.index- Position of this node among its siblings, 0-based. May be -1 if unknown.
-
-
Method Detail
-
makeWrapper
protected static DOMNodeWrapper makeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper)
Factory method to wrap a DOM node with a wrapper that implements the Saxon NodeInfo interface.- Parameters:
node- The DOM nodedocWrapper- The wrapper for the containing Document node- Returns:
- The new wrapper for the supplied node
- Throws:
java.lang.NullPointerException- if the node or the document wrapper are null
-
makeWrapper
protected static DOMNodeWrapper makeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper, DOMNodeWrapper parent, int index)
Factory method to wrap a DOM node with a wrapper that implements the Saxon NodeInfo interface.- Parameters:
node- The DOM nodedocWrapper- The wrapper for the containing Document node *parent- The wrapper for the parent of the JDOM nodeindex- The position of this node relative to its siblings- Returns:
- The new wrapper for the supplied node
-
getTreeInfo
public DocumentWrapper getTreeInfo()
Description copied from interface:NodeInfoGet information about the tree to which this NodeInfo belongs- Specified by:
getTreeInfoin interfaceNodeInfo- Overrides:
getTreeInfoin classAbstractNodeWrapper- Returns:
- the TreeInfo
-
getUnderlyingNode
public org.w3c.dom.Node getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface- Specified by:
getUnderlyingNodein interfaceVirtualNode- Returns:
- The underlying node.
-
getNodeKind
public int getNodeKind()
Return the kind of node.- Specified by:
getNodeKindin interfaceNodeInfo- Returns:
- one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
- See Also:
Type
-
equals
public boolean equals(java.lang.Object other)
Determine whether this is the same node as another node.Note: a.equals(b) if and only if generateId(a)==generateId(b)
- Specified by:
equalsin interfaceNodeInfo- Overrides:
equalsin classAbstractNodeWrapper- Parameters:
other- the node to be compared with this node- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
-
compareOrder
public int compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order. The other node will always be in the same document.- Specified by:
compareOrderin interfaceNodeInfo- Parameters:
other- The other node, whose position is to be compared with this node- Returns:
- -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
-
getStringValueCS
public java.lang.CharSequence getStringValueCS()
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.- Specified by:
getStringValueCSin interfaceGroundedValue- Specified by:
getStringValueCSin interfaceItem- Returns:
- the string value of the item
- See Also:
Item.getStringValue()
-
expandStringValue
public static void expandStringValue(org.w3c.dom.NodeList list, FastStringBuffer sb)
-
getLocalPart
public java.lang.String getLocalPart()
Get the local part of the name of this node. This is the name after the ":" if any.- Specified by:
getLocalPartin interfaceNodeInfo- Returns:
- the local part of the name. For an unnamed node, returns "".
-
getLocalName
public static java.lang.String getLocalName(org.w3c.dom.Node node)
Get the local name of a DOM element or attribute node.- Parameters:
node- the DOM element or attribute node- Returns:
- the local name as defined in XDM
-
getURI
public java.lang.String getURI()
Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.
-
getPrefix
public java.lang.String getPrefix()
Get the prefix of the name of the node. This is defined only for elements and attributes. If the node has no prefix, or for other kinds of node, return a zero-length string.
-
getDisplayName
public java.lang.String getDisplayName()
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.- Specified by:
getDisplayNamein interfaceNodeInfo- Overrides:
getDisplayNamein classAbstractNodeWrapper- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getParent
public DOMNodeWrapper getParent()
Get the NodeInfo object representing the parent of this node- Specified by:
getParentin interfaceNodeInfo- Specified by:
getParentin interfaceSteppingNode<DOMNodeWrapper>- Returns:
- the parent of this node; null if this node has no parent
-
getSiblingPosition
public int getSiblingPosition()
Get the index position of this node among its siblings (starting from 0). In the case of a text node that maps to several adjacent siblings in the DOM, the numbering actually refers to the position of the underlying DOM nodes; thus the sibling position for the text node is that of the first DOM node to which it relates, and the numbering of subsequent XPath nodes is not necessarily consecutive.Despite the name, this method also returns a meaningful result for attribute nodes; it returns the position of the attribute among the attributes of its parent element, when they are listed in document order.
- Specified by:
getSiblingPositionin interfaceSiblingCountingNode- Returns:
- 0 for the first child, 1 for the second child, etc.
-
iterateAttributes
protected AxisIterator iterateAttributes(java.util.function.Predicate<? super NodeInfo> nodeTest)
Description copied from class:AbstractNodeWrapperReturn an iterator over the attributes of this element node. This method is only called after checking that the node is an element.- Specified by:
iterateAttributesin classAbstractNodeWrapper- Parameters:
nodeTest- a test that the returned attributes must satisfy- Returns:
- an iterator over the attribute nodes. The order of the result, although arbitrary, must be consistent with document order.
-
iterateChildren
protected AxisIterator iterateChildren(java.util.function.Predicate<? super NodeInfo> nodeTest)
Description copied from class:AbstractNodeWrapperReturn an iterator over the children of this node. This method is only called after checking that the node is an element or document.- Specified by:
iterateChildrenin classAbstractNodeWrapper- Parameters:
nodeTest- a test that the returned attributes must satisfy- Returns:
- an iterator over the child nodes, in document order.
-
iterateSiblings
protected AxisIterator iterateSiblings(java.util.function.Predicate<? super NodeInfo> nodeTest, boolean forwards)
Description copied from class:AbstractNodeWrapperReturn an iterator over the siblings of this node. This method is only called after checking that the node is an element, text, comment, or PI node.- Specified by:
iterateSiblingsin classAbstractNodeWrapper- Parameters:
nodeTest- a test that the returned siblings must satisfyforwards- true for following siblings, false for preceding siblings- Returns:
- an iterator over the sibling nodes, in axis order.
-
iterateDescendants
protected AxisIterator iterateDescendants(java.util.function.Predicate<? super NodeInfo> nodeTest, boolean includeSelf)
Description copied from class:AbstractNodeWrapperReturn an iterator over the descendants of this node. This method is only called after checking that the node is an element or document node.- Overrides:
iterateDescendantsin classAbstractNodeWrapper- Parameters:
nodeTest- a test that the returned descendants must satisfyincludeSelf- true if this node is to be included in the result- Returns:
- an iterator over the sibling nodes, in axis order.
-
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)Get the string value of a given attribute of this node- Specified by:
getAttributeValuein interfaceNodeInfo- Overrides:
getAttributeValuein classAbstractNodeWrapper- Parameters:
uri- the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespacelocal- the local part of the attribute name.- Returns:
- the attribute value if it exists, or null if it does not exist. Always returns null if this node is not an element.
- Since:
- 9.4
-
getRoot
public NodeInfo getRoot()
Get the root node - always a document node with this tree implementation- Specified by:
getRootin interfaceNodeInfo- Overrides:
getRootin classAbstractNodeWrapper- Returns:
- the NodeInfo representing the containing document
-
hasChildNodes
public boolean hasChildNodes()
Determine whether the node has any children.Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()- Specified by:
hasChildNodesin interfaceNodeInfo- Overrides:
hasChildNodesin classAbstractNodeWrapper- Returns:
- True if the node has one or more children
-
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)- Specified by:
generateIdin interfaceNodeInfo- Parameters:
buffer- a buffer to contain a string that uniquely identifies this node, across all documents
-
getDeclaredNamespaces
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespacesin interfaceNodeInfo- Overrides:
getDeclaredNamespacesin classAbstractNodeWrapper- Parameters:
buffer- If this is non-null, and the result array fits in this buffer, then the result may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.- Returns:
- An array of integers representing the namespace declarations and undeclarations present on
this element. For a node other than an element, return null. Otherwise, the returned array is a
sequence of namespace codes, whose meaning may be interpreted by reference to the name pool. The
top half word of each namespace code represents the prefix, the bottom half represents the URI.
If the bottom half is zero, then this is a namespace undeclaration rather than a declaration.
The XML namespace is never included in the list. If the supplied array is larger than required,
then the first unused entry will be set to -1.
For a node other than an element, the method returns null.
-
getAllNamespaces
public NamespaceMap getAllNamespaces()
Get all the namespace bindings that are in-scope for this element.For an element return all the prefix-to-uri bindings that are in scope. This may include a binding to the default namespace (represented by a prefix of ""). It will never include "undeclarations" - that is, the namespace URI will never be empty; the effect of an undeclaration is to remove a binding from the in-scope namespaces, not to add anything.
For a node other than an element, returns null.
- Specified by:
getAllNamespacesin interfaceNodeInfo- Overrides:
getAllNamespacesin classAbstractNodeWrapper- Returns:
- the in-scope namespaces for an element, or null for any other kind of node.
-
isId
public boolean isId()
Determine whether this node has the is-id property
-
getNextSibling
public DOMNodeWrapper getNextSibling()
Description copied from interface:SteppingNodeGet the next sibling of this node- Specified by:
getNextSiblingin interfaceSteppingNode<DOMNodeWrapper>- Returns:
- the next sibling if there is one, or null otherwise
-
getFirstChild
public DOMNodeWrapper getFirstChild()
Description copied from interface:SteppingNodeGet the first child of this node- Specified by:
getFirstChildin interfaceSteppingNode<DOMNodeWrapper>- Returns:
- the first child if there is one, or null otherwise
-
getPreviousSibling
public DOMNodeWrapper getPreviousSibling()
Description copied from interface:SteppingNodeGet the previous sibling of this node- Specified by:
getPreviousSiblingin interfaceSteppingNode<DOMNodeWrapper>- Returns:
- the previous sibling if there is one, or null otherwise
-
getSuccessorElement
public DOMNodeWrapper getSuccessorElement(DOMNodeWrapper anchor, java.lang.String uri, java.lang.String local)
Description copied from interface:SteppingNodeFind the next matching element in document order; that is, the first child element with the required name if there is one; otherwise the next sibling element if there is one; otherwise the next sibling element of the parent, grandparent, etc, up to the anchor element.- Specified by:
getSuccessorElementin interfaceSteppingNode<DOMNodeWrapper>- Parameters:
anchor- the root of the tree within which navigation is confineduri- the required namespace URI, or null if any namespace is acceptablelocal- the required local name, or null if any local name is acceptable- Returns:
- the next element after this one in document order, with the given URI and local name if specified, or null if this is the last node in the document, or the last node within the subtree being navigated
-
-