Package net.sf.saxon.tree.wrapper
Class SpaceStrippedNode
java.lang.Object
net.sf.saxon.tree.wrapper.AbstractVirtualNode
net.sf.saxon.tree.wrapper.SpaceStrippedNode
- All Implemented Interfaces:
Source
,SourceLocator
,ActiveSource
,GroundedValue
,Item
,NodeInfo
,Sequence
,Location
,VirtualNode
,WrappingFunction
,Locator
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.
-
Field Summary
Fields inherited from class net.sf.saxon.tree.wrapper.AbstractVirtualNode
docWrapper, node, parent
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
protected
SpaceStrippedNode
(NodeInfo node, SpaceStrippedNode parent) This constructor is protected: nodes should be created using the makeWrapper factory method -
Method Summary
Modifier and TypeMethodDescriptionatomize()
Get the typed value.int
compareOrder
(NodeInfo other) Determine the relative position of this node and another node, in document order.void
Copy this node to a given outputter (deep copy)boolean
Determine whether this is the same node as another node.Get the NodeInfo object representing the parent of this nodeGet the string value of the item.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()static boolean
isPreservedNode
(NodeInfo node, SpaceStrippedDocument docWrapper, NodeInfo actualParent) Ask whether a node is preserved after whitespace strippingiterateAxis
(int axisNumber) Return an iteration over the nodes reached by the given axis from this nodeiterateAxis
(int axisNumber, NodePredicate nodeTest) Return an iteration over the nodes reached by the given axis from this nodeprotected static SpaceStrippedNode
makeWrapper
(NodeInfo node, SpaceStrippedDocument docWrapper, SpaceStrippedNode parent) Factory method to wrap a node with a wrapper that implements the Saxon NodeInfo interface.makeWrapper
(NodeInfo node, VirtualNode parent) Factory method to wrap a node within the same document as this node with a VirtualNodeMethods inherited from class net.sf.saxon.tree.wrapper.AbstractVirtualNode
generateId, getAllNamespaces, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getFingerprint, getLineNumber, getLocalPart, getNamespaceUri, getNodeKind, getPrefix, getRealNode, getRoot, getSchemaType, getSystemId, getTreeInfo, getUnderlyingNode, hasChildNodes, hasFingerprint, isId, isIdref, isNilled, 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, getStringValue, head, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.NodeInfo
asActiveSource, attributes, children, children, deliver, getAttributeValue, getConfiguration, getGenre, getPublicId, getURI, isSameNodeInfo, isStreamed, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
SpaceStrippedNode
protected SpaceStrippedNode() -
SpaceStrippedNode
This constructor is protected: nodes should be created using the makeWrapper factory method- Parameters:
node
- The node to be wrappedparent
- The StrippedNode that wraps the parent of this node
-
-
Method Details
-
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 nodedocWrapper
- 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
Factory method to wrap a node within the same document as this node with a VirtualNode- Specified by:
makeWrapper
in interfaceWrappingFunction
- Parameters:
node
- The underlying nodeparent
- 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 questiondocWrapper
- the root of the space-stripped virtual treeactualParent
- the (real) parent of the node in question- Returns:
- true if the node survives whitespace-stripping
-
atomize
Get the typed value.- Specified by:
atomize
in interfaceItem
- Specified by:
atomize
in interfaceNodeInfo
- Overrides:
atomize
in classAbstractVirtualNode
- Returns:
- the typed value.
- Throws:
XPathException
- if the node has no typed value, for example if it is an element node with element-only content- Since:
- 8.5
-
equals
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 interfaceNodeInfo
- Overrides:
equals
in classAbstractVirtualNode
- 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 interfaceNodeInfo
- Overrides:
hashCode
in classAbstractVirtualNode
-
compareOrder
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 interfaceNodeInfo
- Overrides:
compareOrder
in classAbstractVirtualNode
- 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
Get the string value of the item.- Specified by:
getUnicodeStringValue
in interfaceGroundedValue
- Specified by:
getUnicodeStringValue
in interfaceItem
- Overrides:
getUnicodeStringValue
in classAbstractVirtualNode
- Returns:
- the string value of the node
-
getParent
Get the NodeInfo object representing the parent of this node -
iterateAxis
Description copied from class:AbstractVirtualNode
Return an iteration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Overrides:
iterateAxis
in classAbstractVirtualNode
- Parameters:
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodes- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
- See Also:
-
iterateAxis
Return an iteration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be used- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
- See Also:
-
copy
Copy this node to a given outputter (deep copy)- Specified by:
copy
in interfaceNodeInfo
- 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 inCopyOptions
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
-