com.saxonica.functions.hof

Class SystemFunctionWithBoundContextItem

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

com.saxonica.functions.hof.SystemFunctionWithBoundContextItem

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class SystemFunctionWithBoundContextItem
extends AbstractFunction

A Callable that wraps another Callable and a Dynamic Context, in effect acting as a closure that executes the original callable with a saved context.

Constructor Summary

Constructors

Constructor and Description
SystemFunctionWithBoundContextItem(SystemFunction target, XPathContext context)

Method Summary

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] arguments) Evaluate the expression
int	getArity() Get the arity of the function
java.lang.String	getDescription() Get a description of this function for use in error messages.
FunctionItemType	getFunctionItemType() Get the item type of the function item
StructuredQName	getFunctionName() Get the name of the function, or null if it is anonymous

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

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

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

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

Methods inherited from class java.lang.Object

clone, equals, 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

SystemFunctionWithBoundContextItem

public SystemFunctionWithBoundContextItem(SystemFunction target,
                                          XPathContext context)

Method Detail

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 SequenceIterators

Returns:

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

Throws:

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

getArity

public int getArity()

Get the arity of the function

Returns:

the number of arguments in the function signature

getFunctionItemType

public FunctionItemType getFunctionItemType()

Get the item type of the function item

Returns:

the function item's type

getFunctionName

public StructuredQName getFunctionName()

Get the name of the function, or null if it is anonymous

Returns:

the function name, or null for an anonymous inline function

getDescription

public java.lang.String getDescription()

Get a description of this function for use in error messages. For named functions, the description is the function name (as a lexical QName). For others, it might be, for example, "inline function", or "partially-applied ends-with function".

Returns:

a description of the function for use in error messages