Class NodeWrapper

java.lang.Object
net.sf.saxon.dom.NodeWrapper
All Implemented Interfaces:
Source, Item, NodeInfo, SiblingCountingNode, ValueRepresentation, VirtualNode
Direct Known Subclasses:
DocumentWrapper

public class NodeWrapper extends Object implements NodeInfo, VirtualNode, SiblingCountingNode
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.

  • Field Details

    • node

      protected Node node
    • nodeKind

      protected short nodeKind
    • docWrapper

      protected DocumentWrapper docWrapper
    • index

      protected int index
    • span

      protected int span
  • Constructor Details

    • NodeWrapper

      protected NodeWrapper(Node node, NodeWrapper parent, int index)
      This constructor is protected: nodes should be created using the makeWrapper factory method
      Parameters:
      node - The DOM node to be wrapped
      parent - The NodeWrapper that wraps the parent of this node
      index - Position of this node among its siblings
  • Method Details

    • makeWrapper

      protected NodeWrapper 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 NodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper, NodeWrapper 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
    • getUnderlyingNode

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

      public Configuration getConfiguration()
      Get the configuration
      Specified by:
      getConfiguration in interface NodeInfo
      Returns:
      the Configuration
    • getNamePool

      public NamePool getNamePool()
      Get the name pool for this node
      Specified by:
      getNamePool in interface NodeInfo
      Returns:
      the NamePool
    • getNodeKind

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

      public SequenceIterator getTypedValue()
      Get the typed value of the item
      Specified by:
      getTypedValue in interface Item
      Returns:
      an iterator over the items in the typed value of the node or atomic value. The items returned by this iterator will always be atomic values.
    • atomize

      public Value atomize()
      Get the typed value. The result of this method will always be consistent with the method Item.getTypedValue(). However, this method is often more convenient and may be more efficient, especially in the common case where the value is expected to be a singleton.
      Specified by:
      atomize in interface NodeInfo
      Returns:
      the typed value. If requireSingleton is set to true, the result will always be an AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic values.
      Since:
      8.5
    • getTypeAnnotation

      public int getTypeAnnotation()
      Get the type annotation
      Specified by:
      getTypeAnnotation in interface NodeInfo
      Returns:
      the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated as untypedAtomic for the purposes of obtaining the typed value).

      The result is undefined for nodes other than elements and attributes.

    • isSameNodeInfo

      public boolean isSameNodeInfo(NodeInfo other)
      Determine whether this is the same node as another node.
      Note: a.isSameNodeInfo(b) if and only if generateId(a)==generateId(b)
      Specified by:
      isSameNodeInfo in interface NodeInfo
      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.
    • equals

      public boolean equals(Object other)
      The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().
      Specified by:
      equals in interface NodeInfo
      Overrides:
      equals in class Object
      Parameters:
      other - the node to be compared with this node
      Returns:
      true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.
      Since:
      8.7 Previously, the effect of the equals() method was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics. It is safer to use isSameNodeInfo() for this reason. The equals() method has been defined because it is useful in contexts such as a Java Set or HashMap.
    • hashCode

      public int hashCode()
      The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode()
      Specified by:
      hashCode in interface NodeInfo
      Overrides:
      hashCode in class Object
      Since:
      8.7 Previously, the effect of the equals() and hashCode() methods was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics.
    • getSystemId

      public String getSystemId()
      Get the System ID for the node.
      Specified by:
      getSystemId in interface NodeInfo
      Specified by:
      getSystemId in interface Source
      Returns:
      the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.
    • setSystemId

      public void setSystemId(String uri)
      Specified by:
      setSystemId in interface Source
    • getBaseURI

      public String getBaseURI()
      Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. In the DOM model, base URIs are held only an the document level.
      Specified by:
      getBaseURI in interface NodeInfo
      Returns:
      the base URI of the node. This may be null if the base URI is unknown.
    • getLineNumber

      public int getLineNumber()
      Get line number
      Specified by:
      getLineNumber in interface NodeInfo
      Returns:
      the line number of the node in its original source document; or -1 if not available
    • 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())
    • getStringValue

      public String getStringValue()
      Return the string value of the node. The interpretation of this depends on the type of node. For an element it is the accumulated character content of the element, including descendant elements.
      Specified by:
      getStringValue in interface Item
      Specified by:
      getStringValue in interface NodeInfo
      Specified by:
      getStringValue in interface ValueRepresentation
      Returns:
      the string value of the node
      See Also:
    • getStringValueCS

      public 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:
      getStringValueCS in interface Item
      Specified by:
      getStringValueCS in interface ValueRepresentation
      Returns:
      the string value of the item
      See Also:
    • getNameCode

      public int getNameCode()
      Get name code. The name code is a coded form of the node name: two nodes with the same name code have the same namespace URI, the same local name, and the same prefix. By masking the name code with invalid input: '&'0xfffff, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.
      Specified by:
      getNameCode in interface NodeInfo
      Returns:
      an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
      See Also:
    • getFingerprint

      public int getFingerprint()
      Get fingerprint. The fingerprint is a coded form of the expanded name of the node: two nodes with the same name code have the same namespace URI and the same local name. A fingerprint of -1 should be returned for a node with no name.
      Specified by:
      getFingerprint in interface NodeInfo
      Returns:
      an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
    • 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 null, except for un unnamed namespace node, which returns "".
    • getURI

      public 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.
      Specified by:
      getURI 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. This implementation simply returns the prefix defined in the DOM model; this is nto strictly accurate in all cases, but is good enough for the purpose.
      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
      Returns:
      The display name of this node. For a node with no name, return an empty string.
    • getParent

      public NodeInfo getParent()
      Get the NodeInfo object representing the parent of this node
      Specified by:
      getParent in interface NodeInfo
      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.
      Specified by:
      getSiblingPosition in interface SiblingCountingNode
      Returns:
      0 for the first child, 1 for the second child, etc.
    • iterateAxis

      public AxisIterator iterateAxis(byte axisNumber)
      Return an iteration over the nodes reached by the given axis from this node
      Specified by:
      iterateAxis in interface NodeInfo
      Parameters:
      axisNumber - the axis to be used
      Returns:
      a SequenceIterator that scans the nodes reached by the axis in turn.
      See Also:
    • iterateAxis

      public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
      Return an iteration over the nodes reached by the given axis from this node
      Specified by:
      iterateAxis in interface NodeInfo
      Parameters:
      axisNumber - the axis to be used
      nodeTest - A pattern to be matched by the returned nodes
      Returns:
      a SequenceIterator that scans the nodes reached by the axis in turn.
      See Also:
    • getAttributeValue

      public String getAttributeValue(int fingerprint)
      Get the value of a given attribute of this node
      Specified by:
      getAttributeValue in interface NodeInfo
      Parameters:
      fingerprint - The fingerprint of the attribute name
      Returns:
      the attribute value if it exists or null if not
    • getRoot

      public NodeInfo getRoot()
      Get the root node - always a document node with this tree implementation
      Specified by:
      getRoot in interface NodeInfo
      Returns:
      the NodeInfo representing the containing document
    • getDocumentRoot

      public DocumentInfo getDocumentRoot()
      Get the root (document) node
      Specified by:
      getDocumentRoot in interface NodeInfo
      Returns:
      the DocumentInfo 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
      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:
      generateId in interface NodeInfo
      Parameters:
      buffer - a buffer to contain a string that uniquely identifies this node, across all documents
    • getDocumentNumber

      public int getDocumentNumber()
      Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.
      Specified by:
      getDocumentNumber in interface NodeInfo
    • copy

      public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
      Copy this node to a given outputter (deep copy)
      Specified by:
      copy in interface NodeInfo
      Parameters:
      out - the Receiver to which the node should be copied
      whichNamespaces - in the case of an element, controls which namespace nodes should be copied. Values are NodeInfo.NO_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.ALL_NAMESPACES
      copyAnnotations - indicates whether the type annotations of element and attribute nodes should be copied
      locationId - If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier
      Throws:
      XPathException
    • sendNamespaceDeclarations

      public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors) throws XPathException
      Output all namespace nodes associated with this element. Does nothing if the node is not an element.
      Specified by:
      sendNamespaceDeclarations in interface NodeInfo
      Parameters:
      out - The relevant outputter
      includeAncestors - True if namespaces declared on ancestor elements must
      Throws:
      XPathException
    • getDeclaredNamespaces

      public int[] getDeclaredNamespaces(int[] buffer)
      Get all namespace undeclarations and undeclarations defined on this element.
      Specified by:
      getDeclaredNamespaces in interface NodeInfo
      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.