Package 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:
Source
,SourceLocator
,ActiveSource
,GroundedValue
,Item
,NodeInfo
,Sequence
,Location
,Locator
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
FieldsFields inherited from class net.sf.saxon.tree.wrapper.VirtualCopy
original, parent, root, systemIdSupplier, tree
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SnapshotNode
(NodeInfo base, NodeInfo pivot) Protected constructor: create a virtual copy of a node -
Method Summary
Modifier and TypeMethodDescriptionatomize()
Get the typed value of this nodevoid
Copy this node to a given outputterGet the NodeInfo object representing the parent of this nodeReturn the public identifier for the _current document event.getRoot()
Get the root node of the tree containing this nodeGet the string value of the item.boolean
isId()
Determine whether this node has the is-id propertyboolean
isIdref()
Determine whether this node has the is-idref propertyprotected boolean
isIncludedInCopy
(NodeInfo sourceNode) Ask whether a node in the source tree is within the scope of this virtual copyboolean
isNilled()
Determine whether the node has the is-nilled propertyiterateAxis
(int axisNumber, NodePredicate nodeTest) Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTeststatic SnapshotNode
makeSnapshot
(NodeInfo original) Public factory method: apply the snapshot function to a nodeprotected SnapshotNode
Wrap a node in a VirtualCopy.Methods inherited from class net.sf.saxon.tree.wrapper.VirtualCopy
compareOrder, equals, generateId, getAllNamespaces, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getLineNumber, getLocalPart, getNamespaceUri, getNodeKind, getOriginalNode, getPrefix, getSchemaType, getSystemId, getTreeInfo, hasChildNodes, hasFingerprint, hashCode, makeCopier, 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.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.s9api.Location
saveLocation
Methods inherited from interface net.sf.saxon.om.NodeInfo
asActiveSource, attributes, children, children, compareOrder, deliver, equals, generateId, getAllNamespaces, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getGenre, getLineNumber, getLocalPart, getNamespaceUri, getNodeKind, getPrefix, getSchemaType, getSystemId, getTreeInfo, getURI, hasChildNodes, hasFingerprint, hashCode, isSameNodeInfo, isStreamed, iterateAxis, setSystemId, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
pivot
-
-
Constructor Details
-
SnapshotNode
Protected constructor: create a virtual copy of a node- Parameters:
base
- the node in the source tree to which the new node should correspondpivot
- 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 Details
-
makeSnapshot
Public factory method: apply the snapshot function to a node- Parameters:
original
- the node to be copied- Returns:
- the snapshot.
-
wrap
Wrap a node in a VirtualCopy.- Overrides:
wrap
in classVirtualCopy
- Parameters:
node
- the node to be wrapped- Returns:
- a virtual copy of the node
-
getUnicodeStringValue
Get the string value of the item. 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:
getUnicodeStringValue
in interfaceGroundedValue
- Specified by:
getUnicodeStringValue
in interfaceItem
- Overrides:
getUnicodeStringValue
in classVirtualCopy
- Returns:
- the string value of the node, as a
UnicodeString
-
getParent
Get the NodeInfo object representing the parent of this node- Specified by:
getParent
in interfaceNodeInfo
- Overrides:
getParent
in classVirtualCopy
- Returns:
- the parent of this node; null if this node has no parent
-
getRoot
Get the root node of the tree containing this node- Specified by:
getRoot
in interfaceNodeInfo
- Overrides:
getRoot
in classVirtualCopy
- Returns:
- the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node
-
copy
Copy this node to a given outputter- Specified by:
copy
in interfaceNodeInfo
- Overrides:
copy
in classVirtualCopy
- Parameters:
out
- the Receiver to which the node should be copiedcopyOptions
- a selection of the options defined inCopyOptions
locationId
- Identifies the location of the instruction- Throws:
XPathException
- if any downstream error occurs
-
atomize
Get the typed value of this node- Specified by:
atomize
in interfaceItem
- Specified by:
atomize
in interfaceNodeInfo
- Overrides:
atomize
in classVirtualCopy
- 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 interfaceNodeInfo
- Overrides:
isId
in classVirtualCopy
- 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 interfaceNodeInfo
- Overrides:
isIdref
in classVirtualCopy
- 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 interfaceNodeInfo
- Overrides:
isNilled
in classVirtualCopy
- Returns:
- true if the node has the is-nilled property
-
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 interfaceLocation
- Specified by:
getPublicId
in interfaceLocator
- Specified by:
getPublicId
in interfaceNodeInfo
- Specified by:
getPublicId
in interfaceSourceLocator
- Overrides:
getPublicId
in classVirtualCopy
- Returns:
- A string containing the public identifier, or null if none is available.
- See Also:
-
iterateAxis
Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest- Specified by:
iterateAxis
in interfaceNodeInfo
- Overrides:
iterateAxis
in classVirtualCopy
- Parameters:
axisNumber
- an integer identifying the axis; one of the constants defined in class net.sf.saxon.om.AxisnodeTest
- 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:
-
isIncludedInCopy
Description copied from class:VirtualCopy
Ask whether a node in the source tree is within the scope of this virtual copy- Overrides:
isIncludedInCopy
in classVirtualCopy
- Parameters:
sourceNode
- the node being tested- Returns:
- true if the node is within the scope of the subtree
-