Package com.saxonica.functions.extfn

Class Evaluate

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.Evaluate

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

Direct Known Subclasses:

Eval, ExpressionFn

public class Evaluate
extends SystemFunction

This class implements the saxon:evaluate() extension function

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Evaluate.PreparedExpression	Inner class PreparedExpression represents a compiled XPath expression together with the standard variables $p1 ..

Constructor Summary

Constructors

Constructor	Description
Evaluate()

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] arguments)	Evaluate this function call at run-time
protected IndependentContext	makeStaticContext(XPathContext context, NodeInfo namespaceOrigin, java.lang.String baseUri)
protected Evaluate.PreparedExpression	prepareExpression(java.lang.String exprText, NodeInfo namespaceOrigin, java.lang.String baseUri, java.lang.String functionName, XPathContext context)

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

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

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

makeRepeatable

Constructor Detail

Evaluate

public Evaluate()

Method Detail

makeStaticContext

protected IndependentContext makeStaticContext(XPathContext context,
                                               NodeInfo namespaceOrigin,
                                               java.lang.String baseUri)

prepareExpression

protected Evaluate.PreparedExpression prepareExpression(java.lang.String exprText,
                                                        NodeInfo namespaceOrigin,
                                                        java.lang.String baseUri,
                                                        java.lang.String functionName,
                                                        XPathContext context)
                                                 throws XPathException

Throws:

XPathException

call

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

Evaluate this function call at run-time

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 during evaluation of the function. The Saxon run-time code will add information about the error location.