public class JavaExtensionLibrary extends java.lang.Object implements FunctionLibrary
Constructor and Description |
---|
JavaExtensionLibrary(Configuration config)
Construct a JavaExtensionLibrary and establish the default uri->class mappings.
|
Modifier and Type | Method and Description |
---|---|
protected int |
atomicConversionPreference(int primitiveType,
java.lang.Class required)
Get the conversion preference from an XPath primitive atomic type to a Java class
|
Expression |
bind(int nameCode,
java.lang.String uri,
java.lang.String local,
Expression[] staticArgs)
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(java.lang.String uri,
java.lang.Class theClass)
Declare a mapping from a specific namespace URI to a Java class
|
boolean |
isAvailable(int fingerprint,
java.lang.String uri,
java.lang.String local,
int arity)
Test whether an extension function with a given name and arity is available.
|
protected void |
setDefaultURIMappings()
Define initial mappings of "well known" namespace URIs to Java classes (this covers
the Saxon and EXSLT extensions).
|
static java.lang.String |
toCamelCase(java.lang.String name,
boolean debug,
java.io.PrintStream diag)
Convert a name to camelCase (by removing hyphens and changing the following
letter to capitals)
|
public JavaExtensionLibrary(Configuration config)
config
- The Saxon configurationprotected void setDefaultURIMappings()
public void declareJavaClass(java.lang.String uri, java.lang.Class theClass)
uri
- the namespace URI of the function nametheClass
- the Java class that implements the functions in this namespacepublic boolean isAvailable(int fingerprint, java.lang.String uri, java.lang.String local, int arity)
isAvailable
in interface FunctionLibrary
fingerprint
- The code that identifies the function name in the NamePool. This must
match the supplied URI and local name.uri
- The URI of the function namelocal
- The local part of the function namearity
- 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.public Expression bind(int nameCode, java.lang.String uri, java.lang.String local, Expression[] staticArgs) throws XPathException
bind
in interface FunctionLibrary
nameCode
- The namepool code of the function name. This must match the supplied
URI and local name.uri
- The URI of the function namelocal
- The local part of the function namestaticArgs
- 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.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.public static java.lang.String toCamelCase(java.lang.String name, boolean debug, java.io.PrintStream diag)
name
- the name to be converted to camelCasedebug
- true if tracing is requiredprotected int atomicConversionPreference(int primitiveType, java.lang.Class required)
primitiveType
- integer code identifying the XPath primitive type, for example
Type.INTEGER
or Type.STRING
required
- The Java Class named in the method signatureStringValue
is 50, while
XPath String to String
is 51. The value -1 indicates that the conversion is not allowed.public FunctionLibrary copy()
copy
in interface FunctionLibrary