com.saxonica.extfn
Class ExtraFunctionLibrary

java.lang.Object
  net.sf.saxon.functions.IntegratedFunctionLibrary
      net.sf.saxon.functions.VendorFunctionLibrary
          com.saxonica.extfn.ExtraFunctionLibrary

All Implemented Interfaces:

Serializable, FunctionLibrary

public class ExtraFunctionLibrary
extends VendorFunctionLibrary

The ExtraFunctionLibrary represents additions to the set of Saxon vendor-supplied extension functions that are available only with the Saxon-PE and Saxon-EE editions

See Also:

Serialized Form

Constructor Summary

ExtraFunctionLibrary(Configuration config)

Method Summary

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.
protected void	init(Configuration config) Initialize the set of functions available

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

init, makeSaxonFunction, pluralArguments

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

copy, getFunctionSignature, iterateFunctionNames, registerFunction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtraFunctionLibrary

public ExtraFunctionLibrary(Configuration config)

Method Detail

init

protected void init(Configuration config)

Initialize the set of functions available

bind

public Expression bind(StructuredQName functionName,
                       Expression[] staticArgs,
                       StaticContext env)
                throws XPathException

Bind an extension 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 interface FunctionLibrary

Overrides:

bind in class IntegratedFunctionLibrary

Parameters:

functionName - the name of the function

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 -

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:

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.