Package net.sf.saxon.tree.wrapper

Class TypeStrippedNode

java.lang.Object

net.sf.saxon.tree.wrapper.AbstractVirtualNode

net.sf.saxon.tree.wrapper.TypeStrippedNode

All Implemented Interfaces:

Source, SourceLocator, ActiveSource, GNode, GroundedValue, Item, NodeInfo, Sequence, Location, VirtualNode, WrappingFunction, Locator

public class TypeStrippedNode
extends AbstractVirtualNode
implements WrappingFunction

A TypeStrippedNode is a view of a node, in a virtual tree that has type annotations stripped from it.

Field Summary

Fields inherited from class net.sf.saxon.tree.wrapper.AbstractVirtualNode

docWrapper, node, parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeStrippedNode()
protected	TypeStrippedNode(NodeInfo node, TypeStrippedNode parent)	This constructor is protected: nodes should be created using the makeWrapper factory method

Method Summary

Modifier and Type	Method	Description
AtomicSequence	atomize()	Get the typed value.
int	compareOrder(GNode other)	Determine the relative position of this node and another node, in document order.
void	copy(Receiver out, int copyOptions, Location locationId)	Copy this node to a given outputter (deep copy)
boolean	equals(Object other)	Determine whether this is the same node as another node.
NodeInfo	getParent()	Get the NodeInfo object representing the parent of this node
SchemaType	getSchemaType()	Get the type annotation
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()
boolean	isNilled()	Determine whether the node has the is-nilled property
SequenceIterator	iterateAncestorAxis(NodePredicate predicate)	Get an iterator over the ancestor axis, starting at this node; the nodes will be in reverse document order.
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.
SequenceIterator	iterateAttributeAxis(NodePredicate predicate)	Get an iterator over the attribute axis, starting at this node; the nodes will be in document order.
SequenceIterator	iterateChildAxis(NodePredicate predicate)	Get an iterator over the child axis, starting at this node; the nodes will be in document order.
SequenceIterator	iterateDescendantAxis(NodePredicate predicate)	Get an iterator over the descendant axis, starting at this node; the nodes will be in document order.
SequenceIterator	iterateDescendantOrSelfAxis(NodePredicate predicate)	Get an iterator over the descendant-or-self axis, starting at this node; the nodes will be in document order.
SequenceIterator	iterateFollowingAxis(NodePredicate predicate)	Get an iterator over the following axis, starting at this node; the nodes will be in document order.
SequenceIterator	iterateFollowingOrSelfAxis(NodePredicate predicate)	Get an iterator over the following-or-self axis, starting at this node; the nodes will be in document order.
SequenceIterator	iterateFollowingSiblingAxis(NodePredicate predicate)	Get an iterator over the following-sibling axis, starting at this node; the nodes will be in document order.
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.
SequenceIterator	iterateNamespaceAxis(NodePredicate predicate)	Get an iterator over the namespace axis, starting at this node; the nodes will be in reverse document order.
SequenceIterator	iterateParentAxis(NodePredicate predicate)	Get an iterator over the parent axis, starting at this node; returns zero or one nodes
SequenceIterator	iteratePrecedingAxis(NodePredicate predicate)	Get an iterator over the preceding axis, starting at this node; the nodes will be in reverse document order.
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.
SequenceIterator	iteratePrecedingSiblingAxis(NodePredicate predicate)	Get an iterator over the preceding-sibling axis, starting at this node; the nodes will be in reverse document order.
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.
SequenceIterator	iterateSelfAxis(NodePredicate predicate)	Get an iterator over the self axis, starting at this node; there will be zero or one nodes.
static TypeStrippedNode	makeWrapper(NodeInfo node, TypeStrippedDocument docWrapper, TypeStrippedNode parent)	Factory method to wrap a node with a wrapper that implements the Saxon NodeInfo interface.
VirtualNode	makeWrapper(NodeInfo node, VirtualNode parent)	Factory method to wrap a node with a VirtualNode

Methods inherited from class net.sf.saxon.tree.wrapper.AbstractVirtualNode

generateId, getAllNamespaces, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getFingerprint, getLineNumber, getLocalPart, getNamespaceUri, getNodeKind, getPrefix, getRealNode, getRoot, getSystemId, getTreeInfo, getUnderlyingNode, getUnicodeStringValue, hasChildNodes, hasFingerprint, isId, isIdref, 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

getLabel, getLength, getStringValue, head, itemAt, iterate, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.NodeInfo

asActiveSource, attributes, children, children, deliver, getConfiguration, getGenre, getPublicId, getQName, getURI, isSameNodeInfo, isStreamed, toShortString

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface javax.xml.transform.Source

isEmpty

Constructor Details

TypeStrippedNode

protected TypeStrippedNode()

TypeStrippedNode

protected TypeStrippedNode(NodeInfo node,
 TypeStrippedNode 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 Details

makeWrapper

public static TypeStrippedNode makeWrapper(NodeInfo node,
 TypeStrippedDocument docWrapper,
 TypeStrippedNode 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 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

atomize

public AtomicSequence atomize()
                       throws XPathException

Get the typed value.

Specified by:

atomize in interface Item

Specified by:

atomize in interface NodeInfo

Overrides:

atomize in class AbstractVirtualNode

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.

Throws:

XPathException - if the node has no typed value, for example if it is an element node with element-only content

Since:

8.5

getSchemaType

public SchemaType getSchemaType()

Get the type annotation

Specified by:

getSchemaType in interface NodeInfo

Overrides:

getSchemaType in class AbstractVirtualNode

Returns:

the type annotation of the base node

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

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

isNilled

public boolean isNilled()

Description copied from class: AbstractVirtualNode

Determine whether the node has the is-nilled property

Specified by:

isNilled in interface NodeInfo

Overrides:

isNilled in class AbstractVirtualNode

Returns:

true if the node has the is-nilled property