com.saxonica.functions.extfn

Class ExpressionFn

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.Evaluate

com.saxonica.functions.extfn.ExpressionFn

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class ExpressionFn
extends Evaluate

This class implements the saxon:expression() extension function.

Nested Class Summary

Nested classes/interfaces inherited from class com.saxonica.functions.extfn.Evaluate

Evaluate.PreparedExpression

Constructor Summary

Constructors

Constructor and Description
ExpressionFn()

Method Summary

Modifier and Type	Method and Description
ExternalObject<Evaluate.PreparedExpression>	call(XPathContext context, Sequence[] arguments) Evaluate this function call at run-time

Methods inherited from class com.saxonica.functions.extfn.Evaluate

makeStaticContext, prepareExpression

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

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

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

argumentArray, getGenre

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

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

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

asIterable, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ExpressionFn

public ExpressionFn()

Method Detail

call

public ExternalObject<Evaluate.PreparedExpression> call(XPathContext context,
                                                        Sequence[] arguments)
                                                 throws XPathException

Description copied from class: Evaluate

Evaluate this function call at run-time

Specified by:

call in interface Callable

Specified by:

call in interface Function

Overrides:

call in class Evaluate

Parameters:

context - The XPath dynamic evaluation context

arguments - The values of the arguments to the function call. Each argument value (which is in general a sequence) is supplied in the form of an iterator over the items in the sequence. If required, the supplied sequence can be materialized by calling, for example, new SequenceExtent(arguments[i]). If the argument is always a singleton, then the single item may be obtained by calling arguments[i].next(). The implementation is not obliged to read all the items in each SequenceIterator if they are not required to compute the result; but if any SequenceIterator is not read to completion, it is good practice to call its close() method.

Returns:

an iterator over the results of the function. If the result is a single item, it can be returned in the form of a SingletonIterator. If the result is an empty sequence, the method should return EmptyIterator.getInstance()

Throws:

XPathException - if a dynamic error occurs within the function