Package net.sf.saxon.functions.hof

Class UnresolvedXQueryFunctionItem

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.hof.UnresolvedXQueryFunctionItem

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class UnresolvedXQueryFunctionItem
extends AbstractFunction

Constructor Summary

Constructors

Constructor	Description
UnresolvedXQueryFunctionItem(XQueryFunction fd, SymbolicName.F functionName, UserFunctionReference ref)

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] args)	Call the Callable.
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
UserFunctionReference	getFunctionReference()

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

atomize, deepEquals, effectiveBooleanValue, export, getAnnotations, getOperandRoles, getSerialNumber, getUnicodeStringValue, isArray, isMap, isTrustedResultType, makeNewContext, simplify, toShortString, typeCheck

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

getGenre, isSequenceVariadic

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

asIterable, concatenate, containsNode, materialize

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

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

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

makeRepeatable

Constructor Detail

UnresolvedXQueryFunctionItem

public UnresolvedXQueryFunctionItem(XQueryFunction fd,
                                    SymbolicName.F functionName,
                                    UserFunctionReference ref)

Method Detail

getFunctionItemType

public FunctionItemType getFunctionItemType()

Description copied from interface: Function

Get the item type of the function item

Returns:

the function item's type

getFunctionName

public StructuredQName getFunctionName()

Description copied from interface: Function

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()

Description copied from interface: Function

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

Description copied from interface: Callable

Call the Callable.

Parameters:

context - the dynamic evaluation context

args - the values of the arguments, supplied as Sequences.

Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

Returns:

the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.

Throws:

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

getDescription

public java.lang.String getDescription()

Description copied from interface: Function

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

getFunctionReference

public UserFunctionReference getFunctionReference()