net.sf.saxon.dotnet
Class DotNetExtensionLibrary
java.lang.Object
net.sf.saxon.dotnet.DotNetExtensionLibrary
- FunctionLibrary, Serializable
public class DotNetExtensionLibrary
extends java.lang.Object
The DotNetExtensionLibrary is a FunctionLibrary that binds XPath function calls to
calls on .NET methods (or constructors, or properties). It performs a mapping from
the namespace URI of the function to the .NET assembly and type (the mapping is partly table
driven and partly algorithmic), and maps the local name of the function to the
.NET method, constructor, or property within the class. If the .NET 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.
protected int | atomicConversionPreference(int primitiveType, cli.System.Type required) - Get the conversion preference from an XPath primitive atomic type to a .NET type
|
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.
|
void | declareDotNetType(String uri, cli.System.Type theClass) - Declare a mapping from a specific namespace URI to a .NET class
|
boolean | isAvailable(StructuredQName functionName, 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 .NET classes (this covers
the Saxon and EXSLT extensions).
|
DotNetExtensionLibrary
public DotNetExtensionLibrary(Configuration config)
Construct a JavaExtensionLibrary and establish the default uri->class mappings.
config
- The Saxon configuration
atomicConversionPreference
protected int atomicConversionPreference(int primitiveType,
cli.System.Type required)
Get the conversion preference from an XPath primitive atomic type to a .NET type
primitiveType
- integer code identifying the XPath primitive type, for example
StandardNames.XS_STRING
or StandardNames.XS_STRING
required
- The .NET Class named in the method signature
- an integer indicating the relative preference for converting this primitive type
to this .NET class. A high number indicates a low preference. All values are in the range
50 to 100. For example, the conversion of an XPath String to
StringValue
is 50, while
XPath String to String
is 51. The value -1 indicates that the conversion is not allowed.
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.
- 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
- the static context of the function call
- An object representing the extension function to be called, if one is found;
null if no extension function was found matching the required name, arity, or signature.
copy
public 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.
- copy in interface FunctionLibrary
- a copy of this function library. This must be an instance of the original class.
declareDotNetType
public void declareDotNetType(String uri,
cli.System.Type theClass)
Declare a mapping from a specific namespace URI to a .NET class
uri
- the namespace URI of the function nametheClass
- the .NET class that implements the functions in this namespace
isAvailable
public boolean isAvailable(StructuredQName functionName,
int arity)
Test whether an extension function with a given name and arity is available. This supports
the function-available() function in XSLT. This method may be called either at compile time
or at run time.
- isAvailable in interface FunctionLibrary
functionName
- 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
setDefaultURIMappings
protected void setDefaultURIMappings()
Define initial mappings of "well known" namespace URIs to .NET classes (this covers
the Saxon and EXSLT extensions). The method is protected so it can be overridden in
a subclass.