net.sf.saxon.functions
public class ExecutableFunctionLibrary extends Object implements FunctionLibrary
Constructor Summary | |
---|---|
ExecutableFunctionLibrary(Configuration config)
Create the ExecutableFunctionLibrary |
Method Summary | |
---|---|
void | addFunction(UserFunction fn)
Register a function with the function library |
Expression | bind(StructuredQName functionName, Expression[] staticArgs, StaticContext env)
Bind a function, given the URI and local parts of the function name,
and the list of expressions supplied as arguments. |
FunctionLibrary | 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.
|
SequenceType[] | getFunctionSignature(StructuredQName functionName, int arity)
Test whether a function with a given name and arity is available; if so, return its signature.
|
Iterator<UserFunction> | iterateFunctions()
Iterate over all the functions defined in this function library. |
Parameters: config the Saxon configuration
Parameters: fn the function to be registered
Parameters: functionName The name of the function to be called staticArgs The expressions supplied statically in 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. env the static evaluation context
Returns: An object representing the extension function to be called, if one is found; null if no extension function was found matching the required name and arity.
Throws: net.sf.saxon.trans.XPathException if a function is found with the required name and arity, but the implementation of the function cannot be loaded or used; or if an error occurs while searching for the function; or if this function library "owns" the namespace containing the function call, but no function was found.
Returns: a copy of this function library. This must be an instance of the original class.
This method may be called either at compile time or at run time. If the function library is to be used only in an XQuery or free-standing XPath environment, this method may throw an UnsupportedOperationException.
Parameters: functionName the qualified name of the function being called arity The number of arguments. This is set to -1 in the case of the single-argument function-available() function; in this case the method should return true if there is some function of this name available for calling.
Returns: if a function of this name and arity is available for calling, then the type signature of the function, as an array of sequence types in which the zeroth entry represents the return type; or a zero-length array if the function exists but the signature is not known; or null if the function does not exist
Returns: an iterator delivering the UserFunction objects representing the user-defined functions in a stylesheet or query