net.sf.saxon.s9api.SchemaManager Maven / Gradle / Ivy
Show all versions of saxon-he Show documentation
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 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.event.Receiver;
import net.sf.saxon.lib.FeatureKeys;
import net.sf.saxon.lib.SchemaURIResolver;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.SchemaException;
import javax.xml.transform.ErrorListener;
import javax.xml.transform.Source;
/**
* The SchemaManager is used to load schema documents, and to set options for the way in which they are loaded.
* At present all the resulting schema components are held in a single pool owned by the Processor object.
*/
public class SchemaManager {
private Configuration config;
/*@Nullable*/ private ErrorListener errorListener;
protected SchemaManager(Configuration config) {
this.config = config;
this.errorListener = null;
}
/**
* Set the version of XSD in use. The value must be "1.0" or "1.1". The default is currently "1.0",
* but this may change in a future release.
* @param version the version of the XSD specification/language: either "1.0" or "1.1".
*/
public void setXsdVersion(String version) {
if (version.equals("1.0") || version.equals("1.1")) {
config.setConfigurationProperty(FeatureKeys.XSD_VERSION, version);
} else {
throw new IllegalArgumentException("XsdVersion");
}
}
/**
* Get the version of XSD in use. The value will be "1.0" or "1.1"
* @return the version of XSD in use.
*/
public String getXsdVersion() {
return config.getXsdVersion() == Configuration.XSD10 ? "1.0" : "1.1";
}
/**
* Set the ErrorListener to be used while loading and validating schema documents
* @param listener The error listener to be used. This is notified of all errors detected during the
* compilation. May be set to null to revert to the default ErrorListener.
*/
public void setErrorListener(/*@Nullable*/ ErrorListener listener) {
this.errorListener = listener;
}
/**
* Get the ErrorListener being used while loading and validating schema documents
* @return listener The error listener in use. This is notified of all errors detected during the
* compilation. Returns null if no user-supplied ErrorListener has been set.
*/
/*@Nullable*/
public ErrorListener getErrorListener() {
return errorListener;
}
/**
* Set the SchemaURIResolver to be used during schema loading. This SchemaURIResolver, despite its name,
* is not used for resolving relative URIs against a base URI; it is used for dereferencing
* an absolute URI (after resolution) to return a {@link javax.xml.transform.Source} representing the
* location where a schema document can be found.
*
* This SchemaURIResolver is used to dereference the URIs appearing in xs:import,
* xs:include, and xs:redefine declarations.
*
* @param resolver the SchemaURIResolver to be used during schema loading.
*/
public void setSchemaURIResolver(SchemaURIResolver resolver) {
config.setSchemaURIResolver(resolver);
}
/**
* Get the SchemaURIResolver to be used during schema loading.
*
* @return the URIResolver used during stylesheet compilation. Returns null if no user-supplied
* URIResolver has been set.
*/
public SchemaURIResolver getSchemaURIResolver() {
return config.getSchemaURIResolver();
}
/**
* Load a schema document from a given Source. The schema components derived from this schema
* document are added to the cache of schema components maintained by this SchemaManager
* @param source the document containing the schema. The getSystemId() method applied to this Source
* must return a base URI suitable for resolving xs:include and xs:import
* directives.
* @throws SaxonApiException if the schema document is not valid, or if its contents are inconsistent
* with the schema components already held by this SchemaManager.
*/
public void load(Source source) throws SaxonApiException {
try {
config.addSchemaSource(source, errorListener);
} catch (SchemaException e) {
throw new SaxonApiException(e);
}
}
/**
* Import a precompiled Schema Component Model from a given Source. The schema components derived from this schema
* document are added to the cache of schema components maintained by this SchemaManager
* @param source the XML file containing the schema component model, as generated by a previous call on
* {@link #exportComponents}
* @throws SaxonApiException if a failure occurs loading the schema from the supplied source
*/
public void importComponents(Source source) throws SaxonApiException {
try {
config.importComponents(source);
} catch (XPathException err) {
throw new SaxonApiException(err);
}
}
/**
* Export a precompiled Schema Component Model containing all the components (except built-in components)
* that have been loaded into this Processor.
* @param destination the destination to recieve the precompiled Schema Component Model in the form of an
* XML document
* @throws SaxonApiException if a failure occurs writing the schema components to the supplied destination
*/
public void exportComponents(Destination destination) throws SaxonApiException {
try {
Receiver out = destination.getReceiver(config);
config.exportComponents(out);
destination.close();
} catch (XPathException e) {
throw new SaxonApiException(e);
}
}
/**
* Create a SchemaValidator which can be used to validate instance documents against the schema held by this
* SchemaManager
* @return a new SchemaValidator
*/
public SchemaValidator newSchemaValidator() {
return new SchemaValidator(config);
}
}