|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.config.JavaExtensionLibrary
public class JavaExtensionLibrary
The JavaExtensionLibrary is a FunctionLibrary that binds XPath function calls to calls on Java methods (or constructors, or fields). It performs a mapping from the namespace URI of the function to the Java class (the mapping is partly table driven and partly algorithmic), and maps the local name of the function to the Java method, constructor, or field within the class. If the Java methods are polymorphic, then it tries to select the appropriate method based on the static types of the supplied arguments. Binding is done entirely at XPath compilation time.
Constructor Summary | |
---|---|
JavaExtensionLibrary(ProfessionalConfiguration config)
Construct a JavaExtensionLibrary and establish the default uri->class mappings. |
Method Summary | |
---|---|
protected int |
atomicConversionPreference(int primitiveType,
Class required)
Get the conversion preference from an XPath primitive atomic type to a Java class |
Expression |
bind(StructuredQName functionName,
Expression[] staticArgs,
StaticContext env,
Container container)
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. |
void |
declareJavaClass(String uri,
Class theClass)
Declare a mapping from a specific namespace URI to a Java class |
JavaExtensionFunctionFactory |
getExtensionFunctionFactory()
Get the ExtensionFunctionFactory used by this extension library. |
protected Class |
getExternalJavaClass(String uri)
Get an external Java class corresponding to a given namespace URI, if there is one. |
SequenceType[] |
getFunctionSignature(StructuredQName functionName,
int arity)
Test whether a function with a given name and arity is available; if so, return its signature. |
boolean |
isStrictJavaUriFormat()
Ask whether only the strict "java:" URI format is to be recognized. |
void |
setExtensionFunctionFactory(JavaExtensionFunctionFactory factory)
Set the ExtensionFunctionFactory to be used by this extension library. |
void |
setStrictJavaUriFormat(boolean strict)
Say that only the strict "java:" URI format is to be recognized. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavaExtensionLibrary(ProfessionalConfiguration config)
config
- The Saxon configurationMethod Detail |
---|
public void setExtensionFunctionFactory(JavaExtensionFunctionFactory factory)
factory
- This must be an instanceof JavaExtensionFunctionFactorypublic JavaExtensionFunctionFactory getExtensionFunctionFactory()
public boolean isStrictJavaUriFormat()
public void setStrictJavaUriFormat(boolean strict)
strict
- true if only the strict format is recognizedpublic void declareJavaClass(String uri, Class theClass)
uri
- the namespace URI of the function nametheClass
- the Java class that implements the functions in this namespacepublic SequenceType[] getFunctionSignature(StructuredQName functionName, int arity)
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.
getFunctionSignature
in interface FunctionLibrary
functionName
- the qualified name of the function being calledarity
- 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.
public Expression bind(StructuredQName functionName, Expression[] staticArgs, StaticContext env, Container container) throws XPathException
bind
in interface FunctionLibrary
functionName
- the qualified name of the function being calledstaticArgs
- 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 contextcontainer
-
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.protected int atomicConversionPreference(int primitiveType, Class required)
primitiveType
- integer code identifying the XPath primitive type, for example
StandardNames.XS_STRING
or StandardNames.XS_STRING
required
- The Java Class named in the method signature
StringValue
is 50, while
XPath String to String
is 51. The value -1 indicates that the conversion is not allowed.protected Class getExternalJavaClass(String uri)
uri
- The namespace URI corresponding to the prefix used in the function call.
public FunctionLibrary copy()
copy
in interface FunctionLibrary
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |