net.sf.saxon.functions
public class VendorFunctionLibrary extends java.lang.Object implements FunctionLibrary
JavaExtensionLibrary
.Constructor and Description |
---|
VendorFunctionLibrary()
Create the Vendor Function Library for Saxon
|
Modifier and Type | Method and Description |
---|---|
Expression |
bind(StructuredQName functionName,
Expression[] staticArgs,
StaticContext env)
Bind an extension 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.
|
protected void |
init() |
boolean |
isAvailable(StructuredQName functionName,
int arity)
Test whether a Saxon function with a given name and arity is available.
|
Expression |
makeSaxonFunction(java.lang.String localName,
StaticContext env,
Expression[] arguments)
Make a Saxon function with a given name
|
static java.lang.String |
pluralArguments(int num)
Utility routine used in constructing error messages
|
protected StandardFunction.Entry |
register(java.lang.String name,
java.lang.Class implementationClass,
int opcode,
int minArguments,
int maxArguments,
ItemType itemType,
int cardinality)
Register an extension function in the table of function details.
|
public VendorFunctionLibrary()
protected StandardFunction.Entry register(java.lang.String name, java.lang.Class implementationClass, int opcode, int minArguments, int maxArguments, ItemType itemType, int cardinality)
name
- the function nameimplementationClass
- the class used to implement the functionopcode
- identifies the function when a single class implements several functionsminArguments
- the minimum number of arguments requiredmaxArguments
- the maximum number of arguments alloweditemType
- the item type of the result of the functioncardinality
- the cardinality of the result of the functionprotected void init()
public boolean isAvailable(StructuredQName functionName, int arity)
isAvailable
in interface FunctionLibrary
functionName
- the name of the functionarity
- 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 somepublic Expression bind(StructuredQName functionName, Expression[] staticArgs, StaticContext env) throws XPathException
bind
in interface FunctionLibrary
functionName
- the name of the functionstaticArgs
- 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
- 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.public Expression makeSaxonFunction(java.lang.String localName, StaticContext env, Expression[] arguments) throws XPathException
localName
- the local name of the functionenv
- the static contextarguments
- the arguments of the functionXPathException
public static java.lang.String pluralArguments(int num)
num
- a numberpublic FunctionLibrary copy()
copy
in interface FunctionLibrary