net.sf.saxon.query
public class XQueryFunctionLibrary extends Object implements FunctionLibrary, XQueryFunctionBinder
Constructor Summary | |
---|---|
XQueryFunctionLibrary(Configuration config)
Create an XQueryFunctionLibrary |
Method Summary | |
---|---|
Expression | bind(int nameCode, String uri, String local, Expression[] arguments)
Identify a (namespace-prefixed) function appearing in the expression. |
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.
|
void | declareFunction(XQueryFunction function)
Register a user-defined XQuery function |
void | explainGlobalFunctions()
Output "explain" information about each declared function |
protected void | fixupGlobalFunctions(StaticQueryContext env)
Fixup all references to global functions. |
Configuration | getConfiguration()
Get the Configuration options |
XQueryFunction | getDeclaration(int nameCode, String uri, String local, Expression[] staticArgs)
Get the function declaration corresponding to a given function name and arity |
Iterator | getFunctionDefinitions()
Get an iterator over the Functions defined in this module |
UserFunction | getUserDefinedFunction(String uri, String localName, int arity)
Get the function with a given name and arity. |
boolean | isAvailable(int fingerprint, String uri, String local, int arity)
Test whether a function with a given name and arity is available. |
void | setConfiguration(Configuration config)
Set the Configuration options |
Note that a function call may appear earlier in the query than the definition of the function to which it is bound. Unlike XSLT, we cannot search forwards to find the function definition. Binding of function calls is therefore a two-stage process; at the time the function call is parsed, we simply register it as pending; subsequently at the end of query parsing all the pending function calls are resolved. Another consequence of this is that we cannot tell at the time a function call is parsed whether it is a call to an internal (XSLT or XQuery) function or to an extension function written in Java.
Returns: an Expression representing the function call. This will normally be a FunctionCall, but it may be rewritten as some other expression.
Throws: XPathException if the function call is invalid, either because it is an unprefixed call to a non-system function, or because it is calling a system function that is available in XSLT only. A prefixed function call that cannot be recognized at this stage is assumed to be a forwards reference, and is bound later when bindUnboundFunctionCalls() is called.
Returns: a copy of this function library. This must be an instance of the original class.
This method is for internal use.
Returns: the XQueryFunction if there is one, or null if not.
Returns: an Iterator, whose items are XQueryFunction objects. It returns all function known to this module including those imported from elsewhere; they can be distinguished by their namespace.
Parameters: uri the uri of the function name localName the local part of the function name arity the number of arguments.
Parameters: uri The URI of the function name local The local part of the function name 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 matching extension function, regardless of its arity.