Package net.sf.saxon.event
Class PipelineConfiguration
java.lang.Object
net.sf.saxon.event.PipelineConfiguration
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
ConstructorsConstructorDescriptionPipelineConfiguration
(Configuration config) Create a PipelineConfiguration.Create a PipelineConfiguration as a copy of an existing PipelineConfiguration -
Method Summary
Modifier and TypeMethodDescriptiongetComponent
(String name) Get a named component of the pipelineGet the Saxon Configuration objectGet the controller associated with this pipelineConfigurationGet 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.Get the host language in useGet the document parsing and building options to be used on this pipeline return the options to be usedGet the user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations; returns null if none has been explicitly set.Get the URIResolver used for processing URIs encountered on this pipelineGet the XPathContext.boolean
Ask if this pipeline recovers from validation errorsboolean
isXSLT()
Ask if the host language is XSLTvoid
setComponent
(String name, Object value) Set a named component of the pipelinevoid
setConfiguration
(Configuration config) Set the Saxon Configuration objectvoid
setController
(Controller controller) Set the Controller associated with this pipelineConfigurationvoid
setErrorReporter
(ErrorReporter errorReporter) Set the ErrorListener used for reporting errors in processing this pipelinevoid
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
(HostLanguage language) Set the host language in usevoid
setParseOptions
(ParseOptions options) Set the document parsing and building options to be used on this pipelinevoid
setRecoverFromValidationErrors
(boolean recover) Say whether validation errors encountered on this pipeline should be treated as fatal or as recoverable.void
setSchemaURIResolver
(SchemaURIResolver resolver) Set a user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations.void
setURIResolver
(URIResolver uriResolver) Set the URIResolver used for processing URIs encountered on this pipelinevoid
setUseXsiSchemaLocation
(boolean recognize) Say whether xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes should be recognized while validating an instance documentvoid
setXPathContext
(XPathContext context) Set the XPathContext.
-
Constructor Details
-
PipelineConfiguration
Create a PipelineConfiguration. Note: the normal way to create a PipelineConfiguration is via the factory methods in the Controller and Configuration classes- Parameters:
config
- the Saxon configuration- See Also:
-
PipelineConfiguration
Create a PipelineConfiguration as a copy of an existing PipelineConfiguration- Parameters:
p
- the existing PipelineConfiguration
-
-
Method Details
-
getConfiguration
Get the Saxon Configuration object- Returns:
- the Saxon Configuration
-
setConfiguration
Set the Saxon Configuration object- Parameters:
config
- the Saxon Configuration
-
getErrorReporter
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.- Returns:
- the ErrorListener to be used; never null
-
setErrorReporter
Set the ErrorListener used for reporting errors in processing this pipeline- Parameters:
errorReporter
- the ErrorListener
-
getURIResolver
Get the URIResolver used for processing URIs encountered on this pipeline- Returns:
- the URIResolver
-
setURIResolver
Set the URIResolver used for processing URIs encountered on this pipeline- Parameters:
uriResolver
- the URIResolver
-
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
-
setParseOptions
Set the document parsing and building options to be used on this pipeline- Parameters:
options
- the options to be used
-
getParseOptions
Get the document parsing and building options to be used on this pipeline return the options to be used- Returns:
- the parser options for this pipeline
-
setUseXsiSchemaLocation
public void setUseXsiSchemaLocation(boolean recognize) Say whether xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes should be recognized while validating an instance document- Parameters:
recognize
- true if these attributes should be recognized
-
setRecoverFromValidationErrors
public void setRecoverFromValidationErrors(boolean recover) 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.- Parameters:
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.
-
isRecoverFromValidationErrors
public boolean isRecoverFromValidationErrors()Ask if this pipeline recovers from validation errorsNote this is a shortcut for
getParseOptions().isContinueAfterValidationErrors()
, retained for backwards compatibility.- Returns:
- true if validation errors on this pipeline are treated as recoverable; false if they are treated as fatal
-
setSchemaURIResolver
Set a user-defined SchemaURIResolver for resolving URIs used in "import schema" declarations.- Parameters:
resolver
- the SchemaURIResolver
-
getController
Get the controller associated with this pipelineConfiguration- Returns:
- the controller if it is known; otherwise null.
-
setController
Set the Controller associated with this pipelineConfiguration- Parameters:
controller
- the Controller
-
getHostLanguage
Get the host language in use- Returns:
- for example
HostLanguage.XSLT
orHostLanguage.XQUERY
-
isXSLT
public boolean isXSLT()Ask if the host language is XSLT- Returns:
- true if the host language is XSLT
-
setHostLanguage
Set the host language in use- Parameters:
language
- for exampleHostLanguage.XSLT
orHostLanguage.XQUERY
-
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
-
setComponent
Set a named component of the pipeline- Parameters:
name
- string the component namevalue
- the component value
-
getComponent
Get a named component of the pipeline- Parameters:
name
- string the component name- Returns:
- the component value, or null if absent
-
setXPathContext
Set the XPathContext. Used during validation, for diagnostics, to identify the source node that was being processed at the time a validation error in the result document was found- Parameters:
context
- the XPath dynamic context.
-
getXPathContext
Get the XPathContext. Used during validation, for diagnostics, to identify the source node that was being processed at the time a validation error in the result document was found- Returns:
- the XPath dynamic context.
-