Package net.sf.saxon.functions.registry
Class BuiltInFunctionSet.Entry
java.lang.Object
net.sf.saxon.functions.registry.BuiltInFunctionSet.Entry
- Enclosing class:
BuiltInFunctionSet
An entry in the table describing the properties of a function
-
Field Summary
FieldsModifier and TypeFieldDescriptionAn array holding the types of the arguments to the functionint
The arity of the functionint
The cardinality of the result of the functionThe class containing the implementation of this function (always a subclass of SystemFunction)The item type of the result of the functionThe name of the function as a QNameFor options parameters, details of the accepted options, their defaults, and required typeint
Any additional properties.Sequence[]
An array holding, for each declared argument, the value that is to be returned if an empty sequence as the value of this argument allows the result to be determined irrespective of the values of the other arguments; null if there is no such calculation possibleThe syntactic context of each argument for the purposes of streamability analysis -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd information to a function entry about the argument types of the functionoptionDetails
(OptionsParameter details) Add details for options parameters (only applies to one argument, the function is expected to know which)
-
Field Details
-
name
The name of the function as a QName -
implementationClass
The class containing the implementation of this function (always a subclass of SystemFunction) -
arity
public int arityThe arity of the function -
itemType
The item type of the result of the function -
cardinality
public int cardinalityThe cardinality of the result of the function -
usage
The syntactic context of each argument for the purposes of streamability analysis -
argumentTypes
An array holding the types of the arguments to the function -
resultIfEmpty
An array holding, for each declared argument, the value that is to be returned if an empty sequence as the value of this argument allows the result to be determined irrespective of the values of the other arguments; null if there is no such calculation possible -
properties
public int propertiesAny additional properties. Various bit settings are defined: for example SAME_AS_FIRST_ARGUMENT indicates that the result type is the same as the type of the first argument -
optionDetails
For options parameters, details of the accepted options, their defaults, and required type
-
-
Constructor Details
-
Entry
public Entry()
-
-
Method Details
-
arg
Add information to a function entry about the argument types of the function- Parameters:
a
- the position of the argument, counting from zerotype
- the item type of the argumentoptions
- the cardinality and usage of the argumentresultIfEmpty
- the value returned by the function if an empty sequence appears as the value of this argument, in the case when this result is unaffected by any other arguments. Supply null if this does not apply.- Returns:
- this entry (to allow chaining)
-
optionDetails
Add details for options parameters (only applies to one argument, the function is expected to know which)
-