public class CalsTableConfiguration
extends java.lang.Object
Specifies configuration options for CALS table comparison. These configuration options can be specified on a
DocumentComparator
to configure its behaviour when comparing tables.
Constructor and Description |
---|
CalsTableConfiguration()
Constructs a new
CalsTableConfiguration instance. |
Modifier and Type | Method and Description |
---|---|
InvalidTableBehaviour |
getInvalidTableBehaviour()
Returns the current behaviour in use when inputs contain invalid CALS tables.
|
ValidationLevel |
getValidationLevel()
Returns the
ValidationLevel current in use when validating CALS tables. |
WarningReportMode |
getWarningReportMode()
Returns the
WarningReportMode in use when invalid CALS tables are encountered. |
boolean |
isProcessTables()
Determines whether CALS table processing is enabled.
|
void |
setInvalidTableBehaviour(InvalidTableBehaviour behaviour)
Sets the behaviour to use when inputs contain invalid CALS tables.
|
void |
setProcessTables(boolean value)
Sets whether the
DocumentComparator should process CALS tables. |
void |
setValidationLevel(ValidationLevel level)
Sets the
ValidationLevel to use for CALS table validation. |
void |
setWarningReportMode(WarningReportMode mode)
Specifies how CALS table invalidity warnings should be reported.
|
public CalsTableConfiguration()
CalsTableConfiguration
instance.public void setProcessTables(boolean value)
Sets whether the DocumentComparator
should process CALS tables.
CALS table processing is recommended as it will perform sophisticated processing when comparing two CALS tables to ensure that the resulting CALS table is valid.
value
- whether to use CALS table processingpublic boolean isProcessTables()
Determines whether CALS table processing is enabled.
public void setInvalidTableBehaviour(InvalidTableBehaviour behaviour)
behaviour
- an instance of InvalidTableBehaviour
specifying the behaviour to use when invalid CALS tables are
encounteredpublic InvalidTableBehaviour getInvalidTableBehaviour()
InvalidTableBehaviour
describing the behaviour in usepublic void setWarningReportMode(WarningReportMode mode)
mode
- the WarningReportMode
to use when invalid CALS tables are encounteredpublic WarningReportMode getWarningReportMode()
WarningReportMode
in use when invalid CALS tables are encountered.WarningReportMode
describing the reporting mode in usepublic void setValidationLevel(ValidationLevel level)
Sets the ValidationLevel
to use for CALS table validation.
A value of ValidationLevel.STRICT
will cause the InvalidTableBehaviour
mode to be used for any CALS
invalidity. A value of ValidationLevel.RELAXED
means that invalidities which are known to have no effect on CALS
processing will not prevent CALS processing from running. N.B. Warnings will be reported according to the
WarningReportMode
regardless of the setting used here.
level
- an instance of ValidationLevel
describing the level to usepublic ValidationLevel getValidationLevel()
Returns the ValidationLevel
current in use when validating CALS tables.
ValidationLevel
describing the level in useCopyright © 2001-2018 DeltaXML Ltd. All Rights Reserved.