com.deltaxml.cores9api.internals

Interface CommonComparator

All Known Implementing Classes:

DocumentComparator, PipelinedComparatorS9

public interface CommonComparator

An internal interface that is used to expose common Core S9 API methods for use with .NET API.

Method Summary

Modifier and Type	Method and Description
void	addLicenseFile(java.io.File licenseFile) Sets the license file for use with Flexera licensing.
void	addLicenseServer(java.lang.String hostname) Sets a license server for use with concurrent licensing.
void	addLicenseServer(java.lang.String hostname, int port) Sets a license server and port for use with concurrent licensing.
void	compare(java.io.File f1, java.io.File f2, java.io.File result) Compares File objects and uses a File to represent the result.
void	compare(org.xml.sax.InputSource a, org.xml.sax.InputSource b, javax.xml.transform.stream.StreamResult result) Compares the XML obtained from InputSource Objects and writes the pipeline result to a StreamResult.
void	compare(java.io.InputStream a, java.lang.String systemIdA, java.io.InputStream b, java.lang.String systemIdB, java.io.OutputStream result) Compares the XML obtained from InputStream objects and uses an OutputStream to represent the pipeline result.
void	compare(java.io.Reader a, java.lang.String systemIdA, java.io.Reader b, java.lang.String systemIdB, java.io.Writer result) Compares the XML obtained from Reader objects and uses a Writer to represent the pipeline result.
void	compare(java.lang.String a, java.lang.String systemIdA, java.lang.String b, java.lang.String systemIdB, java.lang.StringBuilder result) Compares the XML obtained from Strings and uses a StringBuilder to represent the pipeline result.
void	compare(java.net.URL a, java.net.URL b, java.io.File result) Compares the XML obtained from URLs and writes the pipeline result to a File.
void	compare(java.net.URL a, java.net.URL b, java.io.OutputStream result) Compares the XML obtained from URLs and writes the pipeline result to an OutputStream.
net.sf.saxon.s9api.XdmNode	compare(net.sf.saxon.s9api.XdmNode a, net.sf.saxon.s9api.XdmNode b) Compares two Saxon XdmNode trees and generates an XdmNode tree result from the pipeline.
org.xml.sax.EntityResolver	getEntityResolver() Returns the current entity resolver setting.
LexicalPreservationConfig	getLexicalPreservationConfig() Returns the current lexical preservation configuration settings.
int	getNumberOfProgressStages() Get the total number of enabled Progress Reporting Stages.
java.lang.String	getOutputProperty(net.sf.saxon.s9api.Serializer.Property property) Allows the current settings of the serializer properties to be determined.
boolean	getParserFeature(java.lang.String featureName) Allows the current settings of parser features to be determined.
java.lang.Object	getParserProperty(java.lang.String propertyName) Allows the current settings of parser properties to be determined.
java.lang.Object	getTransformerConfigurationOption(java.lang.String name) Reports current attribute settings of the XSLT transformers in the pipeline.
javax.xml.transform.URIResolver	getURIResolver() Returns the current URI resolver setting.
FilterStepHelper	newFilterStepHelper() Creates a FilterStepHelper using the Processor and URIResolver currently in use by this Core S9 API Comparator.
void	setDebugFiles(boolean debug) Determines whether intermediate pipeline result files are generated.
void	setDebugFilesPrefix(java.lang.String debugPrefix) Provides a prefix for debug result files.
void	setEntityResolver(org.xml.sax.EntityResolver resolver) Set an entity resolver for use when reading the inputs to the pipelined comparator.
void	setEntityResolver(org.xml.sax.EntityResolver resolver, boolean useFallbackEntityResolver) Set an entity resolver for use when reading the inputs to the pipelined comparator.
void	setLexicalPreservationConfig(LexicalPreservationConfig config) Sets the LexicalPreservationConfig to use during comparison.
void	setOutputProperty(net.sf.saxon.s9api.Serializer.Property property, java.lang.String value) Configures output formatting and control.
void	setParserFeature(java.lang.String featureName, boolean value) Sets a feature on the parser used for reading XML inputs into a Core S9 Comparator.
void	setParserProperty(java.lang.String propertyName, java.lang.Object value) Configures parser properties for the pipeline input parsers.
void	setRedistributionLicenseContent(long[] encodedLicense) Sets a redistribution license for use with subsequent compare operations.
void	setTransformerConfigurationOption(java.lang.String name, java.lang.Object value) Set a configuration option on the XSLT transformers used in a Core S9 API comparator.
void	setURIResolver(javax.xml.transform.URIResolver resolver) Sets a resolver for use by all XSLT based filters in a Core S9 API comparator.
void	setURIResolver(javax.xml.transform.URIResolver resolver, boolean useFallbackURIResolver) Sets a resolver for use by all XSLT based filters in a Core S9 API comparator.

Method Detail

newFilterStepHelper

FilterStepHelper newFilterStepHelper()

Creates a FilterStepHelper using the Processor and URIResolver currently in use by this Core S9 API Comparator.

Due to the way that Saxon's Processor works, all internal XdmNodes and compiled XSLT must be created by the same Processor. Therefore FilterChains and FilterSteps that are to be associated with this Core S9 API Comparator, should be instantiated by this Comparator's FilterStepHelper, which is what this method provides.

Returns:

an instance of a FilterStepHelper with which to create FilterChains and FilterSteps for this Core S9 API Comparator.

Since:

7.0

setRedistributionLicenseContent

void setRedistributionLicenseContent(long[] encodedLicense)
                              throws LicenseException

Sets a redistribution license for use with subsequent compare operations.

DeltaXML Redistribtion or 'OEM' customers should use this method in conjunction with supplied code which is typically compiled and integrated into their own products. The supplied code provides examples of usage. This method is not intended to be used by other types of license/customer.

A LicenseException should always contain a nested exception or cause containing further details of the underlying issue. This will typically be either LicenseContentException or LicenseSecurityException

Note that some of the exceptions thrown here can also be thrown by a compare method.

Parameters:

encodedLicense - a redistribution license

Throws:

LicenseException - if there are any problems with the supplied license or its use

setURIResolver

void setURIResolver(javax.xml.transform.URIResolver resolver,
                    boolean useFallbackURIResolver)

Sets a resolver for use by all XSLT based filters in a Core S9 API comparator. A URIResolver used in this way is useful when resolving files referenced by <xsl:import> , <xsl:include> and document() constructs.

Parameters:

resolver - An implementation of the URIResolver interface, or null

useFallbackURIResolver - Whether to use the fallback URI Resolver, if the user supplied URI Resolver fails to resolve.

See Also:

XsltTransformer.setURIResolver(javax.xml.transform.URIResolver)

setURIResolver

void setURIResolver(javax.xml.transform.URIResolver resolver)

Sets a resolver for use by all XSLT based filters in a Core S9 API comparator. This resolver is then used during compilation and transformation to determine the location of URIs associated with the <xsl:import>, <xml:include> and document() constructs. This is equivalent to calling setURIResolver(resolver, true).

Parameters:

resolver - An implementation of the URIResolver interface, or null

getURIResolver

javax.xml.transform.URIResolver getURIResolver()

Returns the current URI resolver setting.

Returns:

The current resolver in use, or null if one hasn't been set or if it was previously nulled.

setEntityResolver

void setEntityResolver(org.xml.sax.EntityResolver resolver,
                       boolean useFallbackEntityResolver)

Set an entity resolver for use when reading the inputs to the pipelined comparator.

Parameters:

resolver - the user specified entity resolver.

useFallbackEntityResolver - whether to use the internal catalog support (supplied by the fallback entity resolver).

setEntityResolver

void setEntityResolver(org.xml.sax.EntityResolver resolver)

Set an entity resolver for use when reading the inputs to the pipelined comparator. This is equivalent to calling setEntityResolver(resolver, true).

Parameters:

resolver - the user specified entity resolver.

getEntityResolver

org.xml.sax.EntityResolver getEntityResolver()

Returns the current entity resolver setting.

Returns:

The current entity resolver in use, or null if one hasn't been set or if it was previously nulled.

setTransformerConfigurationOption

void setTransformerConfigurationOption(java.lang.String name,
                                       java.lang.Object value)
                                throws java.lang.IllegalArgumentException

Set a configuration option on the XSLT transformers used in a Core S9 API comparator. Some of the configuration options affect the compilation of XSLT filters and as the compilation process can be triggered by various step helper methods. This method should be used prior to these methods if appropriate. Please also note that it is possible to create XSLT based steps using a Saxon Processor argument, this method will not apply to Steps created in this way as this method configures the Saxon Processor that is created by or passed as an argument to a Core S9 API comparator constructor.

Please note: Some of the options available with Saxon assume that the Transformer is 'in control' of the parser or XMLReader used for input processing. This is not the case for Core S9 API comparators; if an attribute seems to have no effect look for alternative techniques such as using equivalent features and the CommonComparator.setParserFeature(java.lang.String, boolean) method.

Parameters:

name - The name of the option to set

value - The value to be set (an Object)

Throws:

java.lang.IllegalArgumentException - if the attribute name is not recognized by the underlying Transformer

See Also:

Saxon Feature, CommonComparator.getTransformerConfigurationOption(String), CommonComparator.setParserFeature(String, boolean)

getTransformerConfigurationOption

java.lang.Object getTransformerConfigurationOption(java.lang.String name)
                                            throws java.lang.IllegalArgumentException

Reports current attribute settings of the XSLT transformers in the pipeline.

Parameters:

name - of the option to report

Returns:

an Object representing the current setting

Throws:

java.lang.IllegalArgumentException - if the attribute name is not recognized by the underlying TransformerFactory

See Also:

Saxon Feature, Xalan-J attributes, CommonComparator.setTransformerConfigurationOption(String, Object)

setParserFeature

void setParserFeature(java.lang.String featureName,
                      boolean value)
               throws FeatureSettingNotSupportedException,
                      FeatureNotRecognizedException,
                      java.lang.IllegalArgumentException

Sets a feature on the parser used for reading XML inputs into a Core S9 Comparator.

Feature setting modify the parsing behaviour of a pipeline. In particular features relating to input validation, schema and DTD handling can be controlled. The features which can be controlled are features of the underlying SAX parser used in the pipeline (but with some exceptions described below). If the SAX parser being used is Apache Xerces, the features which can be set are both the generic SAX features and Apache specific ones.

These features are only appropriate and will only be applied when the compare methods in this class are responsible for parsing and loading input XML data. When the compare or isEqual methods use XdmNode arguments the data has already been parsed and the code being used for creating the XdmNode objects should be configured appropriately.

The following table lists settings which should not be used, as the Saxon s9api code used internally in the PipelinedComparatorS9 will override these settings. Alternative settings using the CommonComparator.setTransformerConfigurationOption(java.lang.String, java.lang.Object) method must be used instead:

Parser Feature	Corresponding setTransformerConfigurationOption
http://xml.org/sax/features/validation	Feature.DTD_VALIDATION
http://apache.org/xml/features/xinclude-aware	Feature.XINCLUDE
http://apache.org/xml/features/xinclude	Feature.XINCLUDE

The following list includes some of the features which we consider useful in conjunction with a pipelined comparator architecture:

• http://apache.org/xml/features/validation/ dynamic
• http://apache.org/xml/features/validation/ schema
• http://apache.org/xml/features/ nonvalidating/load-dtd-grammar
• http://apache.org/xml/features/ nonvalidating/load-external-dtd

The following table lists features that can only be set to specific values. These fixed settings are necessary for the comparator to operate properly. This in turn is because Saxon requires particular feature settings to be used and supported by setFeature. Any attempt to set values other than those shown below will result in a FeatureSettingNotSupportedException being thrown.

Feature	fixed/permissible value
http://xml.org/sax/features/namespaces	true
http://xml.org/sax/features/namespace- prefixes	false

Parameters:

featureName - the name of the feature to be set

value - the new value for the feature

Throws:

FeatureSettingNotSupportedException - if the feature cannot be set to the specific value

FeatureNotRecognizedException - if the featureName is not recognized

java.lang.IllegalArgumentException - if the featureName argument is null

See Also:

XMLReader.setFeature(String, boolean), Processor.setConfigurationProperty(Feature, Object), Feature

getParserFeature

boolean getParserFeature(java.lang.String featureName)
                  throws FeatureNotRecognizedException,
                         java.lang.IllegalArgumentException

Allows the current settings of parser features to be determined.

Parameters:

featureName - the name of the feature whose value is being queried

Returns:

the current value of the feature

Throws:

FeatureNotRecognizedException - if the featureName is not recognized

java.lang.IllegalArgumentException - if the argument is null

See Also:

CommonComparator.setParserFeature(String, boolean)

setParserProperty

void setParserProperty(java.lang.String propertyName,
                       java.lang.Object value)
                throws PropertyNotRecognizedException,
                       PropertySettingNotSupportedException,
                       java.lang.IllegalArgumentException

Configures parser properties for the pipeline input parsers.

Allows properties of the underlying parser to be configured. If using Apache Xerces-J the following properties may prove useful in comparator pipelines:

• http://apache.org/xml/ properties/schema/external-schemaLocation
• http://apache.org/ xml/properties/schema/external-noNamespaceSchemaLocation

Parameters:

propertyName - the name of the property to set on the parser

value - the new value for the property

Throws:

PropertySettingNotSupportedException - if the property cannot be set to the specific value

PropertyNotRecognizedException - if the property name is not recognized

java.lang.IllegalArgumentException - if an argument is null

See Also:

CommonComparator.getParserProperty(String), XMLReader.setProperty(java.lang.String, java.lang.Object)

getParserProperty

java.lang.Object getParserProperty(java.lang.String propertyName)
                            throws PropertyNotRecognizedException,
                                   java.lang.IllegalArgumentException

Allows the current settings of parser properties to be determined.

Parameters:

propertyName - the name of the property whose value is being queried

Returns:

an Object representing the current value of the property

Throws:

PropertyNotRecognizedException - if the property name is not recognized

java.lang.IllegalArgumentException - if the argument is null

See Also:

CommonComparator.setParserProperty(String, Object)

setOutputProperty

void setOutputProperty(net.sf.saxon.s9api.Serializer.Property property,
                       java.lang.String value)
                throws java.lang.IllegalArgumentException

Configures output formatting and control.

Any properties set here are then passed to the Serializer used to write the output in most of the compare methods. The compare method which returns an XdmNode result bypasses XML serialization and any properties will have no effect with this method.

NOTE The Saxon s9api Serializer will throw an XPathException which in turn will be presented as an exception during compare or isEqual when "omit-xml-declaration" has the value "yes" and standalone has either of the values "yes" or "no". Saxon does however support setting the "standalone" property to "omit" as described in the XSLT2 serialization specification.

Parameters:

property - the property to set

value - the new value for the property

Throws:

java.lang.IllegalArgumentException - if a parameter value is illegal in some way

See Also:

Serializer.setOutputProperty(net.sf.saxon.s9api.Serializer.Property, java.lang.String), Serializer.Property, XSLT 2.0 and XQuery 1.0 Serialization, section 5.1.5

getOutputProperty

java.lang.String getOutputProperty(net.sf.saxon.s9api.Serializer.Property property)

Allows the current settings of the serializer properties to be determined.

Parameters:

property - the output property whose value is being queried

Returns:

the value of the property

See Also:

Serializer.Property

setLexicalPreservationConfig

void setLexicalPreservationConfig(LexicalPreservationConfig config)

Sets the LexicalPreservationConfig to use during comparison.

Parameters:

config - the LexicalPreservationConfig object to use during comparison

Since:

7.0

See Also:

for details of what the settings are used for

getLexicalPreservationConfig

LexicalPreservationConfig getLexicalPreservationConfig()

Returns the current lexical preservation configuration settings.

Returns:

a configuration object containing the settings in use for lexical preservation (or null if it has not been configured).

Since:

7.0

getNumberOfProgressStages

int getNumberOfProgressStages()

Get the total number of enabled Progress Reporting Stages. The number returned by this function is dependent on the number of input and output filters that are enabled, so should be called once all these filters have been loaded and configured. It corresponds to the number of Finish messages that will be reported by the PipelineProgressListener.

Returns:

the number of enabled stages that the comparison pipeline contains.

setDebugFiles

void setDebugFiles(boolean debug)

Determines whether intermediate pipeline result files are generated. When developing a pipelined application it is sometimes useful to see the intermediate results. This debug option when set will generate a file containing the XML corresponding the intermediate result of most of the pipeline stages. These files are generated in the current working directory and are named according to the filter chain (a, b, result) and their position within the chain. An optional prefix can be supplied and is useful in applications involving multiple comparison pipelines or multiple invocations of a pipeline so that the intermediate results are not overwritten on sucessive comparison runs and can be differentiated.

Parameters:

debug - when true intermediate result files are produced

See Also:

CommonComparator.setDebugFilesPrefix(String)

setDebugFilesPrefix

void setDebugFilesPrefix(java.lang.String debugPrefix)

Provides a prefix for debug result files.

Parameters:

debugPrefix - The prefix that will be used for debug file names in subsequent compare operations

See Also:

CommonComparator.setDebugFiles(boolean)

compare

void compare(java.io.File f1,
             java.io.File f2,
             java.io.File result)
      throws ComparisonException,
             FilterProcessingException,
             java.io.FileNotFoundException,
             java.io.IOException,
             PipelineLoadingException,
             PipelineSerializationException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares File objects and uses a File to represent the result.

Parameters:

f1 - the first comparison input

f2 - the second input

result - the location where the pipeline result will be written

Throws:

ComparisonException - if there is a problem during the comparison processing

FilterProcessingException - if there was a problem running any of the filters

java.io.FileNotFoundException - if the input or output files cannot be found

java.io.IOException - if there is a problem opening/closing streams associated with the File arguments

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the result cannot be saved or serialized to the result location

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

void compare(java.io.Reader a,
             java.lang.String systemIdA,
             java.io.Reader b,
             java.lang.String systemIdB,
             java.io.Writer result)
      throws ComparisonException,
             FilterProcessingException,
             PipelineLoadingException,
             PipelineSerializationException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares the XML obtained from Reader objects and uses a Writer to represent the pipeline result.

systemId parameters are provided so that relative URIs can be resolved in the inputs, they are also useful when reporting errors as the systemId may be useful when locating the error position. Using identifiers such as "string1" or "database2" may be useful when the inputs do not contain URIs to resolve as they can aid error diagnosis.

Parameters:

a - The reader from which the first input is read

b - The reader for the second input

result - where the pipeline result will be written

systemIdA - the SystemId used for resolving URIs and reporting errors associated with the A input

systemIdB - the SystemId used for resolving URIs and reporting errors associated with the B input

Throws:

ComparisonException - if there is a problem during the comparison processing

FilterProcessingException - if there was a problem running any of the filters

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the output cannot be saved or serialized to the result location

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

void compare(java.io.InputStream a,
             java.lang.String systemIdA,
             java.io.InputStream b,
             java.lang.String systemIdB,
             java.io.OutputStream result)
      throws ComparisonException,
             PipelineLoadingException,
             FilterProcessingException,
             PipelineSerializationException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares the XML obtained from InputStream objects and uses an OutputStream to represent the pipeline result.

systemId parameters are provided so that relative URIs can be resolved in the inputs, they are also useful when reporting errors as the systemId may be useful when locating the error position. Using identifiers such as "string1" or "database2" may be useful when the inputs do not contain URIs to resolve as they can aid error diagnosis.

Parameters:

a - The InputStream from which the first input is read

b - The InputStream for the second input

result - where the pipeline result will be written

systemIdA - the SystemId used for resolving URIs and reporting errors associated with the A input

systemIdB - the SystemId used for resolving URIs and reporting errors associated with the B input

Throws:

ComparisonException - if there is a problem during the comparison processing

FilterProcessingException - if there was a problem running any of the filters

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the output cannot be saved or serialized to the result location

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

void compare(java.lang.String a,
             java.lang.String systemIdA,
             java.lang.String b,
             java.lang.String systemIdB,
             java.lang.StringBuilder result)
      throws ComparisonException,
             PipelineLoadingException,
             FilterProcessingException,
             PipelineSerializationException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares the XML obtained from Strings and uses a StringBuilder to represent the pipeline result.

systemId parameters are provided so that relative URIs can be resolved in the inputs, they are also useful when reporting errors as the systemId may be useful when locating the error position. Using identifiers such as "string1" or "database2" may be useful when the inputs do not contain URIs to resolve as they can aid error diagnosis.

Parameters:

a - The String from which the first input is read

b - The String for the second input

result - where the pipeline result will be written

systemIdA - the SystemId used for resolving URIs and reporting errors associated with the A input

systemIdB - the SystemId used for resolving URIs and reporting errors associated with the B input

Throws:

ComparisonException - if there is a problem during the comparison processing

FilterProcessingException - if there was a problem running any of the filters

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the output cannot be saved or serialized to the result location

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

void compare(java.net.URL a,
             java.net.URL b,
             java.io.File result)
      throws ComparisonException,
             PipelineLoadingException,
             FilterProcessingException,
             PipelineSerializationException,
             java.io.FileNotFoundException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares the XML obtained from URLs and writes the pipeline result to a File.

Parameters:

a - The URL from which the first input is loaded

b - The URL for the second input

result - where the pipeline result will be written

Throws:

ComparisonException - if there is a problem during the comparison processing

FilterProcessingException - if there was a problem running any of the filters

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the output cannot be saved or serialized to the result location

java.io.FileNotFoundException - if the output file location cannot be found

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

void compare(java.net.URL a,
             java.net.URL b,
             java.io.OutputStream result)
      throws ComparisonException,
             PipelineLoadingException,
             FilterProcessingException,
             PipelineSerializationException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares the XML obtained from URLs and writes the pipeline result to an OutputStream.

Parameters:

a - The URL from which the first input is loaded

b - The URL for the second input

result - where the pipeline result will be written

Throws:

ComparisonException - if there is a problem during the comparison processing

FilterProcessingException - if there was a problem running any of the filters

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the input cannot be saved or serialized to the result location

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

void compare(org.xml.sax.InputSource a,
             org.xml.sax.InputSource b,
             javax.xml.transform.stream.StreamResult result)
      throws ComparisonException,
             PipelineLoadingException,
             FilterProcessingException,
             PipelineSerializationException,
             LicenseException,
             PipelinedComparatorError,
             ComparisonCancelledException

Compares the XML obtained from InputSource Objects and writes the pipeline result to a StreamResult.

It is recommended that systemIds be associated with the InputSource parameters so that relative URIs and external entities can be resolved.

Parameters:

a - The InputSource from which the first input is loaded

b - The InputSource for the second input

result - where the pipeline result will be written

Throws:

ComparisonException - if their is a problem during the comparison stage of the pipeline

FilterProcessingException - if there was a problem running any of the filters

PipelineLoadingException - if the inputs cannot be loaded or parsed

PipelineSerializationException - if the output cannot be saved or serialized to the result location

LicenseException - if there is a licensing issue that prevents operation

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

compare

net.sf.saxon.s9api.XdmNode compare(net.sf.saxon.s9api.XdmNode a,
                                   net.sf.saxon.s9api.XdmNode b)
                            throws FilterProcessingException,
                                   ComparisonException,
                                   LicenseException,
                                   java.lang.IllegalArgumentException,
                                   PipelinedComparatorError,
                                   ComparisonCancelledException

Compares two Saxon XdmNode trees and generates an XdmNode tree result from the pipeline.

XdmNode trees are associated with specific s9api Processors. This method should be used in conjunction with one of the class constructors which takes a Processor argument.

Parameters:

a - The first XdmNode input tree to be compared

b - The second XdmNode input

Returns:

an XdmNode tree containing the comparison result

Throws:

FilterProcessingException - if there is a problem executing the pipeline filters

LicenseException - if there is a licensing issue

ComparisonException - if there is a problem during the comparison processing

PipelinedComparatorError - if a comparator execution thread is interrupted by another thread

java.lang.IllegalArgumentException - if the XdmNodes were produced by an unknown Saxon Processor

ComparisonCancelledException - if a comparison is cancelled according to the CancellationPolicy in force

addLicenseFile

void addLicenseFile(java.io.File licenseFile)
             throws java.lang.SecurityException,
                    java.io.IOException,
                    LicenseException

Sets the license file for use with Flexera licensing. This can be either simple fixed host/user licensing, or a concurrent licensing containing the USE_SERVER directive

Parameters:

licenseFile - the FlexLM format license file

Throws:

java.lang.SecurityException - if the file cannot be accessed

java.io.IOException - if there are problems reading the file

LicenseException - if there is a problem using the license file

addLicenseServer

void addLicenseServer(java.lang.String hostname)
               throws LicenseException

Sets a license server for use with concurrent licensing.

Parameters:

hostname - the license server host or its ip address

Throws:

LicenseException - if there is a problem using the license server

addLicenseServer

void addLicenseServer(java.lang.String hostname,
                      int port)
               throws java.lang.IllegalArgumentException,
                      LicenseException

Sets a license server and port for use with concurrent licensing.

Parameters:

hostname - the license server host or its ip address

port - the port number on the license server for the lmgrd

Throws:

java.lang.IllegalArgumentException - if the port number is out of range

LicenseException - if there is a problem using the license server