Package net.sf.saxon.dom

Class DOMNodeWrapper

java.lang.Object
net.sf.saxon.tree.wrapper.AbstractNodeWrapper
net.sf.saxon.dom.DOMNodeWrapper
All Implemented Interfaces:
Source, SourceLocator, ActiveSource, GroundedValue, Item, NodeInfo, Sequence, Location, SteppingNode, SiblingCountingNode, VirtualNode, Locator
public class DOMNodeWrapper extends AbstractNodeWrapper implements SiblingCountingNode, SteppingNode
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 Details

    • node

      protected Node node

    • nodeKind

      protected short nodeKind

    • docWrapper

      protected DocumentWrapper docWrapper

    • index

      protected int index

    • span

      protected int span

  • Constructor Details

    • DOMNodeWrapper

      protected DOMNodeWrapper(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 wrapped
      docWrapper - 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 Details

    • makeWrapper

      protected static DOMNodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper)
      Factory method to wrap a DOM node with a wrapper that implements the Saxon NodeInfo interface.
      Parameters:
      node - The DOM node
      docWrapper - The wrapper for the containing Document node
      Returns:
      The new wrapper for the supplied node
      Throws:
      NullPointerException - if the node or the document wrapper are null

    • makeWrapper

      protected static DOMNodeWrapper makeWrapper(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 node
      docWrapper - The wrapper for the containing Document node *
      parent - The wrapper for the parent of the JDOM node
      index - 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: NodeInfo
      Get information about the tree to which this NodeInfo belongs
      Specified by:
      getTreeInfo in interface NodeInfo
      Overrides:
      getTreeInfo in class AbstractNodeWrapper
      Returns:
      the TreeInfo

    • getUnderlyingNode

      public Node getUnderlyingNode()
      Get the underlying DOM node, to implement the VirtualNode interface
      Specified by:
      getUnderlyingNode in interface VirtualNode
      Returns:
      The underlying node.

    • getNodeKind

      public int getNodeKind()
      Return the kind of node.
      Specified by:
      getNodeKind in interface NodeInfo
      Returns:
      one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
      See Also:

    • equals

      public boolean equals(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:
      equals in interface NodeInfo
      Overrides:
      equals in class AbstractNodeWrapper
      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:
      compareOrder in interface NodeInfo
      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())

    • getUnicodeStringValue

      public UnicodeString getUnicodeStringValue()
      Get the value of the item as a UnicodeString. This is in some cases more efficient than the version of the method that returns a String.
      Specified by:
      getUnicodeStringValue in interface GroundedValue
      Specified by:
      getUnicodeStringValue in interface Item
      Returns:
      the string value of the node

    • expandStringValue

      public static void expandStringValue(NodeList list, UnicodeBuilder sb)

    • getLocalPart

      public String getLocalPart()
      Get the local part of the name of this node. This is the name after the ":" if any.
      Specified by:
      getLocalPart in interface NodeInfo
      Returns:
      the local part of the name. For an unnamed node, returns "".

    • getLocalName

      public static String getLocalName(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

    • getNamespaceUri

      public NamespaceUri getNamespaceUri()
      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.
      Specified by:
      getNamespaceUri in interface NodeInfo
      Returns:
      The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.

    • getPrefix

      public 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.
      Specified by:
      getPrefix in interface NodeInfo
      Returns:
      The prefix of the name of the node.

    • getDisplayName

      public 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:
      getDisplayName in interface NodeInfo
      Overrides:
      getDisplayName in class AbstractNodeWrapper
      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:
      getParent in interface NodeInfo
      Specified by:
      getParent in interface SteppingNode
      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:
      getSiblingPosition in interface SiblingCountingNode
      Returns:
      0 for the first child, 1 for the second child, etc.

    • iterateAttributes

      protected AxisIterator iterateAttributes(NodeTest nodeTest)
      Description copied from class: AbstractNodeWrapper
      Return an iterator over the attributes of this element node. This method is only called after checking that the node is an element.
      Specified by:
      iterateAttributes in class AbstractNodeWrapper
      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(NodeTest nodeTest)
      Description copied from class: AbstractNodeWrapper
      Return 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:
      iterateChildren in class AbstractNodeWrapper
      Parameters:
      nodeTest - a test that the returned attributes must satisfy
      Returns:
      an iterator over the child nodes, in document order.

    • iterateSiblings

      protected AxisIterator iterateSiblings(NodeTest nodeTest, boolean forwards)
      Description copied from class: AbstractNodeWrapper
      Return 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:
      iterateSiblings in class AbstractNodeWrapper
      Parameters:
      nodeTest - a test that the returned siblings must satisfy
      forwards - true for following siblings, false for preceding siblings
      Returns:
      an iterator over the sibling nodes, in axis order.

    • iterateDescendants

      protected AxisIterator iterateDescendants(NodeTest nodeTest, boolean includeSelf)
      Description copied from class: AbstractNodeWrapper
      Return 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:
      iterateDescendants in class AbstractNodeWrapper
      Parameters:
      nodeTest - a test that the returned descendants must satisfy
      includeSelf - true if this node is to be included in the result
      Returns:
      an iterator over the sibling nodes, in axis order.

    • getAttributeValue

      public String getAttributeValue(NamespaceUri uri, String local)
      Get the string value of a given attribute of this node
      Specified by:
      getAttributeValue in interface NodeInfo
      Overrides:
      getAttributeValue in class AbstractNodeWrapper
      Parameters:
      uri - the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespace
      local - 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:
      getRoot in interface NodeInfo
      Overrides:
      getRoot in class AbstractNodeWrapper
      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:
      hasChildNodes in interface NodeInfo
      Overrides:
      hasChildNodes in class AbstractNodeWrapper
      Returns:
      True if the node has one or more children

    • generateId

      public void generateId(StringBuilder buffer)
      Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
      Specified by:
      generateId in interface NodeInfo
      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:
      getDeclaredNamespaces in interface NodeInfo
      Overrides:
      getDeclaredNamespaces in class AbstractNodeWrapper
      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:
      getAllNamespaces in interface NodeInfo
      Overrides:
      getAllNamespaces in class AbstractNodeWrapper
      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
      Specified by:
      isId in interface NodeInfo
      Returns:
      true if the node is an ID

    • getNextSibling

      public DOMNodeWrapper getNextSibling()
      Description copied from interface: SteppingNode
      Get the next sibling of this node
      Specified by:
      getNextSibling in interface SteppingNode
      Returns:
      the next sibling if there is one, or null otherwise

    • getFirstChild

      public DOMNodeWrapper getFirstChild()
      Description copied from interface: SteppingNode
      Get the first child of this node
      Specified by:
      getFirstChild in interface SteppingNode
      Returns:
      the first child if there is one, or null otherwise

    • getPreviousSibling

      public DOMNodeWrapper getPreviousSibling()
      Description copied from interface: SteppingNode
      Get the previous sibling of this node
      Specified by:
      getPreviousSibling in interface SteppingNode
      Returns:
      the previous sibling if there is one, or null otherwise

    • getSuccessorElement

      public SteppingNode getSuccessorElement(SteppingNode anchor, NamespaceUri uri, String local)
      Description copied from interface: SteppingNode
      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.
      Specified by:
      getSuccessorElement in interface SteppingNode
      Parameters:
      anchor - the root of the tree within which navigation is confined
      uri - the required namespace URI, or null if any namespace is acceptable
      local - 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