com.saxonica.functions.hof

Class InlineFunction

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

com.saxonica.functions.hof.InlineFunction

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class InlineFunction
extends AbstractFunction

A function item representing an anonymous inline function. The implementation is a simple wrapper around the UserFunction class, used for named user-defined functions in XSLT and XQuery.

Constructor Summary

Constructors

Constructor and Description
InlineFunction(UserFunction function)

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] args) Invoke the function
void	export(ExpressionPresenter out) Output information about this function item to the export() output
int	getArity() Get the arity of the function
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
void	simplify()
String	toString()
void	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Type check the function (may modify it by adding code for converting the arguments)

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

atomize, deepEquals, effectiveBooleanValue, getOperandRoles, getStringValue, getStringValueCS, isArray, isMap, optimize

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

InlineFunction

public InlineFunction(UserFunction function)

Method Detail

simplify

public void simplify()
              throws XPathException

Overrides:

simplify in class AbstractFunction

Throws:

XPathException

typeCheck

public void typeCheck(ExpressionVisitor visitor,
             ContextItemStaticInfo contextItemType)
               throws XPathException

Type check the function (may modify it by adding code for converting the arguments)

Overrides:

typeCheck in class AbstractFunction

Parameters:

visitor - the expression visitor, supplies context information

contextItemType - the context item type at the point where the function definition appears

Throws:

XPathException - if any failure (e.g. a type checking failure) occurs

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

getArity

public int getArity()

Get the arity of the function

Returns:

the number of arguments in the function signature

export

public void export(ExpressionPresenter out)

Output information about this function item to the export() output

Specified by:

export in interface Function

Overrides:

export in class AbstractFunction

Parameters:

out - the output destination

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

toString

public String toString()

Overrides:

toString in class Object