net.sf.saxon.tree.wrapper

Class SnapshotNode

java.lang.Object

net.sf.saxon.tree.wrapper.VirtualCopy

net.sf.saxon.tree.wrapper.SnapshotNode

All Implemented Interfaces:

Iterable<NodeInfo>, Source, SourceLocator, Location, GroundedValue<NodeInfo>, Item<NodeInfo>, NodeInfo, Sequence<NodeInfo>, Locator

public class SnapshotNode
extends VirtualCopy
implements NodeInfo

This class represents a node within a tree produced by the snapshot() function, as a virtual copy of the relevant nodes in another tree. It specializes VirtualCopy, which implements a deep copy as produced by the copy-of() function.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.tree.wrapper.VirtualCopy

VirtualCopy.VirtualCopier

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeInfo	pivot

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

original, parent, root, systemId, tree

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnapshotNode(NodeInfo base, NodeInfo pivot) Protected constructor: create a virtual copy of a node

Method Summary

Modifier and Type	Method and Description
AtomicSequence	atomize() Get the typed value of this node
void	copy(Receiver out, int copyOptions, Location locationId) Copy this node to a given outputter
NodeInfo	getParent() Get the NodeInfo object representing the parent of this node
String	getPublicId() Return the public identifier for the current document event.
NodeInfo	getRoot() Get the root node of the tree containing this node
CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
boolean	isId() Determine whether this node has the is-id property
boolean	isIdref() Determine whether this node has the is-idref property
protected boolean	isIncludedInCopy(NodeInfo sourceNode) Ask whether a node in the source tree is within the scope of this virtual copy
boolean	isNilled() Determine whether the node has the is-nilled property
AxisIterator	iterateAxis(byte axisNumber, NodeTest nodeTest) Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest
static SnapshotNode	makeSnapshot(NodeInfo original) Public factory method: apply the snapshot function to a node
protected SnapshotNode	wrap(NodeInfo node) Wrap a node in a VirtualCopy.

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

compareOrder, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getGraftingHost, getLineNumber, getLocalPart, getNodeKind, getOriginalNode, getPrefix, getSchemaType, getStringValue, getSystemId, getTreeInfo, getURI, hasChildNodes, hasFingerprint, hashCode, makeCopier, makeVirtualCopy, makeVirtualCopy, saveLocation, setDropNamespaces, 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.NodeInfo

compareOrder, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getGenre, getLineNumber, getLocalPart, getNodeKind, getPrefix, getSchemaType, getStringValue, getSystemId, getTreeInfo, getURI, hasChildNodes, hasFingerprint, hashCode, isSameNodeInfo, isStreamed, iterateAxis, toShortString

Methods inherited from interface javax.xml.transform.Source

setSystemId

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

getLength, head, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

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

asIterable, effectiveBooleanValue, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.sf.saxon.expr.parser.Location

saveLocation

Field Detail

pivot

protected NodeInfo pivot

Constructor Detail

SnapshotNode

protected SnapshotNode(NodeInfo base,
                       NodeInfo pivot)

Protected constructor: create a virtual copy of a node

Parameters:

base - the node in the source tree to which the new node should correspond

pivot - the pivot node is the node supplied as argument to the snapshot() function; the snapshot includes all ancestors of this node, and all descendants of this node (plus their attributes and namespaces)

Method Detail

makeSnapshot

public static SnapshotNode makeSnapshot(NodeInfo original)

Public factory method: apply the snapshot function to a node

Parameters:

original - the node to be copied

Returns:

the snapshot.

wrap

protected SnapshotNode wrap(NodeInfo node)

Wrap a node in a VirtualCopy.

Overrides:

wrap in class VirtualCopy

Parameters:

node - the node to be wrapped

Returns:

a virtual copy of the node

getStringValueCS

public CharSequence getStringValueCS()

Get the value of the item as a CharSequence. The string value for a node below the pivot is the same as the string value for the corresponding node in the source tree; the string value for a node above the pivot is the same as the string value of the pivot. For attributes and namespaces the string value is the same as in the original tree.

Specified by:

getStringValueCS in interface GroundedValue<NodeInfo>

Specified by:

getStringValueCS in interface Item<NodeInfo>

Overrides:

getStringValueCS in class VirtualCopy

Returns:

the string value of the item

See Also:

Item.getStringValue()

getParent

public NodeInfo getParent()

Get the NodeInfo object representing the parent of this node

Specified by:

getParent in interface NodeInfo

Overrides:

getParent in class VirtualCopy

Returns:

the parent of this node; null if this node has no parent

getRoot

public NodeInfo getRoot()

Get the root node of the tree containing this node

Specified by:

getRoot in interface NodeInfo

Overrides:

getRoot in class VirtualCopy

Returns:

the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node

copy

public void copy(Receiver out,
                 int copyOptions,
                 Location locationId)
          throws XPathException

Copy this node to a given outputter

Specified by:

copy in interface NodeInfo

Overrides:

copy in class VirtualCopy

Parameters:

out - the Receiver to which the node should be copied

copyOptions - a selection of the options defined in CopyOptions

locationId - Identifies the location of the instruction

Throws:

XPathException - if any downstream error occurs

atomize

public AtomicSequence atomize()
                       throws XPathException

Get the typed value of this node

Specified by:

atomize in interface Item<NodeInfo>

Specified by:

atomize in interface NodeInfo

Overrides:

atomize in class VirtualCopy

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

isId

public boolean isId()

Determine whether this node has the is-id property

Specified by:

isId in interface NodeInfo

Overrides:

isId in class VirtualCopy

Returns:

true if the node is an ID

isIdref

public boolean isIdref()

Determine whether this node has the is-idref property

Specified by:

isIdref in interface NodeInfo

Overrides:

isIdref in class VirtualCopy

Returns:

true if the node is an IDREF or IDREFS element or attribute

isNilled

public boolean isNilled()

Determine whether the node has the is-nilled property

Specified by:

isNilled in interface NodeInfo

Overrides:

isNilled in class VirtualCopy

Returns:

true if the node has the is-nilled property

getPublicId

public String getPublicId()

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.

Specified by:

getPublicId in interface SourceLocator

Specified by:

getPublicId in interface Location

Specified by:

getPublicId in interface NodeInfo

Specified by:

getPublicId in interface Locator

Overrides:

getPublicId in class VirtualCopy

Returns:

A string containing the public identifier, or null if none is available.

See Also:

VirtualCopy.getSystemId()

iterateAxis

public AxisIterator iterateAxis(byte axisNumber,
                                NodeTest nodeTest)

Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest

Specified by:

iterateAxis in interface NodeInfo

Overrides:

iterateAxis in class VirtualCopy

Parameters:

axisNumber - an integer identifying the axis; one of the constants defined in class net.sf.saxon.om.Axis

nodeTest - A pattern to be matched by the returned nodes; nodes that do not match this pattern are not included in the result

Returns:

an AxisIterator that scans the nodes reached by the axis in turn.

Throws:

UnsupportedOperationException - if the namespace axis is requested and this axis is not supported for this implementation.

See Also:

AxisInfo

isIncludedInCopy

protected boolean isIncludedInCopy(NodeInfo sourceNode)

Description copied from class: VirtualCopy

Ask whether a node in the source tree is within the scope of this virtual copy

Overrides:

isIncludedInCopy in class VirtualCopy

Parameters:

sourceNode - the node being tested

Returns:

true if the node is within the scope of the subtree