Package net.sf.saxon.functions.registry
Class BuiltInFunctionSet
java.lang.Object
net.sf.saxon.functions.registry.BuiltInFunctionSet
- All Implemented Interfaces:
FunctionLibrary
- Direct Known Subclasses:
ArrayFunctionSet
,EXPathBinaryFunctionSet
,EXPathFileFunctionSet
,ExsltCommonFunctionSet
,IXSL3FunctionSet
,IXSLFunctionSet
,MapFunctionSet
,MathFunctionSet
,SQLFunctionSet
,UseWhen30FunctionSet
,VendorFunctionSetEE
,VendorFunctionSetHE
,VendorFunctionSetPE
,XPath20FunctionSet
,XPath30FunctionSet
,XPath31FunctionSet
,XPath40FunctionSet
,XQUpdate10FunctionSet
,XSLT30FunctionSet
This class is used to contain information about a set of built-in functions.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
An entry in the table describing the properties of a function -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final int
static final int
Function propertiesstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static Sequence
static final int
static final int
protected static final int
Classification of function arguments for serialization purposes; note that values must not conflict with bit settings used for cardinalitiesstatic final int
static final int
protected static final int
static final int
static final int
static final int
Local names used for cardinality valuesstatic final int
static final int
static final int
static final int
static final int
static final int
protected static final int
static final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbind
(SymbolicName.F symbolicName, Expression[] staticArgs, Map<StructuredQName, Integer> keywords, StaticContext env, List<String> reasons) Bind a function, given the URI and local parts of the function name, and the list of expressions supplied as arguments.copy()
This method creates a copy of a FunctionLibrary: if the original FunctionLibrary allows new functions to be added, then additions to this copy will not affect the original, or vice versa.protected static RecordTest.Field
field
(String name, SequenceType type, boolean optional) Convenience method for defining fields of a record typeReturn a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.getFunctionDetails
(String name, int arity) Locate the entry for a function with a given name and arity, if it existsgetFunctionItem
(SymbolicName.F symbolicName, StaticContext staticContext) Test whether a function with a given name and arity is available; if so, return a function item that can be dynamically called.Return the namespace URI for the functions local to this function set.final void
importFunctionSet
(BuiltInFunctionSet importee) Import another function set (which must be in the same namespace)boolean
isAvailable
(SymbolicName.F symbolicName, int languageLevel) Test whether a function with a given name and arity is availablemakeFunction
(String name, int arity) protected BuiltInFunctionSet.Entry
register
(String name, int minArity, int maxArity, Function<BuiltInFunctionSet.Entry, BuiltInFunctionSet.Entry> populator) protected BuiltInFunctionSet.Entry
register
(String name, int arity, Function<BuiltInFunctionSet.Entry, BuiltInFunctionSet.Entry> populator) Register a system function in the table of function details.protected BuiltInFunctionSet.Entry
registerVariadic
(String name, int arity, Function<BuiltInFunctionSet.Entry, BuiltInFunctionSet.Entry> populator) 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.functions.FunctionLibrary
setConfiguration
-
Field Details
-
EMPTY
-
ONE
public static final int ONELocal names used for cardinality values- See Also:
-
OPT
public static final int OPT- See Also:
-
STAR
public static final int STAR- See Also:
-
PLUS
public static final int PLUS- See Also:
-
AS_ARG0
public static final int AS_ARG0Function properties- See Also:
-
AS_PRIM_ARG0
public static final int AS_PRIM_ARG0- See Also:
-
CITEM
public static final int CITEM- See Also:
-
BASE
public static final int BASE- See Also:
-
NS
public static final int NS- See Also:
-
DCOLL
public static final int DCOLL- See Also:
-
DLANG
public static final int DLANG- See Also:
-
FILTER
public static final int FILTER- See Also:
-
LATE
public static final int LATE- See Also:
-
UO
public static final int UO- See Also:
-
POSN
public static final int POSN- See Also:
-
LAST
public static final int LAST- See Also:
-
SIDE
public static final int SIDE- See Also:
-
CDOC
public static final int CDOC- See Also:
-
CARD0
public static final int CARD0- See Also:
-
NEW
public static final int NEW- See Also:
-
CTRL
public static final int CTRL- See Also:
-
SEQV
public static final int SEQV- See Also:
-
DEPENDS_ON_STATIC_CONTEXT
public static final int DEPENDS_ON_STATIC_CONTEXT- See Also:
-
FOCUS
public static final int FOCUS- See Also:
-
INS
protected static final int INSClassification of function arguments for serialization purposes; note that values must not conflict with bit settings used for cardinalities- See Also:
-
ABS
protected static final int ABS- See Also:
-
TRA
protected static final int TRA- See Also:
-
NAV
protected static final int NAV- See Also:
-
-
Constructor Details
-
BuiltInFunctionSet
public BuiltInFunctionSet()
-
-
Method Details
-
field
Convenience method for defining fields of a record type- Parameters:
name
- the field nametype
- the field typeoptional
- true if the field is optional- Returns:
- the field definition
-
importFunctionSet
Import another function set (which must be in the same namespace)- Parameters:
importee
- the function set to be imported. (No cycles allowed!)
-
getFunctionDetails
Locate the entry for a function with a given name and arity, if it exists- Parameters:
name
- the local part of the function namearity
- the arity of the function. -1 considers all possibly arities and returns an arbitrary function if one exists with the right name.- Returns:
- the entry for the required function, or null if not found
-
bind
public Expression bind(SymbolicName.F symbolicName, Expression[] staticArgs, Map<StructuredQName, Integer> keywords, StaticContext env, List<String> reasons) throws XPathExceptionBind a function, given the URI and local parts of the function name, and the list of expressions supplied as arguments. This method is called at compile time.- Specified by:
bind
in interfaceFunctionLibrary
- Parameters:
symbolicName
- the symbolic name of the function being calledstaticArgs
- May be null; if present, the length of the array must match the value of arity. Contains the expressions supplied statically in arguments to the function call. The intention is that the static type of the arguments (obtainable via getItemType() and getCardinality()) may be used as part of the binding algorithm. In some cases it may be possible for the function to be pre-evaluated at compile time, for example if these expressions are all constant values.The conventions of the XPath language demand that the results of a function depend only on the values of the expressions supplied as arguments, and not on the form of those expressions. For example, the result of f(4) is expected to be the same as f(2+2). The actual expression is supplied here to enable the binding mechanism to select the most efficient possible implementation (including compile-time pre-evaluation where appropriate).
keywords
- Keywords used in keyword parameters, with the 0-based integer position of the argument they are used on.env
- The static context of the function callreasons
- If no matching function is found by the function library, it may add a diagnostic explanation to this list explaining why none of the available functions could be used.- Returns:
- An expression equivalent to a call on the specified function, if one is found; null if no function was found matching the required name and arity.
- Throws:
XPathException
- if a matching function was identified, but the call is incorrect, for example because it uses incorrect argument keywords
-
makeFunction
- Throws:
XPathException
-
isAvailable
Test whether a function with a given name and arity is availableThis supports the function-available() function in XSLT.
- Specified by:
isAvailable
in interfaceFunctionLibrary
- Parameters:
symbolicName
- the qualified name of the function being called, together with its arity. For legacy reasons, the arity may be set to -1 to mean any arity will dolanguageLevel
- the XPath language level (times 10, e.g. 31 for XPath 3.1)- Returns:
- true if a function of this name and arity is available for calling
-
copy
This method creates a copy of a FunctionLibrary: if the original FunctionLibrary allows new functions to be added, then additions to this copy will not affect the original, or vice versa.- Specified by:
copy
in interfaceFunctionLibrary
- Returns:
- a copy of this function library. This must be an instance of the original class.
-
getFunctionItem
public FunctionItem getFunctionItem(SymbolicName.F symbolicName, StaticContext staticContext) throws XPathException Test whether a function with a given name and arity is available; if so, return a function item that can be dynamically called.This supports the function-lookup() function in XPath 3.0.
- Specified by:
getFunctionItem
in interfaceFunctionLibrary
- Parameters:
symbolicName
- the qualified name of the function being calledstaticContext
- the static context to be used by the function, in the event that it is a system function with dependencies on the static context- Returns:
- if a function of this name and arity is available for calling, then a corresponding function item; or null if the function does not exist
- Throws:
XPathException
- in the event of certain errors, for example attempting to get a function that is private
-
register
protected BuiltInFunctionSet.Entry register(String name, int arity, Function<BuiltInFunctionSet.Entry, BuiltInFunctionSet.Entry> populator) Register a system function in the table of function details.- Parameters:
name
- the function namearity
- the function arity (-1 is treated specially)- Returns:
- the entry describing the function. The entry is incomplete, it does not yet contain information about the function arguments.
-
register
protected BuiltInFunctionSet.Entry register(String name, int minArity, int maxArity, Function<BuiltInFunctionSet.Entry, BuiltInFunctionSet.Entry> populator) -
registerVariadic
protected BuiltInFunctionSet.Entry registerVariadic(String name, int arity, Function<BuiltInFunctionSet.Entry, BuiltInFunctionSet.Entry> populator) -
getNamespace
Return the namespace URI for the functions local to this function set.- Returns:
- the namespace URI of the functions local to this function set. Note that functions imported from another function set may have a different namespace URI.
-
getConventionalPrefix
Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.- Returns:
- the string "fn"
-