net.sf.saxon.s9api.XQueryCompiler Maven / Gradle / Ivy
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2015 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.s9api;
import net.sf.saxon.Configuration;
import net.sf.saxon.lib.ErrorGatherer;
import net.sf.saxon.lib.ModuleURIResolver;
import net.sf.saxon.lib.StringCollator;
import net.sf.saxon.pattern.NodeKindTest;
import net.sf.saxon.query.StaticQueryContext;
import net.sf.saxon.trans.XPathException;
import javax.xml.transform.ErrorListener;
import java.io.*;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.List;
/**
* An XQueryCompiler object allows XQuery 1.0 queries to be compiled. The compiler holds information that
* represents the static context for the compilation.
*
* To construct an XQueryCompiler, use the factory method {@link Processor#newXQueryCompiler}.
*
* An XQueryCompiler may be used repeatedly to compile multiple queries. Any changes made to the
* XQueryCompiler (that is, to the static context) do not affect queries that have already been compiled.
* An XQueryCompiler may be used concurrently in multiple threads, but it should not then be modified once
* initialized.
*
* @since 9.0
*/
public class XQueryCompiler {
private Processor processor;
private StaticQueryContext env;
private ItemType requiredContextItemType;
private String encoding;
/**
* Protected constructor
*
* @param processor the Saxon Processor
*/
protected XQueryCompiler(Processor processor) {
this.processor = processor;
this.env = processor.getUnderlyingConfiguration().newStaticQueryContext();
}
/**
* Get the Processor from which this XQueryCompiler was constructed
*
* @return the Processor to which this XQueryCompiler belongs
* @since 9.3
*/
public Processor getProcessor() {
return processor;
}
/**
* Set the static base URI for the query
*
* @param baseURI the static base URI; or null to indicate that no base URI is available
*/
public void setBaseURI(URI baseURI) {
if (baseURI == null) {
env.setBaseURI(null);
} else {
if (!baseURI.isAbsolute()) {
throw new IllegalArgumentException("Base URI must be an absolute URI: " + baseURI);
}
env.setBaseURI(baseURI.toString());
}
}
/**
* Get the static base URI for the query
*
* @return the static base URI
*/
public URI getBaseURI() {
try {
return new URI(env.getBaseURI());
} catch (URISyntaxException err) {
throw new IllegalStateException(err);
}
}
/**
* Set the ErrorListener to be used during this query compilation episode
*
* @param listener The error listener to be used. This is notified of all errors detected during the
* compilation. Static errors (as defined in the XQuery specification) are notified
* to the {@link ErrorListener#fatalError(javax.xml.transform.TransformerException)} method.
* Warnings are notified to the {@link ErrorListener#warning(javax.xml.transform.TransformerException)}.
* Any exception thrown by these methods is ignored.
*/
public void setErrorListener(ErrorListener listener) {
env.setErrorListener(listener);
}
/**
* Get the ErrorListener being used during this compilation episode
*
* @return listener The error listener in use. This is notified of all errors detected during the
* compilation. If no user-supplied ErrorListener has been set, returns the system-supplied
* ErrorListener.
*/
public ErrorListener getErrorListener() {
return env.getErrorListener();
}
/**
* Set whether trace hooks are to be included in the compiled code. To use tracing, it is necessary
* both to compile the code with trace hooks included, and to supply a TraceListener at run-time
*
* @param option true if trace code is to be compiled in, false otherwise
*/
public void setCompileWithTracing(boolean option) {
env.setCompileWithTracing(option);
}
/**
* Ask whether trace hooks are included in the compiled code.
*
* @return true if trace hooks are included, false if not.
*/
public boolean isCompileWithTracing() {
return env.isCompileWithTracing();
}
/**
* Set a user-defined ModuleURIResolver for resolving URIs used in import module
* declarations in the XQuery prolog.
* This will override any ModuleURIResolver that was specified as part of the configuration.
*
* @param resolver the ModuleURIResolver to be used
*/
public void setModuleURIResolver(ModuleURIResolver resolver) {
env.setModuleURIResolver(resolver);
}
/**
* Get the user-defined ModuleURIResolver for resolving URIs used in import module
* declarations in the XQuery prolog; returns null if none has been explicitly set either
* here or in the Saxon Configuration.
*
* @return the registered ModuleURIResolver
*/
/*@Nullable*/
public ModuleURIResolver getModuleURIResolver() {
return env.getModuleURIResolver();
}
/**
* Set the encoding of the supplied query. This is ignored if the query is supplied
* in character form, that is, as a String or as a Reader. If no value
* is set, the query processor will attempt to infer the encoding, defaulting to UTF-8 if no
* information is available.
*
* @param encoding the encoding of the supplied query, for example "iso-8859-1"
* @since 9.1
*/
public void setEncoding(String encoding) {
this.encoding = encoding;
}
/**
* Get the encoding previously set for the supplied query.
*
* @return the encoding previously set using {@link #setEncoding(String)}, or null
* if no value has been set. Note that this is not necessarily the actual encoding of the query.
* @since 9.2
*/
public String getEncoding() {
return encoding;
}
/**
* Say whether the query is allowed to be updating. XQuery update syntax will be rejected
* during query compilation unless this flag is set. XQuery Update is supported only under Saxon-EE.
*
* @param updating true if the query is allowed to use the XQuery Update facility
* (requires Saxon-EE). If set to false, the query must not be an updating query. If set
* to true, it may be either an updating or a non-updating query.
* @throws UnsupportedOperationException if updating is requested and the Saxon Configuration does
* not support updating, either because it is not an EnterpriseConfiguration, or because no license
* key is available.
* @since 9.1
*/
public void setUpdatingEnabled(boolean updating) {
if (updating && !env.getConfiguration().isLicensedFeature(Configuration.LicenseFeature.ENTERPRISE_XQUERY)) {
throw new UnsupportedOperationException("XQuery Update is not supported in this Saxon Configuration");
}
env.setUpdatingEnabled(updating);
}
/**
* Ask whether the query is allowed to use XQuery Update syntax
*
* @return true if the query is allowed to use the XQuery Update facility. Note that this
* does not necessarily mean that the query is an updating query; but if the value is false,
* then it must definitely be non-updating.
* @since 9.1
*/
public boolean isUpdatingEnabled() {
return env.isUpdatingEnabled();
}
/**
* Say that the query must be compiled to be schema-aware, even if it contains no
* "import schema" declarations. Normally a query is treated as schema-aware
* only if it contains one or more "import schema" declarations. If it is not schema-aware,
* then all input documents must be untyped (or xs:anyType), and validation of temporary nodes is disallowed
* (though validation of the final result tree is permitted). Setting the argument to true
* means that schema-aware code will be compiled regardless.
*
* @param schemaAware If true, the stylesheet will be compiled with schema-awareness
* enabled even if it contains no xsl:import-schema declarations. If false, the stylesheet
* is treated as schema-aware only if it contains one or more xsl:import-schema declarations.
* Note that setting the value to false does not disable use of an import-schema declaration.
* @since 9.2
*/
public void setSchemaAware(boolean schemaAware) {
// We check this again more securely, but it's good to give the error as soon as possible
if (schemaAware && !processor.getUnderlyingConfiguration().isLicensedFeature(Configuration.LicenseFeature.ENTERPRISE_XQUERY)) {
throw new UnsupportedOperationException("Schema-awareness requires a Saxon-EE license");
}
env.setSchemaAware(schemaAware);
}
/**
* Ask whether schema-awareness has been requested either by means of a call on
* {@link #setSchemaAware}
*
* @return true if schema-awareness has been requested
* @since 9.2
*/
public boolean isSchemaAware() {
return env.isSchemaAware();
}
/**
* Say whether the query should be compiled and evaluated to use streaming.
* This affects subsequent calls on the compile() methods. This option requires
* Saxon-EE.
* @param option if true, the compiler will attempt to compile a query to be
* capable of executing in streaming mode. If the query cannot be streamed,
* a compile-time exception is reported. In streaming mode, the source
* document is supplied as a stream, and no tree is built in memory. The default
* is false.
*
* When setStreaming(true) is specified, this has the additional side-effect of setting the required
* context item type to "document-node()"
* @since 9.6
*/
public void setStreaming(boolean option) {
env.setStreaming(option);
// We check this again more securely, but it's good to give the error as soon as possible
if (option && !processor.getUnderlyingConfiguration().isLicensedFeature(Configuration.LicenseFeature.ENTERPRISE_XQUERY)) {
throw new UnsupportedOperationException("Streaming requires a Saxon-EE license");
}
if (option) {
setRequiredContextItemType(new ConstructedItemType(NodeKindTest.DOCUMENT, getProcessor()));
}
}
/**
* Ask whether the streaming option has been set, that is, whether
* subsequent calls on compile() will compile queries to be capable
* of executing in streaming mode.
* @return true if the streaming option has been set.
* @since 9.6
*/
public boolean isStreaming() {
return env.isStreaming();
}
/**
* Say whether an XQuery 1.0 or XQuery 3.0 processor is required.
*
* @param value Must be "1.0" or "3.0". The value "3.1" is currently accepted
* as a synonym for "3.0".
* @throws IllegalArgumentException if the version is not 1.0 or 3.0.
* @since 9.2. The handling of different XQuery version numbers has changed in
* successive Saxon releases.
*/
public void setLanguageVersion(String value) {
int version;
if ("1.0".equals(value)) {
version = 10;
} else if ("1.1".equals(value)) {
version = 30;
} else if ("3.0".equals(value)) {
version = 30;
} else if ("3.1".equals(value)) {
version = 31;
} else {
throw new IllegalArgumentException("XQuery version: " + value);
}
env.setLanguageVersion(version);
}
/**
* Ask whether an XQuery 1.0 or XQuery 3.0 processor is being used
*
* @return version: "1.0" or "3.0"
* @since 9.2
*/
public String getLanguageVersion() {
switch(env.getLanguageVersion()) {
case 10:
return "1.0";
case 30:
return "3.0";
case 31:
return "3.1";
default:
return "??" + env.getLanguageVersion();
}
}
/**
* Declare a namespace binding as part of the static context for queries compiled using this
* XQueryCompiler. This binding may be overridden by a binding that appears in the query prolog.
* The namespace binding will form part of the static context of the query, but it will not be copied
* into result trees unless the prefix is actually used in an element or attribute name.
*
* @param prefix The namespace prefix. If the value is a zero-length string, this method sets the default
* namespace for elements and types.
* @param uri The namespace URI. It is possible to specify a zero-length string to "undeclare" a namespace;
* in this case the prefix will not be available for use, except in the case where the prefix
* is also a zero length string, in which case the absence of a prefix implies that the name
* is in no namespace.
* @throws NullPointerException if either the prefix or uri is null.
* @throws IllegalArgumentException in the event of an invalid declaration of the XML namespace
*/
public void declareNamespace(String prefix, String uri) {
env.declareNamespace(prefix, uri);
}
/**
* Bind a collation URI to a collation
*
* @param uri the absolute collation URI
* @param collation a {@link java.text.Collator} object that implements the required collation
* @throws IllegalArgumentException if an attempt is made to rebind the standard URI
* for the Unicode codepoint collation
* @since 9.4
* @deprecated since 9.6. Collations are now held globally. If this method is called, the effect
* is to update the pool of collations held globally by the Processor.
*/
public void declareCollation(String uri, final java.text.Collator collation) {
getProcessor().declareCollation(uri, collation);
}
/**
* Declare the default collation
*
* @param uri the absolute URI of the default collation. This URI must have been bound to a collation
* using the method {@link #declareCollation(String, java.text.Collator)}, or it must be
* one that is recognized implicitly, such as a UCA collation
* @throws IllegalStateException if the collation URI has not been registered, unless it is the standard
* Unicode codepoint collation which is registered implicitly
* @since 9.4
*/
public void declareDefaultCollation(String uri) {
StringCollator c;
try {
c = getProcessor().getUnderlyingConfiguration().getCollation(uri);
} catch (XPathException e) {
c = null;
}
if (c == null) {
throw new IllegalStateException("Unknown collation " + uri);
}
env.declareDefaultCollation(uri);
}
/**
* Declare the static type of the context item. If this type is declared, and if a context item
* is supplied when the query is invoked, then the context item must conform to this type (no
* type conversion will take place to force it into this type).
*
* @param type the required type of the context item
*/
public void setRequiredContextItemType(ItemType type) {
requiredContextItemType = type;
env.setRequiredContextItemType(type.getUnderlyingItemType());
}
/**
* Get the required type of the context item. If no type has been explicitly declared for the context
* item, an instance of AnyItemType (representing the type item()) is returned.
*
* @return the required type of the context item
*/
public ItemType getRequiredContextItemType() {
return requiredContextItemType;
}
/**
* Compile a library module supplied as a string. The code generated by compiling the library is available
* for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
* "import module" declaration that specifies the module URI of the library module. No module location
* hint is required, and if one is present, it is ignored.
*
The base URI of the query should be supplied by calling {@link #setBaseURI(java.net.URI)}
* Separate compilation of library modules is supported only under Saxon-EE
*
* @param query the text of the query
* @throws SaxonApiException if the query compilation fails with a static error
* @since 9.2
*/
public void compileLibrary(String query) throws SaxonApiException {
try {
env.compileLibrary(query);
} catch (XPathException e) {
throw new SaxonApiException(e);
}
}
/**
* Compile a library module supplied as a file. The code generated by compiling the library is available
* for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
* "import module" declaration that specifies the module URI of the library module. No module location
* hint is required, and if one is present, it is ignored.
* The encoding of the input stream may be specified using {@link #setEncoding(String)};
* if this has not been set, the compiler determines the encoding from the version header of the
* query, and if that too is absent, it assumes UTF-8.
* Separate compilation of library modules is supported only under Saxon-EE
*
* @param query the file containing the query. The URI corresponding to this file will be used as the
* base URI of the query, overriding any URI supplied using {@link #setBaseURI(java.net.URI)} (but not
* overriding any base URI specified within the query prolog)
* @throws SaxonApiException if the query compilation fails with a static error
* @throws IOException if the file does not exist or cannot be read
* @since 9.2
*/
public void compileLibrary(File query) throws SaxonApiException, IOException {
FileInputStream stream = null;
try {
stream = new FileInputStream(query);
String savedBaseUri = env.getBaseURI();
env.setBaseURI(query.toURI().toString());
env.compileLibrary(stream, encoding);
env.setBaseURI(savedBaseUri);
} catch (XPathException e) {
throw new SaxonApiException(e);
} finally {
if (stream != null) {
stream.close();
}
}
}
/**
* Compile a library module supplied as a Reader. The code generated by compiling the library is available
* for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
* "import module" declaration that specifies the module URI of the library module. No module location
* hint is required, and if one is present, it is ignored.
* The base URI of the query should be supplied by calling {@link #setBaseURI(java.net.URI)}
* Separate compilation of library modules is supported only under Saxon-EE
*
* @param query the text of the query
* @throws SaxonApiException if the query compilation fails with a static error
* @since 9.2
*/
public void compileLibrary(Reader query) throws SaxonApiException {
try {
env.compileLibrary(query);
} catch (XPathException e) {
throw new SaxonApiException(e);
} catch (IOException e) {
throw new SaxonApiException(e);
}
}
/**
* Compile a library module supplied as an InputStream. The code generated by compiling the library is available
* for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
* "import module" declaration that specifies the module URI of the library module. No module location
* hint is required, and if one is present, it is ignored.
* The encoding of the input stream may be specified using {@link #setEncoding(String)};
* if this has not been set, the compiler determines the encoding from the version header of the
* query, and if that too is absent, it assumes UTF-8.
* The base URI of the query should be supplied by calling {@link #setBaseURI(java.net.URI)}
* Separate compilation of library modules is supported only under Saxon-EE
*
* @param query the text of the query
* @throws SaxonApiException if the query compilation fails with a static error
* @since 9.2
*/
public void compileLibrary(InputStream query) throws SaxonApiException {
try {
env.compileLibrary(query, encoding);
} catch (XPathException e) {
throw new SaxonApiException(e);
} catch (IOException e) {
throw new SaxonApiException(e);
}
}
/**
* Compile a query supplied as a string.
*
* The base URI of the query should be supplied by calling {@link #setBaseURI(java.net.URI)}
*
* If the query contains static errors, these will be notified to the registered {@link ErrorListener}.
* More than one static error may be reported. If any static errors have been reported, this method
* will exit with an exception, but the exception will only contain a summary message. The default
* {@link ErrorListener} writes details of each error to the System.err output stream.
*
* @param query the text of the query
* @return an XQueryExecutable representing the compiled query
* @throws SaxonApiException if the query compilation fails with a static error
* @since 9.0
*/
public XQueryExecutable compile(String query) throws SaxonApiException {
try {
return new XQueryExecutable(processor, env.compileQuery(query));
} catch (XPathException e) {
throw new SaxonApiException(e);
}
}
/**
* Compile a query supplied as a file
*
* @param query the file containing the query. The URI corresponding to this file will be used as the
* base URI of the query, overriding any URI supplied using {@link #setBaseURI(java.net.URI)} (but not
* overriding any base URI specified within the query prolog)
* @return an XQueryExecutable representing the compiled query
* @throws SaxonApiException if the query compilation fails with a static error
* @throws IOException if the file does not exist or cannot be read
* @since 9.1
*/
public XQueryExecutable compile(File query) throws SaxonApiException, IOException {
FileInputStream stream = null;
try {
stream = new FileInputStream(query);
String savedBaseUri = env.getBaseURI();
env.setBaseURI(query.toURI().toString());
XQueryExecutable exec =
new XQueryExecutable(processor, env.compileQuery(stream, encoding));
env.setBaseURI(savedBaseUri);
return exec;
} catch (XPathException e) {
throw new SaxonApiException(e);
} finally {
if (stream != null) {
stream.close();
}
}
}
/**
* Compile a query supplied as an InputStream
* The base URI of the query should be supplied by calling {@link #setBaseURI(java.net.URI)}
*
* @param query the input stream on which the query is supplied. This will be consumed by this method
* @return an XQueryExecutable representing the compiled query
* @throws SaxonApiException if the query compilation fails with a static error
* @throws IOException if the file does not exist or cannot be read
* @since 9.1
*/
public XQueryExecutable compile(InputStream query) throws SaxonApiException, IOException {
try {
return new XQueryExecutable(processor, env.compileQuery(query, encoding));
} catch (XPathException e) {
throw new SaxonApiException(e);
}
}
/**
* Compile a query supplied as a Reader
* The base URI of the query should be supplied by calling {@link #setBaseURI(java.net.URI)}
*
* @param query the input stream on which the query is supplied. This will be consumed by this method
* @return an XQueryExecutable representing the compiled query
* @throws SaxonApiException if the query compilation fails with a static error
* @throws IOException if the file does not exist or cannot be read
* @since 9.1
*/
public XQueryExecutable compile(Reader query) throws SaxonApiException, IOException {
try {
return new XQueryExecutable(processor, env.compileQuery(query));
} catch (XPathException e) {
throw new SaxonApiException(e);
}
}
/**
* Get the underlying {@link net.sf.saxon.query.StaticQueryContext} object that maintains the static context
* information on behalf of this XQueryCompiler. This method provides an escape hatch to internal Saxon
* implementation objects that offer a finer and lower-level degree of control than the s9api classes and
* methods. Some of these classes and methods may change from release to release.
*
* @return the underlying StaticQueryContext object
* @since 9.2
*/
public StaticQueryContext getUnderlyingStaticContext() {
return env;
}
/**
* List of errors. The caller should supply an empty list before calling Compile; the processor will then populate
* the list with error information obtained during the compilation. Each error will be included as an object of type StaticError.
* If no error list is supplied by the caller, error information will be written to the standard error stream.
* By supplying a custom List with a user-written add() method, it is possible to intercept error conditions as they occur.
*
*
* @param errorList
*/
public void setErrorList(List errorList){
env.setErrorListener(new ErrorGatherer(errorList));
}
}