com.saxonica.functions.xslt3

Class SnapshotFn

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.xslt3.SnapshotFn

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class SnapshotFn
extends SystemFunction

XSLT 3.0 function snapshot(). This is like a deep-copy except that it also includes a shallow copy of all ancestors.

Constructor Summary

Constructors

Constructor and Description
SnapshotFn()

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] arguments) Evaluate the expression
static void	closeAncestors(List<NodeInfo> ancestors, Receiver bm)
int	getCardinality(Expression[] arguments) Get the cardinality, given knowledge of the actual arguments
static ItemMappingFunction<Item,Item>	getMappingFunction(XPathContext context)
StreamingAdjunct	getStreamingAdjunct() Get a class that supports streamed evaluation of this expression
static List<NodeInfo>	makeAncestorList(NodeInfo origin)
static BuilderMonitor	openAncestors(NodeInfo origin, List<NodeInfo> ancestors, XPathContext context)
static SequenceIterator	snapshotSequence(SequenceIterator nodes, XPathContext context)
static Item	snapshotSingle(Item origin)

Methods inherited from class net.sf.saxon.functions.SystemFunction

equals, export, exportAttributes, getArity, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getExpressionCompiler, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, importAttributes, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

iterate

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

head

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

getLength, head, itemAt, reduce, subsequence

Constructor Detail

SnapshotFn

public SnapshotFn()

Method Detail

getCardinality

public int getCardinality(Expression[] arguments)

Description copied from class: SystemFunction

Get the cardinality, given knowledge of the actual arguments

Overrides:

getCardinality in class SystemFunction

Parameters:

arguments - the actual arguments supplied

Returns:

the most precise available cardinality that the function will return

call

public Sequence call(XPathContext context,
            Sequence[] arguments)
              throws XPathException

Evaluate the expression

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as Sequences

Returns:

the result of the evaluation, in the form of a Sequence

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

snapshotSequence

public static SequenceIterator snapshotSequence(SequenceIterator nodes,
                                XPathContext context)
                                         throws XPathException

Throws:

XPathException

getMappingFunction

public static ItemMappingFunction<Item,Item> getMappingFunction(XPathContext context)

snapshotSingle

public static Item snapshotSingle(Item origin)
                           throws XPathException

Throws:

XPathException

makeAncestorList

public static List<NodeInfo> makeAncestorList(NodeInfo origin)

openAncestors

public static BuilderMonitor openAncestors(NodeInfo origin,
                           List<NodeInfo> ancestors,
                           XPathContext context)
                                    throws XPathException

Throws:

XPathException

closeAncestors

public static void closeAncestors(List<NodeInfo> ancestors,
                  Receiver bm)
                           throws XPathException

Throws:

XPathException

getStreamingAdjunct

public StreamingAdjunct getStreamingAdjunct()

Get a class that supports streamed evaluation of this expression

Overrides:

getStreamingAdjunct in class SystemFunction

Returns:

the relevant StreamingAdjunct, or null if none is available