Using s9api for XQuery
You can perform a query using the s9api interface as follows:
Processorand set any global configuration options on the
Optionally, build the source document by calling
newDocumentBuilder()to create a document builder, setting appropriate options, and then calling the
build()method. This returns an
XdmNodewhich can be supplied as input to the query either as the context item, or as the value of an external variable.
newXQueryCompiler()to create an
XQueryCompiler. Then set any options that are local to a specific compilation (for example, the destination of error messages, the base URI, or the character encoding of the query text).
Call one of the
compile()methods to compile a query. The result is an
XQueryExecutable, which can be used as often as you like in the same thread or in different threads.
To run a query, call the
load()method on the
XQueryExecutable. This creates an
XQueryEvaluatorcan be serially reused, but it must not be shared across multiple threads. Set any options required for the specific query execution (for example, the initial context node, the values of external variables, and the destination for the query result), and then call either the
run()method to execute the query.
Iterable, it is possible to iterate over the results directly using the Java 5 "for-each" construct.
The output of the query may be retrieved as an iterator over a sequence of items, or it
may be specified as a
Destination object, which allows a wide range of possibilities: you can send the
output to a serializer, or to a SAX
ContentHandler. You can build a tree
either in Saxon's native format (represented by the s9api class
as a DOM. You can send the output to be validated against a schema by nominating a
SchemaValidator as the
destination, or you can pipe it through an XSLT transformation, because
Examples of s9api queries are included in the Saxon resources file, see module S9APIExamples.java.
Separate compilation of library modules
Under Saxon-EE, it is possible to compile library modules separately from the main
module. This reduces the compilation time and memory usage when the same library module
is imported by many main modules for different queries. A method
compileLibrary() (with a number of overloaded variants supplying the
input in different ways) is provided in the
XQueryCompiler class; any
library module compiled using this method will be available to all subsequent
compilations using the same
XQueryCompiler. To import the module, simply
import module specifying the module URI in the normal way. It is not
necessary to supply a module location hint (
at "URI"), and if any is
supplied, it will be ignored.