net.sf.saxon.event

Class PipelineConfiguration


public class PipelineConfiguration
extends java.lang.Object

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.

Constructor Summary

PipelineConfiguration()
Create a PipelineConfiguration.
PipelineConfiguration(PipelineConfiguration p)
Create a PipelineConfiguration as a copy of an existing PipelineConfiguration

Method Summary

Configuration
getConfiguration()
Get the Saxon Configuration object
Controller
getController()
Get the controller associated with this pipelineConfiguration
ErrorListener
getErrorListener()
Get the ErrorListener used for reporting errors in processing this pipeline
int
getHostLanguage()
Get the host language in use
LocationProvider
getLocationProvider()
Get the LocationProvider for interpreting location ids passed down this pipeline
SchemaURIResolver
getSchemaURIResolver()
Get the user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations; returns null if none has been explicitly set.
URIResolver
getURIResolver()
Get the URIResolver used for processing URIs encountered on this pipeline
boolean
isExpandAttributeDefaults()
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)
boolean
isSerializing()
Ask whether this pipeline is a serializing pipeline
void
setConfiguration(Configuration config)
Set the Saxon Configuration object
void
setController(Controller controller)
Set the Controller associated with this pipelineConfiguration
void
setErrorListener(ErrorListener errorListener)
Set the ErrorListener used for reporting errors in processing this pipeline
void
setExpandAttributeDefaults(boolean expand)
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)
void
setHostLanguage(int language)
Set the host language in use
void
setLocationProvider(LocationProvider locationProvider)
Set the LocationProvider for interpreting location ids passed down this pipeline
void
setSchemaURIResolver(SchemaURIResolver resolver)
Set a user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations.
void
setSerializing(boolean isSerializing)
Set whether this pipeline is a serializing pipeline
void
setURIResolver(URIResolver uriResolver)
Set the URIResolver used for processing URIs encountered on this pipeline

Constructor Details

PipelineConfiguration

public PipelineConfiguration()
Create a PipelineConfiguration. Note: the normal way to create a PipelineConfiguration is via the factory methods in the Controller and Configuration classes

PipelineConfiguration

public PipelineConfiguration(PipelineConfiguration p)
Create a PipelineConfiguration as a copy of an existing PipelineConfiguration
Parameters:
p - the existing PipelineConfiguration

Method Details

getConfiguration

public Configuration getConfiguration()
Get the Saxon Configuration object
Returns:
the Saxon Configuration

getController

public Controller getController()
Get the controller associated with this pipelineConfiguration
Returns:
the controller if it is known; otherwise null.

getErrorListener

public ErrorListener getErrorListener()
Get the ErrorListener used for reporting errors in processing this pipeline
Returns:
the ErrorListener

getHostLanguage

public int getHostLanguage()
Get the host language in use

getLocationProvider

public LocationProvider getLocationProvider()
Get the LocationProvider for interpreting location ids passed down this pipeline
Returns:
the appropriate LocationProvider

getSchemaURIResolver

public SchemaURIResolver getSchemaURIResolver()
Get the user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations; returns null if none has been explicitly set.
Returns:
the SchemaURIResolver

getURIResolver

public URIResolver getURIResolver()
Get the URIResolver used for processing URIs encountered on this pipeline
Returns:
the URIResolver

isExpandAttributeDefaults

public boolean isExpandAttributeDefaults()
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)
Returns:
true if defaults are to be expanded, false if not

isSerializing

public boolean isSerializing()
Ask whether this pipeline is a serializing pipeline
Returns:
true if this pipeline is producing serialized output

setConfiguration

public void setConfiguration(Configuration config)
Set the Saxon Configuration object
Parameters:
config - the Saxon Configuration

setController

public void setController(Controller controller)
Set the Controller associated with this pipelineConfiguration
Parameters:
controller - the Controller

setErrorListener

public void setErrorListener(ErrorListener errorListener)
Set the ErrorListener used for reporting errors in processing this pipeline
Parameters:
errorListener - the ErrorListener

setExpandAttributeDefaults

public void setExpandAttributeDefaults(boolean expand)
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)
Parameters:
expand - true if defaults are to be expanded, false if not

setHostLanguage

public void setHostLanguage(int language)
Set the host language in use

setLocationProvider

public void setLocationProvider(LocationProvider locationProvider)
Set the LocationProvider for interpreting location ids passed down this pipeline
Parameters:
locationProvider - the LocationProvider

setSchemaURIResolver

public void setSchemaURIResolver(SchemaURIResolver resolver)
Set a user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations.
Parameters:
resolver - the SchemaURIResolver

setSerializing

public void setSerializing(boolean isSerializing)
Set whether this pipeline is a serializing pipeline
Parameters:
isSerializing - true if this pipeline is producing serialized output

setURIResolver

public void setURIResolver(URIResolver uriResolver)
Set the URIResolver used for processing URIs encountered on this pipeline
Parameters:
uriResolver - the URIResolver