Package net.sf.saxon.tree.wrapper

Class RebasedNode

java.lang.Object
net.sf.saxon.tree.wrapper.AbstractVirtualNode
net.sf.saxon.tree.wrapper.RebasedNode
All Implemented Interfaces:
Source, SourceLocator, ActiveSource, GNode, GroundedValue, Item, NodeInfo, Sequence, Location, VirtualNode, WrappingFunction, Locator
public class RebasedNode extends AbstractVirtualNode implements WrappingFunction
A RebasedNode is a view of a node, in a virtual tree that maps the base URI and/or system ID to new values

  • Constructor Details

    • RebasedNode

      protected RebasedNode()

    • RebasedNode

      protected RebasedNode(NodeInfo node, RebasedNode parent)
      This constructor is protected: nodes should be created using the makeWrapper factory method
      Parameters:
      node - The node to be wrapped
      parent - The RebasedNode that wraps the parent of this node

  • Method Details

    • makeWrapper

      public static RebasedNode makeWrapper(NodeInfo node, RebasedDocument docWrapper, RebasedNode parent)
      Factory method to wrap a node with a wrapper that implements the Saxon NodeInfo interface.
      Parameters:
      node - The underlying node
      docWrapper - The wrapper for the document node (must be supplied)
      parent - The wrapper for the parent of the node (null if unknown)
      Returns:
      The new wrapper for the supplied node

    • makeWrapper

      public RebasedNode makeWrapper(NodeInfo node, VirtualNode parent)
      Factory method to wrap a node with a VirtualNode
      Specified by:
      makeWrapper in interface WrappingFunction
      Parameters:
      node - The underlying node
      parent - The wrapper for the parent of the node (null if unknown)
      Returns:
      The new wrapper for the supplied node

    • 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.
      Specified by:
      getBaseURI in interface NodeInfo
      Overrides:
      getBaseURI in class AbstractVirtualNode
      Returns:
      the base URI of the node. This may be null if the base URI is unknown, including the case where the node has no parent.

    • getSystemId

      public String getSystemId()
      Get the System ID for the node.
      Specified by:
      getSystemId in interface Location
      Specified by:
      getSystemId in interface Locator
      Specified by:
      getSystemId in interface NodeInfo
      Specified by:
      getSystemId in interface Source
      Specified by:
      getSystemId in interface SourceLocator
      Overrides:
      getSystemId in class AbstractVirtualNode
      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.

    • equals

      public boolean equals(Object other)
      Determine whether this is the same node as another node.

      Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)

      Specified by:
      equals in interface NodeInfo
      Overrides:
      equals in class AbstractVirtualNode
      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.

    • 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 AbstractVirtualNode

    • compareOrder

      public int compareOrder(GNode 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 GNode
      Specified by:
      compareOrder in interface NodeInfo
      Overrides:
      compareOrder in class AbstractVirtualNode
      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())

    • getParent

      public NodeInfo getParent()
      Get the NodeInfo object representing the parent of this node
      Specified by:
      getParent in interface GNode
      Specified by:
      getParent in interface NodeInfo
      Returns:
      the parent of this node; null if this node has no parent

    • iterateAncestorAxis

      public SequenceIterator iterateAncestorAxis(NodePredicate predicate)
      Get an iterator over the ancestor axis, starting at this node; the nodes will be in reverse document order.
      Specified by:
      iterateAncestorAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateAncestorOrSelfAxis

      public SequenceIterator iterateAncestorOrSelfAxis(NodePredicate predicate)
      Get an iterator over the ancestor-or-self axis, starting at this node; the nodes will be in reverse document order.
      Specified by:
      iterateAncestorOrSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateAttributeAxis

      public SequenceIterator iterateAttributeAxis(NodePredicate predicate)
      Get an iterator over the attribute axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateAttributeAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateChildAxis

      public SequenceIterator iterateChildAxis(NodePredicate predicate)
      Get an iterator over the child axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateChildAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateDescendantAxis

      public SequenceIterator iterateDescendantAxis(NodePredicate predicate)
      Get an iterator over the descendant axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateDescendantAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateDescendantOrSelfAxis

      public SequenceIterator iterateDescendantOrSelfAxis(NodePredicate predicate)
      Get an iterator over the descendant-or-self axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateDescendantOrSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateFollowingAxis

      public SequenceIterator iterateFollowingAxis(NodePredicate predicate)
      Get an iterator over the following axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateFollowingAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateFollowingOrSelfAxis

      public SequenceIterator iterateFollowingOrSelfAxis(NodePredicate predicate)
      Get an iterator over the following-or-self axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateFollowingOrSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateFollowingSiblingAxis

      public SequenceIterator iterateFollowingSiblingAxis(NodePredicate predicate)
      Get an iterator over the following-sibling axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateFollowingSiblingAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateFollowingSiblingOrSelfAxis

      public SequenceIterator iterateFollowingSiblingOrSelfAxis(NodePredicate predicate)
      Get an iterator over the following-sibling-or-self axis, starting at this node; the nodes will be in document order.
      Specified by:
      iterateFollowingSiblingOrSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateNamespaceAxis

      public SequenceIterator iterateNamespaceAxis(NodePredicate predicate)
      Get an iterator over the namespace axis, starting at this node; the nodes will be in reverse document order. The default implementation must be overridden for classes that implement element nodes.
      Specified by:
      iterateNamespaceAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateParentAxis

      public SequenceIterator iterateParentAxis(NodePredicate predicate)
      Get an iterator over the parent axis, starting at this node; returns zero or one nodes
      Specified by:
      iterateParentAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iteratePrecedingAxis

      public SequenceIterator iteratePrecedingAxis(NodePredicate predicate)
      Get an iterator over the preceding axis, starting at this node; the nodes will be in reverse document order.
      Specified by:
      iteratePrecedingAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iteratePrecedingOrSelfAxis

      public SequenceIterator iteratePrecedingOrSelfAxis(NodePredicate predicate)
      Get an iterator over the preceding-or-self axis, starting at this node; the nodes will be in reverse document order.
      Specified by:
      iteratePrecedingOrSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iteratePrecedingSiblingAxis

      public SequenceIterator iteratePrecedingSiblingAxis(NodePredicate predicate)
      Get an iterator over the preceding-sibling axis, starting at this node; the nodes will be in reverse document order.
      Specified by:
      iteratePrecedingSiblingAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iteratePrecedingSiblingOrSelfAxis

      public SequenceIterator iteratePrecedingSiblingOrSelfAxis(NodePredicate predicate)
      Get an iterator over the preceding-sibling-or-self axis, starting at this node; the nodes will be in reverse document order.
      Specified by:
      iteratePrecedingSiblingOrSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator

    • iterateSelfAxis

      public SequenceIterator iterateSelfAxis(NodePredicate predicate)
      Get an iterator over the self axis, starting at this node; there will be zero or one nodes.
      Specified by:
      iterateSelfAxis in interface GNode
      Parameters:
      predicate - a condition that the nodes must satisfy, or null
      Returns:
      the required iterator