com.saxonica.functions.hof

Class AtomicConstructorFunction

java.lang.Object

net.sf.saxon.functions.AbstractFunction

com.saxonica.functions.hof.AtomicConstructorFunction

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class AtomicConstructorFunction
extends AbstractFunction

A function item representing a constructor function for an atomic type

Constructor Summary

Constructors

Constructor and Description
AtomicConstructorFunction(AtomicType targetType, NamespaceResolver resolver) Create the constructor function.

Method Summary

Modifier and Type	Method and Description
ZeroOrOne<AtomicValue>	call(XPathContext context, Sequence[] args) Invoke the function
void	export(ExpressionPresenter out) Output information about this function item to the diagnostic explain() output
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
boolean	isTrustedResultType() Check that result type is SystemFunction or AtomicConstructorFunction

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

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getOperandRoles, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, 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

argumentArray, getGenre, toShortString

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

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

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

asIterable, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AtomicConstructorFunction

public AtomicConstructorFunction(AtomicType targetType,
                                 NamespaceResolver resolver)

Create the constructor function.

Parameters:

targetType - the type to which the function will convert its input

resolver - namespace resolver for use if the target type is namespace-sensitive

Method Detail

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

getArity

public int getArity()

Get the arity of the function

Returns:

the number of arguments in the function signature

call

public ZeroOrOne<AtomicValue> 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

export

public void export(ExpressionPresenter out)
            throws XPathException

Description copied from class: AbstractFunction

Output information about this function item to the diagnostic explain() output

Specified by:

export in interface Function

Overrides:

export in class AbstractFunction

Throws:

XPathException

isTrustedResultType

public boolean isTrustedResultType()

Description copied from class: AbstractFunction

Check that result type is SystemFunction or AtomicConstructorFunction

Specified by:

isTrustedResultType in interface Function

Overrides:

isTrustedResultType in class AbstractFunction