Class SpaceStrippedNode

  • All Implemented Interfaces:
    javax.xml.transform.Source, javax.xml.transform.SourceLocator, ActiveSource, GroundedValue, Item, NodeInfo, Sequence, Location, VirtualNode, WrappingFunction, org.xml.sax.Locator

    public class SpaceStrippedNode
    extends AbstractVirtualNode
    implements WrappingFunction
    A StrippedNode is a view of a node, in a virtual tree that has whitespace text nodes stripped from it. All operations on the node produce the same result as operations on the real underlying node, except that iterations over the axes take care to skip whitespace-only text nodes that are supposed to be stripped. Note that this class is only used in cases where a pre-built tree is supplied as the input to a transformation, and where the stylesheet does whitespace stripping; if a SAXSource or StreamSource is supplied, whitespace is stripped as the tree is built.
    • Constructor Detail

      • SpaceStrippedNode

        protected SpaceStrippedNode()
      • SpaceStrippedNode

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

      • makeWrapper

        protected static SpaceStrippedNode makeWrapper​(NodeInfo node,
                                                       SpaceStrippedDocument docWrapper,
                                                       SpaceStrippedNode 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 VirtualNode makeWrapper​(NodeInfo node,
                                       VirtualNode parent)
        Factory method to wrap a node within the same document as this 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
      • isPreservedNode

        public static boolean isPreservedNode​(NodeInfo node,
                                              SpaceStrippedDocument docWrapper,
                                              NodeInfo actualParent)
        Ask whether a node is preserved after whitespace stripping
        Parameters:
        node - the node in question
        docWrapper - the root of the space-stripped virtual tree
        actualParent - the (real) parent of the node in question
        Returns:
        true if the node survives whitespace-stripping
      • equals

        public boolean equals​(java.lang.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​(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
        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 NodeInfo
        Returns:
        the parent of this node; null if this node has no parent
      • iterateAxis

        public AxisIterator iterateAxis​(int axisNumber,
                                        NodePredicate nodeTest)
        Description copied from class: AbstractVirtualNode
        Return an iteration over the nodes reached by the given axis from this node
        Specified by:
        iterateAxis in interface NodeInfo
        Overrides:
        iterateAxis in class AbstractVirtualNode
        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:
        AxisInfo
      • iterateAxis

        public AxisIterator iterateAxis​(int 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:
        AxisInfo
      • copy

        public void copy​(Receiver out,
                         int copyOptions,
                         Location 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. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.
        copyOptions - a selection of the options defined in CopyOptions
        locationId - If non-null, identifies the location of the instruction that requested this copy. If null, indicates that the location information is not available
        Throws:
        XPathException - if any downstream error occurs