com.deltaxml.cores9api

Interface Summary
Interface	Description
DocumentProgressListener	Monitor the progress of the document comparator.
MovesAwareDocumentProgressListener	Moves Aware Document Progress Listener.
PipelineLocationEntry	The location of an entry in a comparator pipeline.
PipelineProgressListener	Monitor the progress of the pipelined comparator.
SummarisingErrorListener

Class Summary
Class	Description
DCPConfiguration	Loads a `DocumentComparator` from a DCP configuration.
DCPipelineProgressTextReporter	Reports pipeline progress to System.err using textual messages.
DocumentComparator	Provides a pre-configured comparison tool more suited for document comparison.
DXPConfigurationS9	Loads a `PipelinedComparatorS9` from a DXP configuration.
FilterChain	Represents a chain of `FilterStep`s that can be applied to XML input in a specified order to produce a result.
FilterStep	Represents a single step in an XML processing pipeline.
FilterStepHelper	Provides a mechanism for creating `FilterStep` instances.
PipelinedComparatorS9	Provides a Pipeline abstraction for the Comparator.
PipelineProgressTextReporter	Reports pipeline progress to System.err using textual messages.
SchemaErrorHandler	Error handler for DCP Schema.

Enum Summary
Enum Description

DocumentComparator.ExtensionPoint
Represents the point at which user FilterSteps can be inserted.

Enum Summary
Enum	Description
DocumentComparator.ExtensionPoint	Represents the point at which user `FilterStep`s can be inserted.

Exception Summary
Exception	Description
ComparisonCancelledException	The comparison was cancelled via some kind of `CancellationPolicy`.
ComparisonException	Indicates a problem during the comparison stage of the pipeline.
ConditionalFilterXPathException	Indicates a problem evaluating the 'when' XPath expression on a conditional filter in a DXP file.
DuplicateStepNameException	Indicates that an attempt has been made to declare multiple PipelineSteps with the same name in a single Pipeline.
DynamicPDFormatException	Indicates an error encountered either when resolving XPath expressions in the Pipeline Description or when validating the resolved Pipeline Description.
FilterProcessingException	Thrown to indicate a failure when running a pipeline filter.
FilterProcessingRangeException	An exception used to indicate a problem in a filter, where the location of the filter cannot be precisely identified, typically because of filter streaming.
FilterProcessingSingleException	An exception indicating a problem when applying a single filter to a pipeline input or output.
LicenseException	An exception class corresponding to the licensing related issues that can occur during the various compare(), isEqual() and setRedistributionLicenseContent() methods.
PDAdvancedConfigException	Indicates an error encountered when processing properties or features in the 'advancedConfig' element of the Pipeline Description.
PDConfigurationException	Indicates an error condition in the Pipeline Description format.
PDFilterConfigurationException	Indicates an error encountered when loading a filter defined in a Pipeline Description format, after parameters are resolved.
PipelinedComparatorS9Exception	Indicates an error condition in the PipelinedComparatorS9 compare method.
PipelineException	Indicates an error condition in the use of a Pipeline Object.
PipelineLoadingException	Indicates a problem when loading a pipeline.
PipelineSerializationException	Indicates a problem when saving or serializing the result of a comparison using PipelinedComparatorS9.
StaticPDFormatException	Indicates an error encountered when parsing the Pipeline Description format, prior to resolving any parameters.
XPathFilterParameterException	Indicates a problem evaluating the 'xpath' XPath expression on a filter parameter in a DXP file.

Package com.deltaxml.cores9api Description

A Saxon S9API compatible interface to facilitate construction of XML comparison pipelines.

Prerequisites

This API requires:

A Java version 8 or later, runtime system (or JRE) for runtime use, or
A Java version 8 or later, JDK for compiling applications
Saxon version 9.9. Saxon Professional Edition is included with this release and licensed for use within DeltaXML Pipelines.
An XML parser.

By default an XML parser is instantiated using the JAXP SAXParserFactory and users can configure an appropriate class using system properties, service manifests or the other JAXP Factory configuration mechanisms. We include a copy of Xerces-J and recommend its use in preference to platform or JDK default classes. The com.deltaxml.config.JavaPlatform.useSAXParserFactory configuration property when set to the value 'false' can be used to bypass the JAXP SAXParserFactory and will instead directly instantiate Xerces-J using the org.apache.xerces.jaxp.SAXParserFactoryImpl class.

Samples

Samples are published on Bitbucket at bitbucket.org/deltaxml with a README.md file explaining compilation/running. We recommend using the provided Ant scripts for compilation and running . The Ant build tool is available from ant.apache.org.

Compatibility

This package is designed to be compatible with the com.deltaxml.core package. Several of the classes and methods have similar names and the DXP file format support is identical between these packages. While they are not source code compatible, we have designed for compatibility so that few modifications are required when moving to this new package.

We have chosen to add 'S9' to several of the classnames to avoid confusion when porting or migrating, so for example com.deltaxml.core.PipelinedComparator has a similar interface and functionality to com.deltaxml.cores9api.PipelinedComparatorS9.

When a class has been modified we've added the 'S9' substring. New classes related to the new pipeline architecture are contained in this package. However, there are several classes shared between the core and cores9api packages with similar or identical interfaces; rather than needlessly duplicate code we refer to classes in the core package. So for example the com.deltaxml.cores9api.PipelinedComparatorS9 constructors will throw a com.deltaxml.core.ParserInstantiationException (as does com.deltaxml.core.PipelinedComparator).

Multi-threaded Use

A single PipelinedComparatorS9 should not be used by multiple threads running concurrently. Different PipelinedComparators may be used concurrently by different threads. This is also true for Document Comparator.

Support Information

Please visit our Support Page to find the relevant channels to use for any questions, bug-reports, suggested enhancements or any other matter related to this software.