net.sf.saxon.event.PipelineConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of saxon-he Show documentation
Show all versions of saxon-he Show documentation
An OSGi bundle for Saxon-HE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// 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.event;
import net.sf.saxon.Configuration;
import net.sf.saxon.Controller;
import net.sf.saxon.expr.parser.ExpressionLocation;
import net.sf.saxon.lib.ParseOptions;
import net.sf.saxon.lib.SchemaURIResolver;
import net.sf.saxon.om.Item;
import net.sf.saxon.om.NodeInfo;
import javax.xml.transform.ErrorListener;
import javax.xml.transform.SourceLocator;
import javax.xml.transform.URIResolver;
import java.util.HashMap;
import java.util.Map;
import java.util.Stack;
/**
* A PipelineConfiguration sets options that apply to all the operations in a pipeline.
* Unlike the global Configuration, these options are always local to a process.
*/
public class PipelineConfiguration {
/*@NotNull*/ private Configuration config;
private LocationProvider locationProvider;
private URIResolver uriResolver;
private SchemaURIResolver schemaURIResolver;
private Controller controller;
private Stack- currentApplyStack;
private ParseOptions parseOptions;
private boolean isSerializing;
private int hostLanguage = Configuration.XSLT;
private Map
components;
/**
* Create a PipelineConfiguration. Note: the normal way to create
* a PipelineConfiguration is via the factory methods in the Controller and
* Configuration classes
*
* @param config the Saxon configuration
* @see Configuration#makePipelineConfiguration
* @see Controller#makePipelineConfiguration
*/
public PipelineConfiguration(/*@NotNull*/ Configuration config) {
this.config = config;
parseOptions = new ParseOptions();
}
/**
* Create a PipelineConfiguration as a copy of an existing
* PipelineConfiguration
*
* @param p the existing PipelineConfiguration
*/
public PipelineConfiguration(PipelineConfiguration p) {
config = p.config;
locationProvider = p.locationProvider;
uriResolver = p.uriResolver;
schemaURIResolver = p.schemaURIResolver;
controller = p.controller;
isSerializing = p.isSerializing;
parseOptions = new ParseOptions(p.parseOptions);
hostLanguage = p.hostLanguage;
if (p.components != null) {
components = new HashMap(p.components);
}
}
/**
* Get the Saxon Configuration object
*
* @return the Saxon Configuration
*/
/*@NotNull*/
public Configuration getConfiguration() {
return config;
}
/**
* Set the Saxon Configuration object
*
* @param config the Saxon Configuration
*/
public void setConfiguration(/*@NotNull*/ Configuration config) {
this.config = config;
}
/**
* Get the LocationProvider for interpreting location ids passed down this pipeline
*
* @return the appropriate LocationProvider
*/
public LocationProvider getLocationProvider() {
if (locationProvider == null) {
locationProvider = DummyLocationProvider.THE_INSTANCE;
}
return locationProvider;
}
/**
* Set the LocationProvider for interpreting location ids passed down this pipeline
*
* @param locationProvider the LocationProvider
*/
public void setLocationProvider(LocationProvider locationProvider) {
this.locationProvider = locationProvider;
}
/**
* Get a SourceLocator for a given locationId, using this location provider
*
* @param locationId an integer identifier for a source location
* @return an object holding location information
*/
public SourceLocator getSourceLocation(long locationId) {
return new ExpressionLocation(locationProvider, locationId);
}
/**
* Get the ErrorListener set as a property of this pipeline
*
* @return the ErrorListener; null if none has been set.
*/
public ErrorListener getLocalErrorListener() {
return parseOptions.getErrorListener();
}
/**
* Get an ErrorListener for reporting errors in processing this pipeline; this
* will be the ErrorListener set locally in the PipelineConfiguration if there is one,
* or the ErrorListener from the Configuration otherwise.
*
* @return the ErrorListener to be used; never null
*/
public ErrorListener getErrorListener() {
ErrorListener listener = parseOptions.getErrorListener();
if (listener == null) {
listener = config.getErrorListener();
}
return listener;
}
/**
* Set the ErrorListener used for reporting errors in processing this pipeline
*
* @param errorListener the ErrorListener
*/
public void setErrorListener(ErrorListener errorListener) {
parseOptions.setErrorListener(errorListener);
}
/**
* Get the URIResolver used for processing URIs encountered on this pipeline
*
* @return the URIResolver
*/
public URIResolver getURIResolver() {
return uriResolver;
}
/**
* Set the URIResolver used for processing URIs encountered on this pipeline
*
* @param uriResolver the URIResolver
*/
public void setURIResolver(URIResolver uriResolver) {
this.uriResolver = uriResolver;
}
/**
* Get the user-defined SchemaURIResolver for resolving URIs used in "import schema"
* declarations; returns null if none has been explicitly set.
*
* @return the SchemaURIResolver
*/
public SchemaURIResolver getSchemaURIResolver() {
return schemaURIResolver;
}
/**
* Set the document parsing and building options to be used on this pipeline
*
* @param options the options to be used
*/
public void setParseOptions(ParseOptions options) {
parseOptions = options;
}
/**
* Get the document parsing and building options to be used on this pipeline
* return the options to be used
*
* @return the parser options for this pipeline
*/
public ParseOptions getParseOptions() {
return parseOptions;
}
/**
* Say whether xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes
* should be recognized while validating an instance document
*
* @param recognize true if these attributes should be recognized
*/
public void setUseXsiSchemaLocation(boolean recognize) {
parseOptions.setUseXsiSchemaLocation(recognize);
}
/**
* Say whether validation errors encountered on this pipeline should be treated as fatal
* or as recoverable.
* Note this is a shortcut for getParseOptions().setContinueAfterValidationErrors(), retained
* for backwards compatibility.
*
* @param recover set to true if validation errors are to be treated as recoverable. If this option is set to true,
* such errors will be reported to the ErrorListener using the error() method, and validation will continue.
* If it is set to false, errors will be reported using the fatalError() method, and validation will
* be abandoned. The default depends on the circumstances: typically during standalone instance validation
* the default is true, but during XSLT and XQuery processing it is false.
*/
public void setRecoverFromValidationErrors(boolean recover) {
parseOptions.setContinueAfterValidationErrors(recover);
}
/**
* Ask if this pipeline recovers from validation errors
* Note this is a shortcut for getParseOptions().isContinueAfterValidationErrors(), retained
* for backwards compatibility.
*
* @return true if validation errors on this pipeline are treated as recoverable; false if they are treated
* as fatal
*/
public boolean isRecoverFromValidationErrors() {
return parseOptions.isContinueAfterValidationErrors();
}
/**
* Set a user-defined SchemaURIResolver for resolving URIs used in "import schema"
* declarations.
*
* @param resolver the SchemaURIResolver
*/
public void setSchemaURIResolver(SchemaURIResolver resolver) {
schemaURIResolver = resolver;
}
/**
* Get the controller associated with this pipelineConfiguration
*
* @return the controller if it is known; otherwise null.
*/
public Controller getController() {
return controller;
}
/**
* Set the context item. Used only for diagnostics, to indicate
* what part of the source document is being processed. Maintained
* only by XSLT instructions that change the context, e.g. for-each,
* apply-templates, iterate, and for-each-group
*
* @param contextIterator the context iterator (whose current item is the context item)
*/
public void pushCurrentAppliedItem(Item item) {
if (currentApplyStack == null) {
currentApplyStack = new Stack- ();
}
currentApplyStack.push(item);
}
/**
* Get the context item. Used only for diagnostics, to indicate
* what part of the source document is being processed. Maintained
* only by XSLT instructions that change the context, e.g. for-each,
* apply-templates, iterate, and for-each-group
*
* @return context iterator (whose current item is the context item) if known, otherwise null
*/
public void popCurrentAppliedItem() {
currentApplyStack.pop();
}
public Item peekCurrentAppliedItem() {
if (currentApplyStack != null && currentApplyStack.size() > 0) {
return currentApplyStack.peek();
} else {
return null;
}
}
public Stack
- getAppliedItemStack() {
return currentApplyStack;
}
/**
* Set the Controller associated with this pipelineConfiguration
*
* @param controller the Controller
*/
public void setController(Controller controller) {
this.controller = controller;
}
/**
* Get the host language in use
*
* @return for example {@link Configuration#XSLT} or {@link Configuration#XQUERY}
*/
public int getHostLanguage() {
return hostLanguage;
}
/**
* Set the host language in use
*
* @param language for example {@link Configuration#XSLT} or {@link Configuration#XQUERY}
*/
public void setHostLanguage(int language) {
hostLanguage = language;
}
/**
* Ask whether this pipeline is a serializing pipeline
*
* @return true if this pipeline is producing serialized output
*/
public boolean isSerializing() {
return isSerializing;
}
/**
* Set whether this pipeline is a serializing pipeline
*
* @param isSerializing true if this pipeline is producing serialized output
*/
public void setSerializing(boolean isSerializing) {
this.isSerializing = isSerializing;
}
/**
* Set whether attribute defaults defined in a schema or DTD are to be expanded or not
* (by default, fixed and default attribute values are expanded, that is, they are inserted
* into the document during validation as if they were present in the instance being validated)
*
* @param expand true if defaults are to be expanded, false if not
*/
public void setExpandAttributeDefaults(boolean expand) {
parseOptions.setExpandAttributeDefaults(expand);
}
/**
* Ask whether attribute defaults defined in a schema or DTD are to be expanded or not
* (by default, fixed and default attribute values are expanded, that is, they are inserted
* into the document during validation as if they were present in the instance being validated)
*
* @return true if defaults are to be expanded, false if not
*/
public boolean isExpandAttributeDefaults() {
return parseOptions.isExpandAttributeDefaults();
}
/**
* Set a named component of the pipeline
*
* @param name string the component name
* @param value the component value
*/
public void setComponent(String name, Object value) {
if (components == null) {
components = new HashMap
();
}
components.put(name, value);
}
/**
* Get a named component of the pipeline
*
* @param name string the component name
* @return the component value, or null if absent
*/
public Object getComponent(String name) {
if (components == null) {
return null;
} else {
return components.get(name);
}
}
private static class DummyLocationProvider implements LocationProvider {
public final static DummyLocationProvider THE_INSTANCE = new DummyLocationProvider();
public String getSystemId(long locationId) {
return null;
}
public int getLineNumber(long locationId) {
return -1;
}
public int getColumnNumber(long locationId) {
return -1;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy