Package com.deltaxml.core.config

Class CalsTableConfiguration

java.lang.Object
com.deltaxml.core.config.CalsTableConfiguration
public class CalsTableConfiguration extends Object

Specifies configuration options for CALS table comparison. These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing tables.

Since:
10.2

  • Constructor Details

  • Method Details

    • setProcessTables

      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.

      Parameters:
      value - whether to use CALS table processing

    • isProcessTables

      public boolean isProcessTables()

      Determines whether CALS table processing is enabled.

      Returns:
      a boolean describing the enabled state of CALS table processing

    • setInvalidTableBehaviour

      public void setInvalidTableBehaviour(InvalidTableBehaviour behaviour)
      Sets the behaviour to use when inputs contain invalid CALS tables.
      Parameters:
      behaviour - an instance of InvalidTableBehaviour specifying the behaviour to use when invalid CALS tables are encountered

    • getInvalidTableBehaviour

      public InvalidTableBehaviour getInvalidTableBehaviour()
      Returns the current behaviour in use when inputs contain invalid CALS tables.
      Returns:
      an instance of InvalidTableBehaviour describing the behaviour in use

    • setWarningReportMode

      public void setWarningReportMode(WarningReportMode mode)
      Specifies how CALS table invalidity warnings should be reported.
      Parameters:
      mode - the WarningReportMode to use when invalid CALS tables are encountered

    • getWarningReportMode

      public WarningReportMode getWarningReportMode()
      Returns the WarningReportMode in use when invalid CALS tables are encountered.
      Returns:
      an instance of WarningReportMode describing the reporting mode in use

    • setValidationLevel

      public 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.

      Parameters:
      level - an instance of ValidationLevel describing the level to use

    • getValidationLevel

      public ValidationLevel getValidationLevel()

      Returns the ValidationLevel current in use when validating CALS tables.

      Returns:
      an instance of ValidationLevel describing the level in use

    • setIgnoreColumnOrder

      public void setIgnoreColumnOrder(boolean ignoreColumnOrder)

      Sets whether the DocumentComparator should ignore CALS table column order.

      Parameters:
      ignoreColumnOrder - whether to ignore CALS table column order

    • isIgnoreColumnOrder

      public boolean isIgnoreColumnOrder()

      Determines whether ignoring CALS table column order is enabled.

      Returns:
      a boolean describing whether the CALS table column order is ignored

    • setCalsColumnKeyingMode

      public void setCalsColumnKeyingMode(CalsColumnKeyingMode mode)

      Sets the CalsColumnKeyingMode to use when comparing CALS tables.

      Parameters:
      mode - an instance of CalsColumnKeyingMode describing the keying mode to use

    • getCalsColumnKeyingMode

      public CalsColumnKeyingMode getCalsColumnKeyingMode()

      Returns the CalsColumnKeyingMode currently in use when comparing CALS tables.

      Returns:
      an instance of CalsColumnKeyingMode describing the keying mode in use

    • setMarkTableCellSpanExtentChanges

      public void setMarkTableCellSpanExtentChanges(boolean value)
      Sets the markTableCellSpanExtentChanges feature on or off. When set, a deltaxml:span-extent-changed attribute is added to table cell elements that have changed spans.
      Parameters:
      value - A boolean value to set this feature.

    • isMarkTableCellSpanExtentChanges

      public boolean isMarkTableCellSpanExtentChanges()
      Returns true if markTableCellSpanExtentChanges feature is on, otherwise false.
      Returns:
      the current setting for markTableCellSpanExtentChanges.