com.saxonica.functions.hof

Class CallableFunctionItem

java.lang.Object

net.sf.saxon.om.AbstractItem

com.saxonica.functions.hof.AbstractFunctionItem

com.saxonica.functions.hof.CallableFunctionItem

All Implemented Interfaces:

PullEvent, Callable, FunctionItem, GroundedValue, Item, Sequence

public class CallableFunctionItem
extends AbstractFunctionItem

A function item that wraps a Callable

Constructor Summary

Constructors

Constructor and Description
CallableFunctionItem(int arity, Callable callable, FunctionItemType type)
CallableFunctionItem(SymbolicName name, Callable callable, FunctionItemType type)
CallableFunctionItem(UserFunction function)

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] args) Invoke the function
int	getArity() Get the arity of the function
Callable	getCallable()
FunctionItemType	getFunctionItemType(TypeHierarchy th) Get the item type of the function item
StructuredQName	getFunctionName() Get the name of the function, or null if it is anonymous
void	setCallable(Callable callable)
void	setType(FunctionItemType type)

Methods inherited from class com.saxonica.functions.hof.AbstractFunctionItem

deepEquals, effectiveBooleanValue, explain, getStringValue, getStringValueCS, getTypedValue, 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

CallableFunctionItem

public CallableFunctionItem(SymbolicName name,
                    Callable callable,
                    FunctionItemType type)

CallableFunctionItem

public CallableFunctionItem(int arity,
                    Callable callable,
                    FunctionItemType type)

CallableFunctionItem

public CallableFunctionItem(UserFunction function)

Method Detail

getCallable

public Callable getCallable()

setCallable

public void setCallable(Callable callable)

setType

public void setType(FunctionItemType type)

getFunctionItemType

public FunctionItemType getFunctionItemType(TypeHierarchy th)

Get the item type of the function item

Parameters:

th - the type hierarchy cache

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

getArity

public int getArity()

Get the arity of the function

Returns:

the number of arguments in the function signature

call

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

Invoke the function

Parameters:

context - the XPath dynamic evaluation context

args - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function