public final class DocBookCompare
extends java.lang.Object
Produces a DocBook result document from two input DocBook documents that contains revisionflag attributes indicating changes between the two inputs.
This product supports DocBook version 4.x and DocBook version 5 and the use of the new DocBook namespace.
N.B. It is not possible to compare a DocBook 4 input with a DocBook 5 input that uses namespaces.
Modifier and Type | Field and Description |
---|---|
static DocBookCompareVersion |
productVersion |
Constructor and Description |
---|
DocBookCompare()
Constructs a new DocBookCompare instance.
|
Modifier and Type | Method and Description |
---|---|
void |
addDocBookCompareProgressListener(DocBookCompareProgressListener listener)
Adds a progress listener to the list of registered progress listeners.
|
void |
addLicenseFile(java.io.File licenseFile)
Adds the license file for use with Flexera licensing.
|
void |
addLicenseServer(java.lang.String hostname)
Adds a license server for use with concurrent licensing.
|
void |
addLicenseServer(java.lang.String hostname,
int port)
Adds a license server and port for use with concurrent licensing.
|
void |
compare(java.io.File input1,
java.io.File input2,
java.io.File result)
Compares two File inputs to produce a File result.
|
void |
compare(org.xml.sax.InputSource input1,
org.xml.sax.InputSource input2,
javax.xml.transform.stream.StreamResult result)
Compares two InputSource inputs to produce a StreamResult.
|
void |
compare(java.io.InputStream is1,
java.lang.String systemId1,
java.io.InputStream is2,
java.lang.String systemId2,
java.io.OutputStream result)
Compares two input streams to produce an output stream result.
|
void |
compare(java.io.Reader r1,
java.lang.String systemId1,
java.io.Reader r2,
java.lang.String systemId2,
java.io.Writer result)
Compares two input reader (character streams) to produce an output writer result.
|
java.lang.String |
compare(java.lang.String input1,
java.lang.String systemId1,
java.lang.String input2,
java.lang.String systemId2)
Compares two XML string inputs to produce an XML string result.
|
java.lang.String |
getAddInlineFormattingElements()
Returns the value of addInlineFormattingElements
|
java.lang.String |
getAdditionalPhraseContainers()
Returns the value of additionalPhraseContainers
|
boolean |
getCalsTableProcessing()
Returns the value of calsTableProcessing
|
boolean |
getDetectMoves()
Returns the value of detectMoves
|
boolean |
getEnableXinclude()
Returns the value of enableXinclude
|
org.xml.sax.EntityResolver |
getEntityResolver()
Gets the explicitly set EntityResolver in use by the comparison.
|
org.xml.sax.EntityResolver |
getEntityResolver(boolean builtInResolver)
Gets the EntityResolver in use by the comparison.
|
FrameMakerTrackChangesTableChangeMode |
getFramemakerTcsTableChangeMode()
Returns the value of framemakerTcsTableChangeMode
|
boolean |
getGrouping()
Returns the value of grouping
|
boolean |
getHtmlTableProcessing()
Returns the value of htmlTableProcessing
|
boolean |
getIgnoreInlineFormatting()
Returns the value of ignoreInlineFormatting
|
boolean |
getImageCompare()
Returns the value of imageCompare
|
IndentOutput |
getIndent()
Returns the value of indent
|
java.lang.String |
getInlineFormattingElements()
Returns the value of inlineFormattingElements
|
java.lang.String |
getInputASVGMarkupStyle()
Returns the value of inputASVGMarkupStyle
|
java.lang.String |
getInputBSVGMarkupStyle()
Returns the value of inputBSVGMarkupStyle
|
InvalidTableBehaviour |
getInvalidTableBehaviour()
Returns the value of invalidTableBehaviour
|
KeyingMode |
getKeyingMode()
Returns the value of keyingMode
|
boolean |
getMarkCalsTableCellSpanExtentChanges()
Returns true if mark-cals-table-cell-span-extent-changes feature is on, otherwise false.
|
boolean |
getMarkHtmlTableCellSpanExtentChanges()
Returns true if mark-html-table-cell-span-extent-changes feature is on, otherwise false.
|
MathMLGranularity |
getMathMLGranularity()
This parameter returns what level of granularity is being used with MathML processing
|
boolean |
getMathMLProcessing()
This parameter returns true or false based on if MathML processing is enabled or not
|
java.lang.String |
getMediaObjectParentsList()
Returns the value of mediaObjectParentsList
|
ModifiedAttributeMode |
getModifiedAttributeMode()
Returns the value of modifiedAttributeMode
|
java.lang.String |
getOutputEncodingDeclaration()
Returns the value of outputEncodingDeclaration
|
OutputFormat |
getOutputFormat()
Returns the value of outputFormat
|
OutputImageRefFavourSourceDoc |
getOutputImageRefFavourSourceDoc()
Returns the value of outputImageRefFavourSourceDoc
|
OutputImageRefForm |
getOutputImageRefForm()
Returns the value of outputImageRefType
|
OxygenTrackChangesDeletedSpaceMode |
getOxygenTcsDeletedSpaceMode()
Returns the value of oxygenTcsDeletedSpaceMode
|
java.lang.String |
getOxygenTcsVersion()
Returns the value of oxygenTcsVersion
|
PreservationMode |
getPreservationMode()
Returns the value of preservationMode
|
DocBookCompareVersion |
getProductVersion()
Get the product version.
|
java.lang.String |
getRemoveInlineFormattingElements()
Returns the value of removeInlineFormattingElements
|
boolean |
getShowImageChangesAtMediaObjectLevel()
Returns the value of imageCompare
|
boolean |
getShowImageChangesAtMediaObjectParentLevel()
Returns the value of split media object parent
|
boolean |
getShowNonPhraseChanges()
Returns the value of showNonPhraseChanges
|
StandaloneDeclaration |
getStandaloneDeclaration()
Deprecated.
|
boolean |
getSVGFallback()
Returns current setting for SVG Processing Fallback.
|
double |
getSVGFallbackChangePercentage()
Returns current setting for SVG Fallback Change Percentage.
|
SVGGranularity |
getSVGGranularity()
Returns current setting for SVG Granularity.
|
boolean |
getSVGNumericTolerance()
Determines whether to use numeric tolerance.
|
java.lang.String |
getSVGNumericToleranceValue()
Returns the value of svg-numeric-tolerance-value
|
boolean |
getSVGProcessing()
Returns current setting for SVG Processing.
|
boolean |
getSVGZIndex()
Determines whether to use numeric tolerance.
|
java.lang.String |
getTrackedChangesAuthor()
Returns the value of trackedChangesAuthor
|
java.lang.String |
getTrackedChangesDate()
Returns the value of trackedChangesDate
|
UnmarkedChangeMode |
getUnmarkedChangeMode()
Returns the value of unmarkedChangeMode
|
javax.xml.transform.URIResolver |
getURIResolver()
Gets the explicitly set URIResolver in use by the comparison.
|
javax.xml.transform.URIResolver |
getURIResolver(boolean builtInResolver)
Gets the URIResolver in use by the comparison.
|
boolean |
getValidateInputs()
Returns the value of validateInputs
|
WarningReportMode |
getWarningReportMode()
Returns the value of warningReportMode
|
WhitespaceProcessingMode |
getWhitespaceProcessingMode()
Returns the value of whitespaceProcessingMode
|
boolean |
getWordByWord()
Returns the value of wordByWord
|
XmetalTrackChangesTableChangeMode |
getXmetalTcsTableChangeMode()
Returns the value of xmetalTcsTableChangeMode
|
XmlVersionDeclaration |
getXmlVersionDeclaration()
Returns the value of xmlVersionDeclaration
|
java.lang.String |
getZIndexSVGMarkupStyle()
Returns the value of zIndexSVGMarkupStyle
|
void |
removeDocBookCompareProgressListener(DocBookCompareProgressListener listener)
Remove the first occurrence of the progress listener from the registered progress listener list.
|
void |
setAddInlineFormattingElements(java.lang.String value)
A comma and/or space separated list of inline formatting elements using Clark notation, which will be added to the value of
the inline-formatting-elements parameter
|
void |
setAdditionalPhraseContainers(java.lang.String value)
Sets the comma and/or space separated list of additional phrase elements using Clark notation.
|
void |
setCalsTableProcessing(boolean value)
Specifies whether to apply CALS table processing.
|
void |
setComUsageReporter(boolean reportingFromRest,
java.lang.String usageId,
java.lang.String jobId,
java.util.Map<java.lang.String,com.deltaxml.cores9api.common.usage.ComJobFile> inputJobFiles,
com.deltaxml.cores9api.common.usage.ComUsageReporter reporter) |
void |
setDetectMoves(boolean value)
Sets to detect and handle element moves.
|
void |
setEnableXinclude(boolean value)
Sets whether the parser will process xincludes.
|
void |
setEntityResolver(org.xml.sax.EntityResolver resolver,
boolean fallbackToDefaultCatalogResolver)
Sets the EntityResolver to use during the comparison.
|
void |
setFramemakerTcsTableChangeMode(FrameMakerTrackChangesTableChangeMode value)
Specifies how changes in tables should be tracked.
|
void |
setGrouping(boolean value)
Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block.
|
void |
setHtmlTableProcessing(boolean value)
Specifies whether to apply html table or DITA simpletable processing.
|
void |
setIgnoreInlineFormatting(boolean value)
If set to
true , any changes that consist only of the addition, deletion or modification of docbook inline markup
elements are not noted as changes. |
void |
setImageCompare(boolean value)
Whether the actual images used will be compared rather than the string value of the location (fileref attribute) of the
imagedata.
|
void |
setIndent(IndentOutput value)
Sets whether the result should be indented.
|
void |
setInlineFormattingElements(java.lang.String value)
Sets the comma and/or space separated list of inline formatting elements using Clark notation.
|
void |
setInputASVGMarkupStyle(java.lang.String value)
Sets the Input A SVG markup style for SVG comparison results.
|
void |
setInputBSVGMarkupStyle(java.lang.String value)
Sets the Input B SVG markup style for SVG comparison results.
|
void |
setInvalidTableBehaviour(InvalidTableBehaviour value)
In order to ensure that only valid CALS tables are passed to our specialized CALS table processing, each input table is
marked either valid or invalid.
|
void |
setKeyingMode(KeyingMode value)
Sets the mode to use for adding keys to the input documents.
|
void |
setLicenseFile(java.io.File licenseFile)
Deprecated.
|
void |
setLicenseServer(java.lang.String hostname)
Deprecated.
|
void |
setLicenseServer(java.lang.String hostname,
int port)
Deprecated.
|
void |
setMarkCalsTableCellSpanExtentChanges(boolean value)
Sets the mark-cals-table-cell-span-extent-changes feature on or off.
|
void |
setMarkCalsTableCellSpanExtentChanges(java.lang.String value) |
void |
setMarkHtmlTableCellSpanExtentChanges(boolean value)
Sets the mark-html-table-cell-span-extent-changes feature on or off.
|
void |
setMarkHtmlTableCellSpanExtentChanges(java.lang.String value) |
void |
setMathMLGranularity(MathMLGranularity value)
This parameter set the granularity of the MathML processing
|
void |
setMathMLProcessing(boolean value)
This parameter enables or disables MathML processing.
|
void |
setMediaObjectParentsList(java.lang.String value)
Sets the comma and/or space separated list of media object parents using Clark notation.
|
void |
setModifiedAttributeMode(ModifiedAttributeMode value)
Specifies how modified attributes should be included in the output.
|
void |
setOutputEncodingDeclaration(java.lang.String value)
Sets the character encoding output to use in the XML declaration.
|
void |
setOutputFormat(OutputFormat value)
Specifies what type of output is produced.
|
void |
setOutputImageRefFavourSourceDoc(OutputImageRefFavourSourceDoc value)
If
setImageCompare(boolean) is set to true and there are no differences in the A and B images, this determines which
of the source Documents, A or B, will be used to set the value of the result fileref. |
void |
setOutputImageRefForm(OutputImageRefForm value)
If
setImageCompare(boolean) is set to true this may change the form of fileref attributes of imagedata elements. |
void |
setOxygenTcsDeletedSpaceMode(OxygenTrackChangesDeletedSpaceMode value)
Specifies how deleted spaces should be handled.
|
void |
setOxygenTcsVersion(java.lang.String value)
Specifies the version of oXygen editor used to display, accept and reject the tracked changes.
|
void |
setPreservationMode(PreservationMode value)
Sets the mode to use for preserving original data.
|
void |
setRedistributionLicenseContent(long[] license)
Sets a redistribution license for use with subsequent compare operations.
|
void |
setRemoveInlineFormattingElements(java.lang.String value)
A comma and/or space separated list of inline formatting elements using Clark notation, which will be removed the list
specified in the inline-formatting-elements parameter
|
void |
setShowImageChangesAtMediaObjectLevel(boolean value)
If
setImageCompare(boolean) is set to true and determines that images have changed, show the changes as changes to
the containing mediaobject. |
void |
setShowImageChangesAtMediaObjectParentLevel(boolean value)
Sets image changes at media object parent level.
|
void |
setShowNonPhraseChanges(boolean value)
Sets whether to textually mark changes to text where <phrase>; elements are not allowed.
|
void |
setStandaloneDeclaration(StandaloneDeclaration value)
Deprecated.
|
void |
setSVGFallback(boolean value)
Sets to SVG fallback setting.
|
void |
setSVGFallbackChangePercentage(double value)
Sets fallback change percentage for SVG comparison results.
|
void |
setSVGGranularity(SVGGranularity value)
Specifies the granularity at which the differences between two SVG images will be represented.
|
void |
setSVGNumericTolerance(boolean value)
Sets whether to use a numeric tolerance.
|
void |
setSVGNumericToleranceValue(java.lang.String value)
Sets SVG numeric tolerance value for SVG comparison results.
|
void |
setSVGProcessing(boolean value)
Enables or disables SVG Comparison.
|
void |
setSVGZIndex(boolean value)
Enable Z-Index.
|
void |
setTrackedChangesAuthor(java.lang.String value)
Specifies the author name that is embedded into the generated insertion and deletion processing instruction.
|
void |
setTrackedChangesDate(java.lang.String value)
Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction.
|
void |
setUnmarkedChangeMode(UnmarkedChangeMode value)
Specifies how to handle data that cannot contain difference markup.
|
void |
setURIResolver(javax.xml.transform.URIResolver resolver,
boolean fallbackToDefaultCatalogResolver)
Sets the URIResolver to use during the comparison.
|
void |
setValidateInputs(boolean value)
Sets whether to validate input documents.
|
void |
setWarningReportMode(WarningReportMode value)
Sets the mode to use for reporting recoverable errors and warnings.
|
void |
setWhitespaceProcessingMode(WhitespaceProcessingMode value)
Specifies how to handle whitespace changes.
|
void |
setWordByWord(boolean value)
Sets whether to compare text in a more detailed way.
|
void |
setXmetalTcsTableChangeMode(XmetalTrackChangesTableChangeMode value)
Specifies how changes in tables should be tracked.
|
void |
setXmlVersionDeclaration(XmlVersionDeclaration value)
Sets the version to use in the XML declaration.
|
void |
setZIndexSVGMarkupStyle(java.lang.String value)
Sets the Z Index SVG markup style for SVG comparison results.
|
public static DocBookCompareVersion productVersion
public DocBookCompare() throws ParserException
Constructs a new DocBookCompare instance.
ParserException
- when there is a problem creating/configuring a parserpublic DocBookCompareVersion getProductVersion()
public void compare(org.xml.sax.InputSource input1, org.xml.sax.InputSource input2, javax.xml.transform.stream.StreamResult result) throws LicenseException, ParserException, SerializationException, InputLoadException, InvalidInputException, LicenseConcurrencyLimitException, FilterProcessingException, InvalidParameterException, DifferentRootElementException, com.deltaxml.cores9api.ComparisonCancelledException
Compares two InputSource inputs to produce a StreamResult.
This is the most general of the compare methods, in the sense that all the other compare methods can (and are) written in terms of it. However, care must be taken to ensure that each InputSource is provided with an appropriate systemId (say via the InputSource's setSystemId method). This system identifer is used as the base-path for locating external resources (such as those provided by xi:includes and external entity references).
Note that the presence of a system id is not checked for as there are at least two plausible use cases where it is not required. First, simple documents that are self contained (i.e. have no external resource references) do not need to set a system Id, though it can still be useful for error reporting. Second, when catalogs are being used to provide access to external resources, then relative document based lookup mechanisms may not be required (as well).
input1
- the first input to compare as a Source objectinput2
- the second input to compare as a Source objectresult
- the Result to which to write the comparison resultLicenseException
- when the license cannot be read or is not validParserException
- when there is a problem creating/configuring an XML parserSerializationException
- when there is a problem writing the result FileInputLoadException
- when there is a problem loading an input FileInvalidInputException
- if an input file is not in the correct formatFilterProcessingException
- when an error occurs running a filter in the pipelineInvalidParameterException
- if a previous parameter setting on the comparator cannot be used at comparison timeDifferentRootElementException
- if the two input Files have different rootscom.deltaxml.cores9api.ComparisonCancelledException
- if a comparison is cancelled by some cancellation policyLicenseConcurrencyLimitException
public void addDocBookCompareProgressListener(DocBookCompareProgressListener listener)
listener
- the progress listener to add.public void removeDocBookCompareProgressListener(DocBookCompareProgressListener listener)
listener
- the progress listener to remove.public void setComUsageReporter(boolean reportingFromRest, java.lang.String usageId, java.lang.String jobId, java.util.Map<java.lang.String,com.deltaxml.cores9api.common.usage.ComJobFile> inputJobFiles, com.deltaxml.cores9api.common.usage.ComUsageReporter reporter)
public org.xml.sax.EntityResolver getEntityResolver()
Gets the explicitly set EntityResolver in use by the comparison.
public org.xml.sax.EntityResolver getEntityResolver(boolean builtInResolver)
Gets the EntityResolver in use by the comparison.
builtInResolver
- Whether to get the built in resolver (with any explicit enhancement), or just the explicitly set
resolver.public void setEntityResolver(org.xml.sax.EntityResolver resolver, boolean fallbackToDefaultCatalogResolver)
Sets the EntityResolver to use during the comparison.
By default, the Apache Commons Resolver is used as an EntityResolver. If you wish to use a different one, set it up using
this method. Note you can turn off the default catalog support by providing a null
resolver and setting the
fallbackToDefaultCatalogResolver
to false
.
resolver
- The resolver to use. Using null removes an existing resolver.fallbackToDefaultCatalogResolver
- Sets whether to use the inbuilt catalog resolver if the provided resolver fails to
resolve the entity.public javax.xml.transform.URIResolver getURIResolver()
Gets the explicitly set URIResolver in use by the comparison.
public javax.xml.transform.URIResolver getURIResolver(boolean builtInResolver)
Gets the URIResolver in use by the comparison.
builtInResolver
- Whether to get the built in resolver (with any explicit enhancement), or just the explicitly set
resolver.public void setURIResolver(javax.xml.transform.URIResolver resolver, boolean fallbackToDefaultCatalogResolver)
Sets the URIResolver to use during the comparison.
By default, the Apache Commons Resolver is used as an URIResolver. If you wish to use a different one, set it up using this
method. Note you can turn off the default catalog support by providing a null
resolver and setting the
fallbackToDefaultCatalogResolver
to false
.
resolver
- The resolver to use. Using null removes an existing resolver.fallbackToDefaultCatalogResolver
- Sets whether to use the inbuilt catalog resolver if the provided resolver fails to
resolve the URI.public void compare(java.io.File input1, java.io.File input2, java.io.File result) throws LicenseException, ParserException, java.io.FileNotFoundException, SerializationException, InputLoadException, FilterProcessingException, DifferentRootElementException, InvalidInputException, InvalidParameterException, com.deltaxml.cores9api.ComparisonCancelledException
Compares two File inputs to produce a File result.
input1
- the first input to compare as a File objectinput2
- the second input to compare as a File objectresult
- the File in which to write the comparison resultLicenseException
- when the license cannot be read or is not validParserException
- when there is a problem creating/configuring an XML parserjava.io.FileNotFoundException
- when an input File or the location of the result File cannot be foundSerializationException
- when there is a problem writing the result FileInputLoadException
- when there is a problem loading an input FileFilterProcessingException
- when an error occurs running a filter in the pipelineDifferentRootElementException
- if the two input Files have different rootsInvalidInputException
- if an input file is not in the correct formatInvalidParameterException
- if a previous parameter setting on the comparator cannot be used at comparison timecom.deltaxml.cores9api.ComparisonCancelledException
- if a comparison is cancelled by some cancellation policypublic void compare(java.io.Reader r1, java.lang.String systemId1, java.io.Reader r2, java.lang.String systemId2, java.io.Writer result) throws LicenseException, ParserException, SerializationException, InputLoadException, FilterProcessingException, DifferentRootElementException, InvalidInputException, InvalidParameterException, com.deltaxml.cores9api.ComparisonCancelledException
Compares two input reader (character streams) to produce an output writer result.
r1
- the first input to comparesystemId1
- the location of the first input stream (for relative lookup)r2
- the second input to comparesystemId2
- the location of the second input stream (for relative lookup)result
- the writer in which to write the comparison resultLicenseException
- when the license cannot be read or is not validParserException
- when there is a problem creating/configuring an XML parserSerializationException
- when there is a problem writing the result FileInputLoadException
- when there is a problem loading an input FileFilterProcessingException
- when an error occurs running a filter in the pipelineDifferentRootElementException
- if the two input Files have different rootsInvalidInputException
- if an input file is not in the correct formatInvalidParameterException
- if a previous parameter setting on the comparator cannot be used at comparison timecom.deltaxml.cores9api.ComparisonCancelledException
- if a comparison is cancelled by some cancellation policypublic void compare(java.io.InputStream is1, java.lang.String systemId1, java.io.InputStream is2, java.lang.String systemId2, java.io.OutputStream result) throws LicenseException, ParserException, SerializationException, InputLoadException, FilterProcessingException, DifferentRootElementException, InvalidInputException, InvalidParameterException, com.deltaxml.cores9api.ComparisonCancelledException
Compares two input streams to produce an output stream result.
is1
- the first input to comparesystemId1
- the location of the first input stream (for relative lookup)is2
- the second input to comparesystemId2
- the location of the second input stream (for relative lookup)result
- the output stream in which to write the comparison resultLicenseException
- when the license cannot be read or is not validParserException
- when there is a problem creating/configuring an XML parserSerializationException
- when there is a problem writing the result FileInputLoadException
- when there is a problem loading an input FileFilterProcessingException
- when an error occurs running a filter in the pipelineDifferentRootElementException
- if the two input Files have different rootsInvalidInputException
- if an input file is not in the correct formatInvalidParameterException
- if a previous parameter setting on the comparator cannot be used at comparison timecom.deltaxml.cores9api.ComparisonCancelledException
- if a comparison is cancelled by some cancellation policypublic java.lang.String compare(java.lang.String input1, java.lang.String systemId1, java.lang.String input2, java.lang.String systemId2) throws LicenseException, ParserException, SerializationException, InputLoadException, FilterProcessingException, DifferentRootElementException, InvalidInputException, InvalidParameterException, com.deltaxml.cores9api.ComparisonCancelledException
Compares two XML string inputs to produce an XML string result.
input1
- the first input to compare as a string containing an XML documentsystemId1
- the location of the first input (for relative lookup)input2
- the second input to compare as a string containing an XML documentsystemId2
- the location of the second input (for relative lookup)LicenseException
- when the license cannot be read or is not validParserException
- when there is a problem creating/configuring an XML parserSerializationException
- when there is a problem writing the result FileInputLoadException
- when there is a problem loading an input FileFilterProcessingException
- when an error occurs running a filter in the pipelineDifferentRootElementException
- if the two input Files have different rootsInvalidInputException
- if an input file is not in the correct formatInvalidParameterException
- if a previous parameter setting on the comparator cannot be used at comparison timecom.deltaxml.cores9api.ComparisonCancelledException
- if a comparison is cancelled by some cancellation policypublic void setRedistributionLicenseContent(long[] license) throws LicenseException
DeltaXML Redistribution 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.
license
- a redistribution licenseLicenseException
- if there is a problem with the supplied license@Deprecated public void setLicenseFile(java.io.File licenseFile) throws java.lang.SecurityException, java.io.IOException, LicenseException
licenseFile
- the FlexLM format license fileLicenseSecurityException
- if the file cannot be accessedjava.io.IOException
- if there are problems reading the fileLicenseException
- if there is a problem using the license filejava.lang.SecurityException
@Deprecated public void setLicenseServer(java.lang.String hostname) throws LicenseException
hostname
- of the license server host or its ip addressLicenseException
- if there is a problem using the license server@Deprecated public void setLicenseServer(java.lang.String hostname, int port) throws java.lang.IllegalArgumentException, LicenseException
hostname
- of the license server host or its ip addressport
- the port number on the license server for the lmgrdjava.lang.IllegalArgumentException
- if the port number is out of rangeLicenseException
- if there is a problem using the license serverpublic void addLicenseFile(java.io.File licenseFile) throws java.lang.SecurityException, java.io.IOException, LicenseException
licenseFile
- the FlexLM format license fileLicenseSecurityException
- if the file cannot be accessedjava.io.IOException
- if there are problems reading the fileLicenseException
- if there is a problem using the license filejava.lang.SecurityException
public void addLicenseServer(java.lang.String hostname) throws LicenseException
hostname
- of the license server host or its ip addressLicenseException
- if there is a problem using the license serverpublic void addLicenseServer(java.lang.String hostname, int port) throws java.lang.IllegalArgumentException, LicenseException
hostname
- of the license server host or its ip addressport
- the port number on the license server for the lmgrdjava.lang.IllegalArgumentException
- if the port number is out of rangeLicenseException
- if there is a problem using the license serverpublic void setOutputFormat(OutputFormat value)
Specifies what type of output is produced.
Default: OutputFormat.DOCBOOK_MARKUP
value
- the value to set for the outputFormat parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setValidateInputs(boolean value)
Sets whether to validate input documents.
If set to true
and the inputs include a DOCTYPE, they will be validated against it. If they are not valid, the
compare method will throw an InputLoadException.
Default: true
value
- the value to set for the validateInputs parameterpublic void setEnableXinclude(boolean value)
Sets whether the parser will process xincludes.
If set to true
the parser will process xincludes while parsing the inputs.
Default: true
value
- the value to set for the enableXinclude parameterpublic void setWordByWord(boolean value)
Sets whether to compare text in a more detailed way.
If set to true
, text is split into individual words and so small changes can be shown with greater detail.
Default: true
value
- the value to set for the wordByWord parameterpublic void setDetectMoves(boolean value)
Sets to detect and handle element moves.
Default: false
value
- the value to set for the detectMoves parameterpublic void setImageCompare(boolean value)
Whether the actual images used will be compared rather than the string value of the location (fileref attribute) of the imagedata.
This can mean that even though the fileref has not changed the image will be marked as a change if it resolves to different
images within the context of A or B. Similarly if the fileref has changed but resolves to the same image within the context
of A or B it will not be marked as a change.
The xml:base of both input files will be used to
resolve the fileref to an absolute
location. If no xml:base is given the XPAth
base-uri() function is used. The resolved locations from A and B will then be compared for string equality. If they are
the same then the fileref will not be marked as a change, if they are different then the URIs will be opened using
URL.openStream()
and byte-wise comparison of the images will be done. If any problem occurs then the images will be
marked as changed, otherwise the result of the byte-wise comparison will be used to determine whether the image is marked as
changed.
value
- the value to set for the imageCompare parametersetShowImageChangesAtMediaObjectLevel(boolean)
,
setOutputImageRefForm(OutputImageRefForm)
,
Default: false
public void setShowImageChangesAtMediaObjectLevel(boolean value)
If setImageCompare(boolean)
is set to true and determines that images have changed, show the changes as changes to
the containing mediaobject.
By default image changes are tracked as changes to the fileref attribute of the DocBook imagedata tag. Since changes to attributes are difficult to show in docbook, it may be preferable to show the change at the level of the containing mediaobject or inlinemediaobject by cloning them and showing the A and B versions 'side by side' in the result document.
Default: false
value
- the value to set for the showImageChangesAtMediaObjectLevel parameterpublic void setOutputImageRefForm(OutputImageRefForm value)
If setImageCompare(boolean)
is set to true this may change the form of fileref attributes of imagedata elements.
If set to OutputImageRefForm#source
the value will be as it appears in the source A or B document.
If set to OutputImageRefForm#absolute
the value will be the absolute location used to calculate whether the image has
changed. This should mean that for filesystem filerefs at least the images should be visible in the result document. See
setImageCompare(boolean)
for more detail on how the absolute form is calculated.
Default: OutputImageRefForm.absolute
value
- the value to set for the outputImageRefForm parameterjava.lang.IllegalArgumentException
- if the value is null, or if setOutputImageRefForm(String)
was called with an
invalid valuepublic void setOutputImageRefFavourSourceDoc(OutputImageRefFavourSourceDoc value)
If setImageCompare(boolean)
is set to true and there are no differences in the A and B images, this determines which
of the source Documents, A or B, will be used to set the value of the result fileref. This value will then be used as is or
be turned into an absolute value depending on the value passed to setOutputImageRefForm(OutputImageRefForm)
Even if there are no differences A and B can still point to different files, so there is still a choice of the value used to
derive the result.
value
- the value to set for the outputImageRefFavourSourceDoc parameterjava.lang.IllegalArgumentException
- if the value is null, or if setOutputImageRefFavourSourceDoc(String)
was called
with an invalid value
Default: setOutputImageRefFavourSourceDoc.B
public void setIndent(IndentOutput value)
Sets whether the result should be indented.
If run with a compare method that produces a serialized result, a value of yes
causes the output to be pretty
printed.
Default: IndentOutput.NO
value
- the value to set for the indent parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setWhitespaceProcessingMode(WhitespaceProcessingMode value)
Specifies how to handle whitespace changes.
When this option is set to 'show' whitespace differences are reported where possible. If the output-format is set to 'docbook-markup' and DocBook doctype is explicitly declared, then the whitespace will be reported wherever the doctype allows text (as opposed to inter-element whitespace). In all other cases, such as when tracked-change output format is selected, all whitespace changes can be shown.
This can lead to a significant amount of marked change throughout the document. When the parameter is set to 'ignore', whitespace differences are not shown; instead the 'B' document's whitespace is kept where possible.
Note that differences in whitespace are never ignored when the XML document explicitly states that the whitespace is
important, via the xml:space
attribute being set to 'preserve'.
The 'automatic' setting effectively behaves as either 'normalize' or 'ignore' depending on the value of the 'preservation-mode' and the 'output-format' parameters. Here, 'normalize' is chosen when: (1) the lexical preservation mode is set to 'automatic' and the output format is 'docbook-markup'; or (2) the lexical preservation mode is set to either 'document' or 'docAndAttrib'. In all other cases, the automatic preservation mode is treated as if it were 'ignore'.
Default: WhitespaceProcessingMode.AUTOMATIC
value
- the value to set for the whitespaceProcessingMode parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setWarningReportMode(WarningReportMode value)
Sets the mode to use for reporting recoverable errors and warnings.
Default: WarningReportMode.PROCESSING_INSTRUCTIONS
value
- the value to set for the warningReportMode parameterjava.lang.IllegalArgumentException
- if the value is nullWarningReportMode
public void setKeyingMode(KeyingMode value)
Sets the mode to use for adding keys to the input documents.
Keys can be added to the input documents to force particular parts of the document to match up during a comparison. This method can be used to turn on keying and also gives an option of what to use as keys in the input document.
Default: KeyingMode.PRESERVE
value
- the value to set for the keyingMode parameterjava.lang.IllegalArgumentException
- if the value is nullKeyingMode
public void setShowNonPhraseChanges(boolean value)
Sets whether to textually mark changes to text where <phrase>; elements are not allowed.
If text has changed within an element where phrase markup is not allowed, some other means must be used to process the
changes. If this parameter is set to true
, the changed text is wrapped in textual delimiters e.g. -[[old text
]]- +[[new text ]]+. If the value is set to false, no markup is used and only the new text is output.
Default: "true"
value
- the value to set for the showNonPhraseChanges parameterpublic void setAdditionalPhraseContainers(java.lang.String value)
Sets the comma and/or space separated list of additional phrase elements using Clark notation.
The Clark notation represents an element by a string that has the form '{namespace}localname'. Elements in the default namespace are represented by '{}localname' (or simply 'localname' - thought this is not strictly in Clark notation).
This can be useful in situations where the DocBook has been customized to include some extra elements that contain phrase elements. Adding such elements via this parameter enables these elements to contain changes 'text changes' that are marked up using phrases.
Default: ""
value
- the value to set for the additionalPhraseContainers parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setIgnoreInlineFormatting(boolean value)
If set to true
, any changes that consist only of the addition, deletion or modification of docbook inline markup
elements are not noted as changes.
When comparing the following 2 para versions with ignore-inline-formatting switched on, no changes are marked up
<para>This is an important point</para>
<para>This is an <emphasis>important</emphasis> point</para>
see http://tdg.docbook.org/tdg/5.0/ch02.html#s.inline for a full list of inline markup elements
Default: false
value
- the value to set for the ignoreInlineFormatting parameterpublic void setInlineFormattingElements(java.lang.String value)
Sets the comma and/or space separated list of inline formatting elements using Clark notation. Only active when ignore-inline-formatting is set to true
This parameter overrides the built in list of docbook inline elements. If the parameter ignore-inline-formatting is set to true then the addition, deletion or modification of these elements will not be treated as changes.
The built in list is shown in the default, it is taken from http://tdg.docbook.org/tdg/5.0/ch02.html#s.inline and the same section for Docbook v4.5. Elements, http://tdg.docbook.org/tdg/4.5/ch02.html#ch02-logdiv
Those elements which do not contain content, such as xref and anchor are not included by default.
The Clark notation represents an element by a string that has the form '{namespace}localname'. Elements in the default namespace are represented by '{}localname' (or simply 'localname' - though this is not strictly in Clark notation). Whitespace in namespace or localname at end or beginning is removed. The occurence of '{' or '}' within namespace or localname is considered an error
Default:
"abbrev, acronym, emphasis, phrase, quote, trademark, citation, citerefentry, citetitle, firstterm, glossterm, link, olink, ulink, foreignphrase, wordasword, computeroutput, literal, markup, prompt, replaceable, sgmltag, userinput, inlineequation, mathphrase, subscript, superscript, accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycap, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut, action, classname, constant, errorcode, errorname, errortype, function, interface, msgtext, parameter, property, returnvalue, structfield, structname, symbol, token, type, varname, application, command, envar, filename, medialabel, option, systemitem, database, email, hardware, optional, {http://docbook.org/ns/docbook}abbrev, {http://docbook.org/ns/docbook}acronym, {http://docbook.org/ns/docbook}emphasis, {http://docbook.org/ns/docbook}phrase, {http://docbook.org/ns/docbook}quote, {http://docbook.org/ns/docbook}trademark, {http://docbook.org/ns/docbook}citation, {http://docbook.org/ns/docbook}citerefentry, {http://docbook.org/ns/docbook}citetitle, {http://docbook.org/ns/docbook}firstterm, {http://docbook.org/ns/docbook}glossterm, {http://docbook.org/ns/docbook}link, {http://docbook.org/ns/docbook}olink, {http://docbook.org/ns/docbook}foreignphrase, {http://docbook.org/ns/docbook}wordasword, {http://docbook.org/ns/docbook}computeroutput, {http://docbook.org/ns/docbook}literal, {http://docbook.org/ns/docbook}markup, {http://docbook.org/ns/docbook}prompt, {http://docbook.org/ns/docbook}replaceable, {http://docbook.org/ns/docbook}tag, {http://docbook.org/ns/docbook}userinput, {http://docbook.org/ns/docbook}inlineequation, {http://docbook.org/ns/docbook}mathphrase, {http://docbook.org/ns/docbook}subscript, {http://docbook.org/ns/docbook}superscript, {http://docbook.org/ns/docbook}accel, {http://docbook.org/ns/docbook}guibutton, {http://docbook.org/ns/docbook}guiicon, {http://docbook.org/ns/docbook}guilabel, {http://docbook.org/ns/docbook}guimenu, {http://docbook.org/ns/docbook}guimenuitem, {http://docbook.org/ns/docbook}guisubmenu, {http://docbook.org/ns/docbook}keycap, {http://docbook.org/ns/docbook}keycode, {http://docbook.org/ns/docbook}keycombo, {http://docbook.org/ns/docbook}keysym, {http://docbook.org/ns/docbook}menuchoice, {http://docbook.org/ns/docbook}mousebutton, {http://docbook.org/ns/docbook}shortcut, {http://docbook.org/ns/docbook}classname, {http://docbook.org/ns/docbook}constant, {http://docbook.org/ns/docbook}errorcode, {http://docbook.org/ns/docbook}errorname, {http://docbook.org/ns/docbook}errortype, {http://docbook.org/ns/docbook}function, {http://docbook.org/ns/docbook}msgtext, {http://docbook.org/ns/docbook}parameter, {http://docbook.org/ns/docbook}property, {http://docbook.org/ns/docbook}returnvalue, {http://docbook.org/ns/docbook}symbol, {http://docbook.org/ns/docbook}token, {http://docbook.org/ns/docbook}type, {http://docbook.org/ns/docbook}varname, {http://docbook.org/ns/docbook}application, {http://docbook.org/ns/docbook}command, {http://docbook.org/ns/docbook}envar, {http://docbook.org/ns/docbook}filename, {http://docbook.org/ns/docbook}option, {http://docbook.org/ns/docbook}systemitem, {http://docbook.org/ns/docbook}database, {http://docbook.org/ns/docbook}email, {http://docbook.org/ns/docbook}hardware, {http://docbook.org/ns/docbook}optional"
value
- the value to set for the inlineFormattingElements parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setMediaObjectParentsList(java.lang.String value)
Sets the comma and/or space separated list of media object parents using Clark notation. Only active when spit-media-object-parent is set to true.
This parameter defines which media object parents are allowed by DocBook documentation.
value
- the value to set for the mediaObjectParentsList parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setAddInlineFormattingElements(java.lang.String value)
A comma and/or space separated list of inline formatting elements using Clark notation, which will be added to the value of the inline-formatting-elements parameter
Use this set to add to the value of inline-formatting-elements which you wish to be ignored when considering change processing.
Elements in this set are added to the set in inline-formatting-elements, before the set in remove-inline-formatting-elements is removed.
Default: ""
value
- the value to set for the addInlineFormattingElements parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setRemoveInlineFormattingElements(java.lang.String value)
A comma and/or space separated list of inline formatting elements using Clark notation, which will be removed the list specified in the inline-formatting-elements parameter
Use this list to remove names from the value of inline-formatting-elements when the defaults include elements you wish not to be ignored as changes.
Elements in this set are removed to the set in inline-formatting-elements after the set in add-inline-formatting-elements has been added.
Default: ""
value
- the value to set for the removeInlineFormattingElements parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setCalsTableProcessing(boolean value)
Specifies whether to apply CALS table processing.
CALS table processing ensures that when valid (both syntactically and semantically according to the OASIS CALS table model documentation) input tables are provided the result will be a valid CALS table.
Simple changes to the table, such as changing the contents of an entry, adding a row or column are generally represented as fine grain changes. Because CALS entries can overlap or span multiple rows and columns, some types of change are difficult to represent at fine granularity, whilst ensuring validity. In these cases changes are represented at row (ie, groups of added/deleted rows) or even whole-table granularity.
Setting this parameter to false
turns off this processing, therefore it is possible to generate an invalid
table. However, if table validity is not a concern changes may be represented at finer granularity.
Default: true
value
- the value to set for the calsTableProcessing parameterpublic void setMarkCalsTableCellSpanExtentChanges(boolean value)
Default: false
value
- A boolean value to set this feature.public void setMarkCalsTableCellSpanExtentChanges(java.lang.String value)
public void setInvalidTableBehaviour(InvalidTableBehaviour value)
In order to ensure that only valid CALS tables are passed to our specialized CALS table processing, each input table is marked either valid or invalid. This parameter declares what type of processing should be used for those tables that are marked as invalid. The 'warning report mode' parameter configures how recoverable errors are reported.
Three options are provided: fail, propagate up, and compare as XML. The fail option stops the comparison by throwing an appropriate exception (that includes the errors identified by the validity checker). The propagate up option ensures that changes to an invalid table (or more specifically 'tgroup') are represented at the table level. The compare as XML option essentially compares the tables as if they were well-formed XML.
Note that the results of the compare as XML option can differ from comparing the tables without CALS table processing enabled, as a small amount of CALS specific processing is applied to invalid tables in order to allow them to be compared against a similar valid table.
Default: InvalidTableBehaviour.PROPAGATE_UP
value
- the value to set for the invalidTableBehaviour parameterjava.lang.IllegalArgumentException
- if the value is nullInvalidTableBehaviour
public void setHtmlTableProcessing(boolean value)
Specifies whether to apply html table or DITA simpletable processing.
HTML tables processing ensures that when valid input tables are provided - according to the HTML-4 or draft HTML-5 documentation - the result will be a valid HTML-4/5 table. Note that both inputs need to follow the same standard (ie be HTML-4 or HTML-5).
Simple changes to the table, such as changing the contents of a cell and adding a row or column are generally represented as fine grain changes. Because HTML entries can overlap or span multiple rows and columns, some types of change are difficult to represent at fine granularity, whilst ensuring validity. In these cases changes are represented at row (ie, groups of added/deleted rows) or even whole-table granularity.
DITA Simple tables are also handled by this filter. In this case, the syntactic constraints ensure that cells cannot overlap or span either rows or columns, therefore changes are represented at a fine grained level of detail.
Setting this parameter to false
turns off this processing, therefore it is possible to generate an invalid
table. However, if table validity is not a concern changes may be represented at finer granularity.
Default: true
value
- the value to set for the htmlTableProcessing parameterpublic void setMarkHtmlTableCellSpanExtentChanges(boolean value)
Default: false
value
- A boolean value to set this feature.public void setMarkHtmlTableCellSpanExtentChanges(java.lang.String value)
public void setGrouping(boolean value)
Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block. One benefit of this is that changes to a consecutive group of words within a sentence are gathered into one insertion and one deletion block, rather than a series of individual word swaps. This makes it easier to read and understand the changes.
Note that when either HTML or CALS table processing modes are selected, then this grouping mechanism is turned off within the context of these tables. The table processing has its own specialised grouping mechanisms.
Default: false
value
- the value to set for the grouping parameterpublic void setTrackedChangesAuthor(java.lang.String value)
Specifies the author name that is embedded into the generated insertion and deletion processing instruction.
Default: "deltaxml"
value
- the value to set for the trackedChangesAuthor parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setTrackedChangesDate(java.lang.String value)
Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction. The default time-stamp is that of the time that the comparison is run.
Default: "xsl date"
value
- the value to set for the trackedChangesDate parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setOxygenTcsVersion(java.lang.String value)
Specifies the version of oXygen editor used to display, accept and reject the tracked changes.
The format of the version is either '[0-9]+' or '[0-9]+.[0-9]+' without the enclosing string quotes, where: the first number sequence is the major number; and the optional second number sequence is the minor number.
This parameter is used to automatically set the relevant backwards compatibility options related to the oXygen tracked changes format. For example, prior to oXygen 14.0 release deleted whitespace needed to be normalised in order to consistently generate a reasonable result.
Default: "11.2"
value
- the value to set for the oxygenTcsVersion parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setOxygenTcsDeletedSpaceMode(OxygenTrackChangesDeletedSpaceMode value)
Specifies how deleted spaces should be handled.
Prior to oXygen 14 whitespace within the deleted content of a processing instruction were sometimes not displayed correctly. A work-around was to normalise the space within a deleted region.
Default: OxygenTrackChangesDeletedSpaceMode.AUTOMATIC
value
- the value to set for the oxygenTcsDeletedSpaceMode parameterjava.lang.IllegalArgumentException
- if the value is nullOxygenTrackChangesDeletedSpaceMode
public void setXmetalTcsTableChangeMode(XmetalTrackChangesTableChangeMode value)
Specifies how changes in tables should be tracked.
The XMetaL editor cannot track the addition or deletion of a row or cell within a table. Such changes can be pushed down to the cell level, pushed up to the table level (e.g. a CALS or HTML 'table' element), or ignored. The advantage of pushing the changes down to the cell content level, is that this provides the highest level of change granularity, at the cost of having to accept or reject every changed cell in the table independently.
The push up processing means that any table that contains a row or cell level update is represented by a table level add and delete.
The ignore option is similar to the way in which track changes within tables are handled in XMetaL; as neither row insertion and deletion or cell splitting and merging is tracked. However, for clarity this mode of operation ignores all changes within a table, it simply produces the 'B' version of the table.
Default: XmetalTrackChangesTableChangeMode.DOWN
value
- the value to set for the xmetalTcsTableChangeMode parameterjava.lang.IllegalArgumentException
- if the value is nullXmetalTrackChangesTableChangeMode
public void setFramemakerTcsTableChangeMode(FrameMakerTrackChangesTableChangeMode value)
Specifies how changes in tables should be tracked.
The FrameMaker editor cannot track the addition or deletion of a row or cell within a table. Such changes can be pushed down to the cell level, pushed up to the table level (e.g. a CALS or HTML 'table' element), or ignored. The advantage of pushing the changes down to the cell content level, is that this provides the highest level of change granularity, at the cost of having to accept or reject every changed cell in the table independently.
The push up processing means that any table that contains a row or cell level update is represented by a table level add and delete.
The ignore option is similar to the way in which track changes within tables are handled in FrameMaker; as neither row insertion and deletion or cell splitting and merging is tracked. However, for clarity this mode of operation ignores all changes within a table, it simply produces the 'B' version of the table.
Default: FrameMakerTrackChangesTableChangeMode.DOWN
value
- the value to set for the framemakerTcsTableChangeMode parameterjava.lang.IllegalArgumentException
- if the value is nullFrameMakerTrackChangesTableChangeMode
public void setPreservationMode(PreservationMode value)
Sets the mode to use for preserving original data.
This mode can be used to preserve information for round trip processing.
The 'automatic' setting will have an effective setting of 'roundTrip' when the output format is a tracked change format and 'docAndAttrib' otherwise.
Default: PreservationMode.AUTOMATIC
value
- the value to set for the preservationMode parameterjava.lang.IllegalArgumentException
- if the value is nullPreservationMode
public void setUnmarkedChangeMode(UnmarkedChangeMode value)
Specifies how to handle data that cannot contain difference markup.
Some differences between two XML documents cannot feasibly be displayed in a valid output document. These typically include changes to the XML declaration, doctype, internal subset and processing instructions. In these situations it is useful to specify what should be done.
Note that the internal subset can contain local element, attribute, and entity declarations, as well as processing instructions, comments, and entity-references.
Default: UnmarkedChangeMode.DOCUMENT_B_THEN_DECL_A
value
- the value to set for the unmarkedChangeMode parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setModifiedAttributeMode(ModifiedAttributeMode value)
Specifies how modified attributes should be included in the output.
Not all output formats allow the markup of attribute changes. When this is the case, a decision needs to be made on which version of the attribute should be present in the result file. This parameter is used to define what behaviour is required.
Default: ModifiedAttributeMode.AUTOMATIC
value
- the value to set for the modifiedAttributeMode parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setXmlVersionDeclaration(XmlVersionDeclaration value)
Sets the version to use in the XML declaration.
The 'system' special value is introduced; selecting it has the affect of choosing 'B' document's xml-version (as provided by the parser).
Default: XmlVersionDeclaration.SYSTEM
value
- the value to set for the xmlVersionDeclaration parameterjava.lang.IllegalArgumentException
- if the value is nullXmlVersionDeclaration
public void setOutputEncodingDeclaration(java.lang.String value)
Sets the character encoding output to use in the XML declaration. For example, 'UTF-8', 'ISO-8859-1', 'windows-1252', and 'ascii'. Precisely which encodings are available is dependent on the specific Java or .NET runtime environment that you use. Note that an invalid output encoding will cause an exception to be raised.
The 'system' special value is introduced; selecting it has the affect of choosing the 'B' document's character encoding.
Default: "system"
value
- the value to set for the outputEncodingDeclaration parameterjava.lang.IllegalArgumentException
- if the value is null@Deprecated public void setStandaloneDeclaration(StandaloneDeclaration value)
This parameter no longer has any effect. Preserving the standalone declaration is not supported, due to incompatibilities in the underpinning parsing and serialisation technologies.
Default: StandaloneDeclaration.OMIT
value
- the value to set for the standaloneDeclaration parameterjava.lang.IllegalArgumentException
- if the value is nullpublic void setShowImageChangesAtMediaObjectParentLevel(boolean value)
Sets image changes at media object parent level. This only works if a value for media object parent list has a matching element.
the
- value to set for the boolean parameter#setMediaObjectParentsList(MediaObjectParentsList)
public void setMathMLProcessing(boolean value)
This parameter enables or disables MathML processing. Setting this parameter to false turns off this processing, therefore it is possible to to generate an invalid output. However, if MathML validity is not a concern changes may represented at finer granularity.
Default: true
value
- public void setMathMLGranularity(MathMLGranularity value)
This parameter set the granularity of the MathML processing
Default: inline
value
- public void setSVGProcessing(boolean value)
Enables or disables SVG Comparison.
SVG comparison is recommended as it will use SVG XML-aware features when comparing two SVG images to ensure that the result can be rendered.
value
- whether to use SVG comparisonpublic void setSVGGranularity(SVGGranularity value)
Specifies the granularity at which the differences between two SVG images will be represented.
SVG Granularity can be of two types - 'detailed-adjacent' and 'adjacent'.
The 'adjacent' mode will display both SVG images side-by-side, and 'detailed-adjacent' will do the same while also adding styling to highlight individual changes.
Default: detailed-adjacent
value
- value for type of SVGGranularitypublic void setSVGFallback(boolean value)
Sets to SVG fallback setting. If enable SVG comparison granularity will fallback to SVGGranularity.ADJACENT
if SVG
change exceeds the svg-fallback-change-percentage.
value
- whether to use SVG Granularity fallbackpublic void setSVGFallbackChangePercentage(double value)
value
- a value for fallback change percentagepublic void setInputASVGMarkupStyle(java.lang.String value)
value
- the Input A SVG markup stylepublic void setInputBSVGMarkupStyle(java.lang.String value)
value
- the Input B SVG markup stylepublic void setZIndexSVGMarkupStyle(java.lang.String value)
value
- the Input B SVG markup stylepublic void setSVGZIndex(boolean value)
Enable Z-Index. SVG comparison will account for Z-Index changes and mark them up differently to standard change.
value
- whether to use in SVG comparisonpublic void setSVGNumericTolerance(boolean value)
Sets whether to use a numeric tolerance. SVG comparison will check co-ordinate values are within specified tolerance and therefore can be considered having negligible change.
value
- whether to use in SVG comparisonpublic void setSVGNumericToleranceValue(java.lang.String value)
value
- a value for numeric tolerancepublic OutputFormat getOutputFormat()
Returns the value of outputFormat
setOutputFormat(OutputFormat)
public boolean getValidateInputs()
Returns the value of validateInputs
setValidateInputs(boolean)
public boolean getEnableXinclude()
Returns the value of enableXinclude
setEnableXinclude(boolean)
public boolean getWordByWord()
Returns the value of wordByWord
setWordByWord(boolean)
public boolean getDetectMoves()
Returns the value of detectMoves
setDetectMoves(boolean)
public boolean getImageCompare()
Returns the value of imageCompare
setImageCompare(boolean)
public boolean getShowImageChangesAtMediaObjectLevel()
Returns the value of imageCompare
setImageCompare(boolean)
public boolean getShowImageChangesAtMediaObjectParentLevel()
Returns the value of split media object parent
setShowImageChangesAtMediaObjectParentLevel(boolean)
public OutputImageRefForm getOutputImageRefForm()
Returns the value of outputImageRefType
OutputImageRefForm
representing the value of outputImageRefTypesetOutputImageRefForm(com.deltaxml.docbook.OutputImageRefForm)
public OutputImageRefFavourSourceDoc getOutputImageRefFavourSourceDoc()
Returns the value of outputImageRefFavourSourceDoc
OutputImageRefFavourSourceDoc
representing the value of outputImageRefFavourSourceDocsetOutputImageRefFavourSourceDoc(com.deltaxml.docbook.OutputImageRefFavourSourceDoc)
public IndentOutput getIndent()
Returns the value of indent
setIndent(IndentOutput)
public WhitespaceProcessingMode getWhitespaceProcessingMode()
Returns the value of whitespaceProcessingMode
setWhitespaceProcessingMode(WhitespaceProcessingMode)
public WarningReportMode getWarningReportMode()
Returns the value of warningReportMode
setWarningReportMode(WarningReportMode)
public KeyingMode getKeyingMode()
Returns the value of keyingMode
setKeyingMode(KeyingMode)
public boolean getShowNonPhraseChanges()
Returns the value of showNonPhraseChanges
setShowNonPhraseChanges(boolean)
public java.lang.String getAdditionalPhraseContainers()
Returns the value of additionalPhraseContainers
setAdditionalPhraseContainers(String)
public boolean getIgnoreInlineFormatting()
Returns the value of ignoreInlineFormatting
setIgnoreInlineFormatting(boolean)
public java.lang.String getInlineFormattingElements()
Returns the value of inlineFormattingElements
setInlineFormattingElements(String)
public java.lang.String getAddInlineFormattingElements()
Returns the value of addInlineFormattingElements
setAddInlineFormattingElements(String)
public java.lang.String getRemoveInlineFormattingElements()
Returns the value of removeInlineFormattingElements
setRemoveInlineFormattingElements(String)
public boolean getCalsTableProcessing()
Returns the value of calsTableProcessing
setCalsTableProcessing(boolean)
public boolean getMarkCalsTableCellSpanExtentChanges()
public InvalidTableBehaviour getInvalidTableBehaviour()
Returns the value of invalidTableBehaviour
setInvalidTableBehaviour(InvalidTableBehaviour)
public boolean getHtmlTableProcessing()
Returns the value of htmlTableProcessing
setHtmlTableProcessing(boolean)
public boolean getMarkHtmlTableCellSpanExtentChanges()
public boolean getGrouping()
Returns the value of grouping
setGrouping(boolean)
public java.lang.String getTrackedChangesAuthor()
Returns the value of trackedChangesAuthor
setTrackedChangesAuthor(String)
public java.lang.String getTrackedChangesDate()
Returns the value of trackedChangesDate
setTrackedChangesDate(String)
public java.lang.String getOxygenTcsVersion()
Returns the value of oxygenTcsVersion
setOxygenTcsVersion(String)
public java.lang.String getMediaObjectParentsList()
Returns the value of mediaObjectParentsList
setMediaObjectParentsList(String)
public OxygenTrackChangesDeletedSpaceMode getOxygenTcsDeletedSpaceMode()
Returns the value of oxygenTcsDeletedSpaceMode
setOxygenTcsDeletedSpaceMode(OxygenTrackChangesDeletedSpaceMode)
public XmetalTrackChangesTableChangeMode getXmetalTcsTableChangeMode()
Returns the value of xmetalTcsTableChangeMode
setXmetalTcsTableChangeMode(XmetalTrackChangesTableChangeMode)
public FrameMakerTrackChangesTableChangeMode getFramemakerTcsTableChangeMode()
Returns the value of framemakerTcsTableChangeMode
setFramemakerTcsTableChangeMode(FrameMakerTrackChangesTableChangeMode)
public PreservationMode getPreservationMode()
Returns the value of preservationMode
setPreservationMode(PreservationMode)
public UnmarkedChangeMode getUnmarkedChangeMode()
Returns the value of unmarkedChangeMode
setUnmarkedChangeMode(UnmarkedChangeMode)
public ModifiedAttributeMode getModifiedAttributeMode()
Returns the value of modifiedAttributeMode
setModifiedAttributeMode(ModifiedAttributeMode)
public XmlVersionDeclaration getXmlVersionDeclaration()
Returns the value of xmlVersionDeclaration
setXmlVersionDeclaration(XmlVersionDeclaration)
public java.lang.String getOutputEncodingDeclaration()
Returns the value of outputEncodingDeclaration
setOutputEncodingDeclaration(String)
@Deprecated public StandaloneDeclaration getStandaloneDeclaration()
Returns the value of standaloneDeclaration
setStandaloneDeclaration(StandaloneDeclaration)
public boolean getMathMLProcessing()
This parameter returns true or false based on if MathML processing is enabled or not
Default: true
public MathMLGranularity getMathMLGranularity()
This parameter returns what level of granularity is being used with MathML processing
Default: inline
public boolean getSVGProcessing()
Returns current setting for SVG Processing.
public SVGGranularity getSVGGranularity()
Returns current setting for SVG Granularity.
public boolean getSVGFallback()
Returns current setting for SVG Processing Fallback.
setSVGFallback(boolean)
public double getSVGFallbackChangePercentage()
Returns current setting for SVG Fallback Change Percentage.
setSVGFallbackChangePercentage(double)
public java.lang.String getInputASVGMarkupStyle()
Returns the value of inputASVGMarkupStyle
setInputASVGMarkupStyle(String)
public java.lang.String getInputBSVGMarkupStyle()
Returns the value of inputBSVGMarkupStyle
setInputBSVGMarkupStyle(String)
public java.lang.String getZIndexSVGMarkupStyle()
Returns the value of zIndexSVGMarkupStyle
setZIndexSVGMarkupStyle(String)
public boolean getSVGZIndex()
Determines whether to use numeric tolerance.
public boolean getSVGNumericTolerance()
Determines whether to use numeric tolerance.
public java.lang.String getSVGNumericToleranceValue()
Returns the value of svg-numeric-tolerance-value
setSVGNumericToleranceValue(String)
Copyright (c) 2010-2016 DeltaXML Ltd. All Rights Reserved.