com.saxonica.config

Class ProfessionalConfiguration

java.lang.Object

net.sf.saxon.Configuration

com.saxonica.config.ProfessionalConfiguration

All Implemented Interfaces:

SourceResolver, NotationSet

Direct Known Subclasses:

EnterpriseConfiguration

public class ProfessionalConfiguration
extends Configuration

This class holds details of user-selected configuration options for a set of transformations and/or queries. When running XSLT, the preferred way of setting configuration options is via the JAXP TransformerFactory interface, but the Configuration object provides a finer level of control. As yet there is no standard API for XQuery, so the only way of setting Configuration information is to use the methods on this class directly.

As well as holding configuration settings, this class acts as a factory for classes providing service in particular areas: error handling, URI resolution, and the like. Some of these services are chosen on the basis of the current platform (Java or .NET), some vary depending whether the environment is schema-aware or not.

The Configuration provides access to a NamePool which is used to manage all the names used in stylesheets, queries, schemas, and source and documents: the NamePool allocates integer codes to these names allowing efficient storage and comparison. Normally there will be a one-to-one relationship between a NamePool and a Configuration. It is possible, however, for several Configuration objects to share the same NamePool. Until Saxon 8.9, by default all Configuration objects shared a single NamePool unless configured otherwise; this changed in 8.9 so that the default is to allocate a new NamePool for each Configuration.

The Configuration establishes the scope within which node identity is managed. Every document belongs to a Configuration, and every node has a distinct identity within that Configuration. In consequence, it is not possible for any query or transformation to manipulate multiple documents unless they all belong to the same Configuration.

Saxon-EE has a subclass of the Configuration class which provides the additional services needed for schema-aware processing. The EnterpriseConfiguration also holds a cache of loaded schema components used for compiling schema-aware transformations and queries, and for validating instance documents.

Since Saxon 8.4, the JavaDoc documentation for Saxon attempts to identify interfaces that are considered stable, and will only be changed in a backwards-incompatible way if there is an overriding reason to do so. These interfaces and methods are labelled with the JavaDoc "since" tag. The value 8.n indicates a method in this category that was introduced in Saxon version 8.n: or in the case of 8.4, that was present in Saxon 8.4 and possibly in earlier releases. (In some cases, these methods have been unchanged for a long time.) Methods without a "since" tag, although public, are provided for internal use or for use by advanced users, and are subject to change from one release to the next. The presence of a "since" tag on a class or interface indicates that there are one or more methods in the class that are considered stable; it does not mean that all methods are stable.

Since:

9.2

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.Configuration

Configuration.LicenseFeature

Field Summary

Fields inherited from class net.sf.saxon.Configuration

collectionResolver, configurationClass, defaultStaticQueryContext, DO_NOT_RECOVER, JAVA_APPLICATION, optimizationLevel, optimizer, RECOVER_SILENTLY, RECOVER_WITH_WARNINGS, softwareEdition, typeHierarchy, vendorFunctionLibrary, XML_SCHEMA, XML10, XML11, XPATH, XQUERY, XSD10, XSD11, xsdVersion, XSLT

Constructor Summary

Constructors

Constructor and Description
ProfessionalConfiguration() Create a Saxon Professional Edition configuration object with default settings for all options.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtensionBinders(FunctionLibraryList list) Add the registered extension binders to a function library.
void	checkLicensedFeature(int feature, String name) Check whether a particular feature is licensed, with a fatal error if it is not
void	declareBuiltInExtensionElementNamespaces() Declare the built-in XSLT extension element namespaces
void	declareBuiltInExtensionFunctions() Declare built-in extension functions
void	displayLicenseMessage() Display a message about the license status.
Object	getConfigurationProperty(String name) Get a property of the configuration
String	getEditionCode() Get the edition code identifying this configuration: "HE", "PE" or "EE"
FunctionLibrary	getExtensionBinder(String scheme) Get the FunctionLibrary used to bind calls on extension functions on the specified platform.
ExtensionElementFactory	getExtensionElementFactory(String namespace) Get the XSLT extension element factory for a given namespace
protected String	getFeature(String name) This method is called to read a feature of the license.
LocationMap	getGlobalLocationMap() Get the global location map.
VendorFunctionLibrary	getVendorFunctionLibrary() Get the FunctionLibrary used to bind calls on Saxon-defined extension functions
void	importLicenseDetails(ProfessionalConfiguration other) Share licensing data stored in one configuration with another configuration.
boolean	isLicensedFeature(int feature) Determine if a particular feature is licensed.
boolean	isLicenseFound() Ask if the configuration is known to be licensed
boolean	isLicenseNotFound() Ask if the configuration is known to be unlicensed
protected void	loadLicense() Attempt to load the license file.
static Configuration	makeProfessionalConfiguration(ClassLoader classLoader, String className) Static method to instantiate a professional configuration.
StyleNodeFactory	makeStyleNodeFactory() Factory method to make a StyleNodeFactory, used for constructing elements in a stylesheet document
UnconstructedDocument	makeUnconstructedDocument(DocumentInstr instr, XPathContext context) Make an "unconstructed" (that is, lazily-constructed) document node
UnconstructedElement	makeUnconstructedElement(ElementCreator instr, XPathContext context) Make an "unconstructed" (that is, lazily-constructed) element node
XPathParser	newExpressionParser(String language, boolean updating, DecimalValue languageVersion) Make an expression Parser for a specified version of XPath or XQuery
UserFunction	newUserFunction(boolean memoFunction) Make a UserFunction object.
protected Configuration	readConfigurationFile(Source source) Read the configuration file an construct a new Configuration (the real one)
protected void	reportIfMissingLicenseFeature(int feature, String name)
Source	resolveSource(Source source, Configuration config) Resolve a Source.
Expression	rewriteCopyOnEmpty(XSLCopy copy, Copy inst, Expression select, Expression onEmpty) A rewrite done in PE and EE but not HE:
void	setConfigurationProperty(String name, Object value) Set a property of the configuration.
void	setExtensionBinder(String scheme, FunctionLibrary binder) Set the FunctionLibrary used to bind calls on extension functions.
void	setExtensionElementNamespace(String namespace, String className) Set a namespace used to refer to a library of XSLT extension elements
protected void	setLicensedFeatures()
void	supplyLicenseKey(BufferedReader reader) This method allows the contents of a license key to be supplied programmatically.
protected boolean	testFeature(int feature) Test whether a particular feature is available, given that a valid license has been successfully loaded.

Methods inherited from class net.sf.saxon.Configuration

addSchemaForBuiltInNamespace, addSchemaSource, addSchemaSource, buildDocument, buildDocument, checkTypeDerivationIsOK, clearSchemaCache, exportComponents, finalize, getAnnotationStripper, getAttributeDeclaration, getBooleanProperty, getCharacterSetFactory, getClass, getCollation, getCollation, getCollation, getCollationURIResolver, getCollectionURIResolver, getConfiguration, getConversionContext, getConversionRules, getDebugger, getDeclaredSchemaParameters, getDefaultCollationName, getDefaultCollection, getDefaultCountry, getDefaultLanguage, getDefaultSerializationProperties, getDefaultStaticQueryContext, getDefaultXsltCompilerInfo, getDocumentNumberAllocator, getDocumentValidator, getDynamicLoader, getElementDeclaration, getElementDeclaration, getElementValidator, getErrorListener, getExtensionsOfType, getExternalObjectModel, getExternalObjectModel, getExternalObjectModels, getGlobalDocumentPool, getImportedNamespaces, getInstance, getIntegratedFunctionLibrary, getLocalizerFactory, getLogger, getMessageEmitterClass, getModuleURIResolver, getNamePool, getOutputURIResolver, getParseOptions, getPlatform, getProcessor, getProductTitle, getRecoveryPolicy, getSchemaAsFunctionItem, getSchemaComponentAsFunctionItem, getSchemaType, getSchemaValidationMode, getSerializerFactory, getSiblingPosition, getSoftwareEdition, getSourceParser, getSourceParserClass, getSourceResolver, getStandardErrorOutput, getStandardModuleURIResolver, getStreamability, getStripsWhiteSpace, getStyleParser, getStyleParserClass, getSystemURIResolver, getTraceListener, getTraceListenerClass, getTreeModel, getTypeHierarchy, getURIResolver, getValidCharacterChecker, getXMLVersion, getXsdVersion, importComponents, init, instantiateClassName, internalSetBooleanProperty, isCompatible, isCompileWithTracing, isDeclaredNotation, isExpandAttributeDefaults, isGenerateByteCode, isLineNumbering, isSchemaAvailable, isStripsAllWhiteSpace, isTiming, isValidation, isValidationWarnings, isVersionWarning, isXIncludeAware, loadSchema, locateResource, makeClosure, makeConfigurationClass, makeDocumentProjector, makeDocumentProjector, makeEmitter, makeLicensedConfiguration, makeNumberer, makeParser, makePipelineConfiguration, makePlatform, makeSequenceExtent, makeSlotManager, makeStreamingTransformer, makeTraceListener, makeTraceListener, makeURIResolver, makeXQueryExpression, needEnterpriseEdition, newConfiguration, newPendingUpdateList, newStaticQueryContext, obtainOptimizer, processResultDocument, readConfiguration, readInlineSchema, readMultipleSchemas, readSchema, registerCollation, registerExtensionFunction, registerExternalObjectModel, reportFatalError, requireBoolean, requireString, reuseSourceParser, reuseStyleParser, sealNamespace, setBooleanProperty, setCollationURIResolver, setCollectionURIResolver, setCompileWithTracing, setConversionRules, setDebugger, setDefaultCollection, setDefaultCountry, setDefaultLanguage, setDefaultSerializationProperties, setDocumentNumberAllocator, setDynamicLoader, setErrorListener, setExpandAttributeDefaults, setLineNumbering, setLocalizerFactory, setLogger, setMessageEmitterClass, setModuleURIResolver, setModuleURIResolver, setNamePool, setOutputURIResolver, setParameterizedURIResolver, setProcessor, setRecoveryPolicy, setSchemaValidationMode, setSerializerFactory, setSourceParserClass, setSourceResolver, setStandardErrorOutput, setStaticQueryContextFactory, setStripsAllWhiteSpace, setStripsWhiteSpace, setStyleParserClass, setTiming, setTraceListener, setTraceListenerClass, setTreeModel, setURIResolver, setValidation, setValidationWarnings, setVersionWarning, setXIncludeAware, setXMLVersion, unravel, validateAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfessionalConfiguration

public ProfessionalConfiguration()

Create a Saxon Professional Edition configuration object with default settings for all options.

Since:

9.2

Method Detail

readConfigurationFile

protected Configuration readConfigurationFile(Source source)
                                       throws XPathException

Read the configuration file an construct a new Configuration (the real one)

Overrides:

readConfigurationFile in class Configuration

Parameters:

source - the source of the configuration file

Returns:

the Configuration that will be used for real work

Throws:

XPathException

makeProfessionalConfiguration

public static Configuration makeProfessionalConfiguration(ClassLoader classLoader,
                                          String className)
                                                   throws RuntimeException

Static method to instantiate a professional configuration.

On the .NET platform, this method should not be called unless it is known that the assembly saxon9sa.dll has already been loaded. This can be achieved by an appropriate call on Assembly.Load(): for an example, see the C# Configuration.cs class in the Saxon.Api namespace.

This method fails if Saxon-EE cannot be loaded, but it does not fail if there is no license available. In that case it returns a schema-aware configuration object, but any attempt to use schema-aware processing will fail.

Parameters:

classLoader - - the class loader to be used. If null, the context class loader for the current thread is used.

className - - the name of the schema aware configuration class. Defaults to "com.saxonica.config.ProfessionalConfiguration" if null is supplied. This allows an assembly qualified name to be supplied under .NET. The class, once instantiated, must be an instance of Configuration, but despite the name of this method there is nothing that requires it to be schema-aware.

Returns:

the new ProfessionalConfiguration

Throws:

RuntimeException - if the Saxon-PE product cannot be loaded

Since:

9.2 (renamed from makeSchemaAwareConfiguration)

getEditionCode

public String getEditionCode()

Get the edition code identifying this configuration: "HE", "PE" or "EE"

Overrides:

getEditionCode in class Configuration

Returns:

the code identifying the Saxon edition associated with this configuration

setConfigurationProperty

public void setConfigurationProperty(String name,
                            Object value)

Set a property of the configuration. This method underpins the setAttribute() method of the TransformerFactory implementation, and is provided to enable setting of Configuration properties using URIs without instantiating a TransformerFactory: specifically, this may be useful when running XQuery, and it is also used by the Validator API

Overrides:

setConfigurationProperty in class Configuration

Parameters:

name - the URI identifying the property to be set. See the class FeatureKeys for constants representing the property names that can be set.

value - the value of the property

Throws:

IllegalArgumentException - if the property name is not recognized or if the value is not a valid value for the named property

getConfigurationProperty

public Object getConfigurationProperty(String name)

Get a property of the configuration

Overrides:

getConfigurationProperty in class Configuration

Parameters:

name - the name of the required property. See the class FeatureKeys for constants representing the property names that can be requested.

Returns:

the value of the property

Throws:

IllegalArgumentException - thrown if the property is not one that Saxon recognizes.

supplyLicenseKey

public void supplyLicenseKey(BufferedReader reader)

This method allows the contents of a license key to be supplied programmatically. This must be a license file as issued to authorized OEM distributors of Saxon-EE.

Parameters:

reader - A reader that will be used to read the contents of the license file (for example, a StringReader)

Throws:

IllegalArgumentException - if the key supplied is not a valid OEM license key

importLicenseDetails

public void importLicenseDetails(ProfessionalConfiguration other)

Share licensing data stored in one configuration with another configuration. Where many configurations are created, this reduces the cost of repeatedly reading and analysing license key information.

Parameters:

other - another Configuration, whose license information will be imported into this Configuration.

getFeature

protected String getFeature(String name)

This method is called to read a feature of the license. This method should be called only if the caller requires access to the feature.

Parameters:

name - the name of the requested feature

Returns:

the feature value of the license.

Throws:

RuntimeException - if no license is available

checkLicensedFeature

public void checkLicensedFeature(int feature,
                        String name)
                          throws LicenseException

Check whether a particular feature is licensed, with a fatal error if it is not

Overrides:

checkLicensedFeature in class Configuration

Parameters:

feature - the feature in question, identified by a constant in class Configuration.LicenseFeature

name - the name of the feature for use in diagnostics

Throws:

LicenseException - if the feature is not licensed

reportIfMissingLicenseFeature

protected void reportIfMissingLicenseFeature(int feature,
                                 String name)

isLicensedFeature

public final boolean isLicensedFeature(int feature)
                                throws LicenseException

Determine if a particular feature is licensed. If this requires reading the license file to find out, and the license file cannot be read, then a message is output to the standard error output if and only if the configuration option FeatureKeys.TIMING is set (corresponding to -t on the command line).

Overrides:

isLicensedFeature in class Configuration

Parameters:

feature - the feature in question, identified by a constant in class Configuration.LicenseFeature

Returns:

true if the feature is available for use.

Throws:

LicenseException

loadLicense

protected final void loadLicense()
                          throws LicenseException

Attempt to load the license file. If it is an evaluation license, set the appropriate restrictions.

Throws:

LicenseException - if the license cannot be loaded.

setLicensedFeatures

protected void setLicensedFeatures()

testFeature

protected boolean testFeature(int feature)

Test whether a particular feature is available, given that a valid license has been successfully loaded.

Parameters:

feature - a constant in class LicenseFeature

Returns:

true if the feature is available, otherwise false

isLicenseNotFound

public boolean isLicenseNotFound()

Ask if the configuration is known to be unlicensed

Returns:

true if a previous attempt to load a license was made, and no license was found

isLicenseFound

public boolean isLicenseFound()

Ask if the configuration is known to be licensed

Returns:

true if a previous attempt to load a license was made, and the license was found (and found to be valid)

displayLicenseMessage

public void displayLicenseMessage()

Display a message about the license status. Used from command-line tools only.

Overrides:

displayLicenseMessage in class Configuration

makeStyleNodeFactory

public StyleNodeFactory makeStyleNodeFactory()

Factory method to make a StyleNodeFactory, used for constructing elements in a stylesheet document

Overrides:

makeStyleNodeFactory in class Configuration

Returns:

the StyleNodeFactory used in this Configuration

getGlobalLocationMap

public LocationMap getGlobalLocationMap()

Get the global location map. A location map is used to map location ids (for example, as stored in the expression tree) to module URIs and line numbers. Generally, each stylesheet or query has its own location map. But where XSLT 3.0 packages are used, a global location map is used, so that location Ids from different packages can co-exist at run-time. This is an interim solution to the problem of maintaining location information for separately-compiled packages; it imposes limits on how many modules can exist, and it will need changing when we allow compiled packages to be saved to filestore and reloaded in a different configuration.

Overrides:

getGlobalLocationMap in class Configuration

Returns:

the global location map

newExpressionParser

public XPathParser newExpressionParser(String language,
                              boolean updating,
                              DecimalValue languageVersion)

Make an expression Parser for a specified version of XPath or XQuery

Overrides:

newExpressionParser in class Configuration

Parameters:

language - set to "XP" (XPath) or "XQ" (XQuery) or "PATTERN" (XSLT Patterns)

updating - indicates whether or not XQuery update syntax may be used. Note that XQuery Update is supported only in Saxon-EE

languageVersion - the required version (e.g "1.0", "3.0").

Returns:

the QueryParser

Throws:

UnsupportedOperationException - if a parser that supports update syntax is requested on Saxon-B

setExtensionBinder

public void setExtensionBinder(String scheme,
                      FunctionLibrary binder)

Set the FunctionLibrary used to bind calls on extension functions. This allows the rules for identifying extension functions to be customized (in principle, it would allow support for extension functions in other languages to be provided).

When an application supplies its own FunctionLibrary for binding extension functions, this replaces the default binding mechanism for Java extension functions, namely JavaExtensionLibrary. It thus disables the function libraries for built-in Saxon extensions and for EXSLT extensions. It is possible to create a function library that adds to the existing mechanisms, rather than replacing them, by supplying as the FunctionLibrary a FunctionLibraryList that itself contains two FunctionLibrary objects: a JavaExtensionLibrary, and a user-written FunctionLibrary.

Parameters:

scheme - The scheme served by the extension binder. Typically this will be one of "java" or "clitype". However, user-defined extension binders for other schemes can be registered. Note that the scheme name does not have to be related to the actual namespace used in function calls; all registered function libraries have the opportunity to bind any extension function call. The significance is purely local to this class: setting an extension binder for a given scheme replaces the existing extension binder for that scheme. The two schemes used by Saxon itself are "java" for dynamically-bound Java extension functions, and "clitype" for dynamically-bound .NET extension functions

binder - The FunctionLibrary object used to locate implementations of extension functions, based on their name and arity

getExtensionBinder

public FunctionLibrary getExtensionBinder(String scheme)

Get the FunctionLibrary used to bind calls on extension functions on the specified platform.

This mechanism is for advanced users only, and the details are subject to change.

Parameters:

scheme - The URI scheme served by the extension binder. This will typically be one of "java" or "clitype". On the Java platform, the only scheme currently supported is "java"; on the .NET platform, the "java" and "clitype" schemes coexist.

Returns:

the registered FunctionLibrary for extension functions if one has been registered; or null otherwise

addExtensionBinders

public void addExtensionBinders(FunctionLibraryList list)

Add the registered extension binders to a function library. This method is intended primarily for internal use

Overrides:

addExtensionBinders in class Configuration

Parameters:

list - the function library list

getVendorFunctionLibrary

public VendorFunctionLibrary getVendorFunctionLibrary()

Get the FunctionLibrary used to bind calls on Saxon-defined extension functions

Overrides:

getVendorFunctionLibrary in class Configuration

Returns:

the FunctionLibrary used for extension functions in the Saxon library.

newUserFunction

public UserFunction newUserFunction(boolean memoFunction)

Make a UserFunction object. This method is for internal use.

Overrides:

newUserFunction in class Configuration

Parameters:

memoFunction - true if the function is to be a memo function, This option is ignored in Saxon-HE.

Returns:

a new UserFunction object

declareBuiltInExtensionFunctions

public void declareBuiltInExtensionFunctions()

Declare built-in extension functions

declareBuiltInExtensionElementNamespaces

public void declareBuiltInExtensionElementNamespaces()

Declare the built-in XSLT extension element namespaces

setExtensionElementNamespace

public void setExtensionElementNamespace(String namespace,
                                String className)
                                  throws XPathException

Set a namespace used to refer to a library of XSLT extension elements

Parameters:

namespace - the namespace used for the extension elements

className - the classname of the implementation of the ExtensionElementFactory that instantiates extension elements in this namespace

Throws:

XPathException - if (for example) the supplied class does not implement the ExtensionElementFactory interface

Since:

9.2

getExtensionElementFactory

public ExtensionElementFactory getExtensionElementFactory(String namespace)

Get the XSLT extension element factory for a given namespace

Parameters:

namespace - the namespace URI of the extension element

Returns:

the corresponding extension element factory if one has been registered, or null otherwise

Since:

9.2

resolveSource

public Source resolveSource(Source source,
                   Configuration config)
                     throws XPathException

Resolve a Source.

Specified by:

resolveSource in interface SourceResolver

Overrides:

resolveSource in class Configuration

Parameters:

source - A source object, typically the source supplied as the first argument to Transformer.transform(javax.xml.transform.Source, javax.xml.transform.Result) or similar methods.

config - The Configuration. This provides the SourceResolver with access to configuration information; it also allows the SourceResolver to invoke the resolveSource() method on the Configuration object as a fallback implementation.

Returns:

a source object that Saxon knows how to process. This must be an instance of one of the classes StreamSource, SAXSource, DOMSource, AugmentedSource, NodeInfo, or PullSource. Return null if the Source object is not recognized

Throws:

XPathException - if the Source object is recognized but cannot be processed

makeUnconstructedElement

public UnconstructedElement makeUnconstructedElement(ElementCreator instr,
                                            XPathContext context)
                                              throws XPathException

Make an "unconstructed" (that is, lazily-constructed) element node

Overrides:

makeUnconstructedElement in class Configuration

Parameters:

instr - the instruction that creates the element

context - the dynamic evaluation context

Returns:

the lazily constructed element node

Throws:

XPathException - if an error occurs, for example if called in Saxon-HE

makeUnconstructedDocument

public UnconstructedDocument makeUnconstructedDocument(DocumentInstr instr,
                                              XPathContext context)
                                                throws XPathException

Make an "unconstructed" (that is, lazily-constructed) document node

Overrides:

makeUnconstructedDocument in class Configuration

Parameters:

instr - the instruction that creates the document node

context - the dynamic evaluation context

Returns:

the lazily constructed document node

Throws:

XPathException - in Saxon-HE

rewriteCopyOnEmpty

public Expression rewriteCopyOnEmpty(XSLCopy copy,
                            Copy inst,
                            Expression select,
                            Expression onEmpty)

A rewrite done in PE and EE but not HE:

Overrides:

rewriteCopyOnEmpty in class Configuration

Parameters:

copy -

inst -

select -

onEmpty -

Returns: