net.sf.saxon.s9api

Class Processor

java.lang.Object

net.sf.saxon.s9api.Processor

All Implemented Interfaces:

Configuration.ApiProvider

public class Processor
extends java.lang.Object
implements Configuration.ApiProvider

The Processor class serves three purposes: it allows global Saxon configuration options to be set; it acts as a factory for generating XQuery, XPath, and XSLT compilers; and it owns certain shared resources such as the Saxon NamePool and compiled schemas. This is the first object that a Saxon application should create. Once established, a Processor may be used in multiple threads.

It is possible to run more than one Saxon Processor concurrently, but only when running completely independent workloads. Nothing can be shared between Processor instances. Within a query or transformation, all source documents and schemas must be built using the same Processor, which must also be used to compile the query or stylesheet.

Constructor Summary

Constructors

Constructor and Description
Processor(boolean licensedEdition) Create a Processor
Processor(Configuration config) Create a Processor based on an existing Configuration.
Processor(javax.xml.transform.Source source) Create a Processor configured according to the settings in a supplied configuration file.

Method Summary

Modifier and Type	Method and Description
void	declareCollation(java.lang.String uri, java.util.Comparator collation) Bind a collation URI to a collation
<T> T	getConfigurationProperty(Feature<T> feature) Get the value of a configuration property
java.lang.Object	getConfigurationProperty(java.lang.String name) Deprecated. since 9.9 - use getConfigurationProperty(Feature)
java.lang.String	getSaxonEdition() Get the short name of the Saxon product edition, for example "EE".
java.lang.String	getSaxonProductVersion() Get the user-visible Saxon product version, for example "9.0.0.1"
SchemaManager	getSchemaManager() Get the associated SchemaManager.
Configuration	getUnderlyingConfiguration() Get the underlying Configuration object that underpins this Processor.
java.lang.String	getXmlVersion() Get the version of XML used by this Processor.
boolean	isSchemaAware() Test whether this processor is schema-aware
DocumentBuilder	newDocumentBuilder() Create a DocumentBuilder.
Serializer	newSerializer() Create a Serializer
Serializer	newSerializer(java.io.File file) Create a Serializer initialized to write to a given File.
Serializer	newSerializer(java.io.OutputStream stream) Create a Serializer initialized to write to a given OutputStream.
Serializer	newSerializer(java.io.Writer writer) Create a Serializer initialized to write to a given Writer.
XPathCompiler	newXPathCompiler() Create an XPathCompiler.
XQueryCompiler	newXQueryCompiler() Create an XQueryCompiler.
XsltCompiler	newXsltCompiler() Create an XsltCompiler.
void	registerExtensionFunction(ExtensionFunction function) Register a simple external/extension function that is to be made available within any stylesheet, query, or XPath expression compiled under the control of this processor.
void	registerExtensionFunction(ExtensionFunctionDefinition function) Register an extension function that is to be made available within any stylesheet, query, or XPath expression compiled under the control of this processor.
<T> void	setConfigurationProperty(Feature<T> feature, T value) Set a configuration property
void	setConfigurationProperty(java.lang.String name, java.lang.Object value) Deprecated. since 9.9 - use setConfigurationProperty(Feature, Object)
void	setXmlVersion(java.lang.String version) Set the version of XML used by this Processor.
void	writeXdmValue(XdmValue value, Destination destination) Write an XdmValue to a given destination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Processor

public Processor(boolean licensedEdition)

Create a Processor

Parameters:

licensedEdition - indicates whether the Processor requires features of Saxon that need a license file (that is, features not available in Saxon HE (Home Edition). If true, the method will create a Configuration appropriate to the version of the software that is running: for example, if running Saxon-EE, it will create an EnterpriseConfiguration. The method does not at this stage check that a license is available, and in the absence of a license, it should run successfully provided no features that require licensing are actually used. If the argument is set to false, a plain Home Edition Configuration is created unconditionally.

Processor

public Processor(Configuration config)

Create a Processor based on an existing Configuration. This constructor is useful for transition, when new components of an application are to use s9api interfaces but existing components use lower-level interfaces.

Parameters:

config - the Configuration to be used by this processor

Since:

9.3

Processor

public Processor(javax.xml.transform.Source source)
          throws SaxonApiException

Create a Processor configured according to the settings in a supplied configuration file.

Parameters:

source - the Source of the configuration file

Throws:

SaxonApiException - if the configuration file cannot be read, or its contents are invalid

Since:

9.2

Method Detail

newDocumentBuilder

public DocumentBuilder newDocumentBuilder()

Create a DocumentBuilder. A DocumentBuilder is used to load source XML documents.

Returns:

a newly created DocumentBuilder

newXPathCompiler

public XPathCompiler newXPathCompiler()

Create an XPathCompiler. An XPathCompiler is used to compile XPath expressions.

Returns:

a newly created XPathCompiler

newXsltCompiler

public XsltCompiler newXsltCompiler()

Create an XsltCompiler. An XsltCompiler is used to compile XSLT stylesheets.

Returns:

a newly created XsltCompiler

Throws:

java.lang.UnsupportedOperationException - if this version of the Saxon product does not support XSLT processing

newXQueryCompiler

public XQueryCompiler newXQueryCompiler()

Create an XQueryCompiler. An XQueryCompiler is used to compile XQuery queries.

Returns:

a newly created XQueryCompiler

Throws:

java.lang.UnsupportedOperationException - if this version of the Saxon product does not support XQuery processing

newSerializer

public Serializer newSerializer()

Create a Serializer

Returns:

a new Serializer

Since:

9.3

newSerializer

public Serializer newSerializer(java.io.OutputStream stream)

Create a Serializer initialized to write to a given OutputStream.

Closing the output stream after use is the responsibility of the caller.

Parameters:

stream - The OutputStream to which the Serializer will write

Returns:

a new Serializer

Since:

9.3

newSerializer

public Serializer newSerializer(java.io.Writer writer)

Create a Serializer initialized to write to a given Writer.

Closing the writer after use is the responsibility of the caller.

Parameters:

writer - The Writer to which the Serializer will write

Returns:

a new Serializer

Since:

9.3

newSerializer

public Serializer newSerializer(java.io.File file)

Create a Serializer initialized to write to a given File.

Parameters:

file - The File to which the Serializer will write

Returns:

a new Serializer

Since:

9.3

registerExtensionFunction

public void registerExtensionFunction(ExtensionFunction function)

Register a simple external/extension function that is to be made available within any stylesheet, query, or XPath expression compiled under the control of this processor.

This interface provides only for simple extension functions that have no side-effects and no dependencies on the static or dynamic context.

Parameters:

function - the implementation of the extension function.

Since:

9.4

registerExtensionFunction

public void registerExtensionFunction(ExtensionFunctionDefinition function)

Register an extension function that is to be made available within any stylesheet, query, or XPath expression compiled under the control of this processor. This method registers an extension function implemented as an instance of ExtensionFunctionDefinition, using an arbitrary name and namespace.

This interface allows extension functions that have dependencies on the static or dynamic context. It also allows an extension function to declare that it has side-effects, in which case calls to the function will be optimized less aggressively than usual, although the semantics are still to some degree unpredictable.

Parameters:

function - the implementation of the extension function.

Since:

9.2

getSchemaManager

public SchemaManager getSchemaManager()

Get the associated SchemaManager. The SchemaManager provides capabilities to load and cache XML schema definitions. There is exactly one SchemaManager in a schema-aware Processor, and none in a Processor that is not schema-aware. The SchemaManager is created automatically by the system.

Returns:

the associated SchemaManager, or null if the Processor is not schema-aware.

isSchemaAware

public boolean isSchemaAware()

Test whether this processor is schema-aware

Returns:

true if this this processor is licensed for schema processing, false otherwise

getSaxonProductVersion

public java.lang.String getSaxonProductVersion()

Get the user-visible Saxon product version, for example "9.0.0.1"

Returns:

the Saxon product version, as a string

getSaxonEdition

public java.lang.String getSaxonEdition()

Get the short name of the Saxon product edition, for example "EE". This represents the kind of configuration that has been created, rather than the software that has been installed; for example it is possible to instantiate an "HE" configuration even when using the "PE" or "EE" software.

Returns:

the Saxon edition code: "EE", "PE", or "HE"

setXmlVersion

public void setXmlVersion(java.lang.String version)

Set the version of XML used by this Processor. If the value is set to "1.0", then output documents will be serialized as XML 1.0. This option also affects the characters permitted to appear in queries and stylesheets, and the characters that can appear in names (for example, in path expressions).

Note that source documents specifying xml version="1.0" or "1.1" are accepted regardless of this setting.

Parameters:

version - must be one of the strings "1.0" or "1.1"

Throws:

java.lang.IllegalArgumentException - if any string other than "1.0" or "1.1" is supplied

getXmlVersion

public java.lang.String getXmlVersion()

Get the version of XML used by this Processor. If the value is "1.0", then input documents must be XML 1.0 documents, and output documents will be serialized as XML 1.0. This option also affects the characters permitted to appear in queries and stylesheets, and the characters that can appear in names (for example, in path expressions).

Returns:

one of the strings "1.0" or "1.1"

setConfigurationProperty

public void setConfigurationProperty(java.lang.String name,
                                     java.lang.Object value)

Deprecated. since 9.9 - use setConfigurationProperty(Feature, Object)

Set a configuration property

Parameters:

name - the name of the option to be set. The names of the options available are listed as constants in class FeatureKeys.

value - the value of the option to be set.

Throws:

java.lang.IllegalArgumentException - if the property name is not recognized or if the supplied value is not a valid value for the named property.

getConfigurationProperty

public java.lang.Object getConfigurationProperty(java.lang.String name)

Deprecated. since 9.9 - use getConfigurationProperty(Feature)

Get the value of a configuration property

Parameters:

name - the name of the option required. The names of the properties available are listed as constants in class FeatureKeys.

Returns:

the value of the property, if one is set; or null if the property is unset and there is no default.

Throws:

java.lang.IllegalArgumentException - if the property name is not recognized

setConfigurationProperty

public <T> void setConfigurationProperty(Feature<T> feature,
                                         T value)

Set a configuration property

Parameters:

feature - the option to be set. The names of the options available are listed as constants in class Feature.

value - the value of the option to be set (which must be of the appropriate type for the particular feature.

Throws:

java.lang.IllegalArgumentException - if the supplied value is not a valid value for the selected feature.

Since:

9.9 introduced to give a faster and type-safe alternative to setConfigurationProperty(String, Object)

getConfigurationProperty

public <T> T getConfigurationProperty(Feature<T> feature)

Get the value of a configuration property

Parameters:

feature - the option required. The names of the properties available are listed as constants in class Feature.

Returns:

the value of the property, if one is set; or null if the property is unset and there is no default.

Since:

9.9 introduced to give a faster and type-safe alternative to getConfigurationProperty(String)

declareCollation

public void declareCollation(java.lang.String uri,
                             java.util.Comparator collation)

Bind a collation URI to a collation

Parameters:

uri - the absolute collation URI

collation - a Comparator object that implements the required collation

Throws:

java.lang.IllegalArgumentException - if an attempt is made to rebind the standard URI for the Unicode codepoint collation or the HTML5 case-blind collation

Since:

9.6. Changed in 9.8 to allow any Comparator to be supplied as a collation

getUnderlyingConfiguration

public Configuration getUnderlyingConfiguration()

Get the underlying Configuration object that underpins this Processor. 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.

Returns:

the underlying Configuration object

writeXdmValue

public void writeXdmValue(XdmValue value,
                          Destination destination)
                   throws SaxonApiException

Write an XdmValue to a given destination.

If the destination is a Serializer then the method processor.writeXdmValue(V, S) is equivalent to calling S.serializeXdmValue(V).

In other cases, the sequence represented by the XdmValue is "normalized" as defined in the serialization specification (this is equivalent to constructing a document node in XSLT or XQuery with this sequence as the content expression), and the resulting document is then copied to the destination. Note that the construction of a document tree will fail if the sequence contains items such as maps and arrays.

Parameters:

value - the value to be written

destination - the destination to which the value is to be written

Throws:

SaxonApiException - if any failure occurs, for example a serialization error