net.sf.saxon.functions

Class CurriedSystemFunction

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.CurriedSystemFunction

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

Direct Known Subclasses:

FormatNumber.FormatNumberFixed, Translate.TranslateFixed

public abstract class CurriedSystemFunction
extends AbstractFunction

A function obtained by optimizing a system function call in which some of the parameter values are supplied statically. Used where a useful level of compile-time analysis of the statically-known argument values is possible, for example, compiling a regular expression

Constructor Summary

Constructors

Constructor and Description
CurriedSystemFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	export(ExpressionPresenter out) Output information about this function item
abstract void	exportLocalData(ExpressionPresenter out)
int	getArity() Get the arity of the function
String	getDescription() Get a description of this function for use in error messages.
StructuredQName	getFunctionName() Get the name of the function, or null if it is anonymous
abstract String	getName()

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

atomize, deepEquals, effectiveBooleanValue, getOperandRoles, getStringValue, getStringValueCS, isArray, isMap, 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.Function

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

CurriedSystemFunction

public CurriedSystemFunction()

Method Detail

getName

public abstract String getName()

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

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

Description copied from interface: Function

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

Specified by:

export in interface Function

Overrides:

export in class AbstractFunction

Parameters:

out -

exportLocalData

public abstract void exportLocalData(ExpressionPresenter out)