Package com.deltaxml.mergecommon.config

Enum Class InvalidTableBehaviour

java.lang.Object
java.lang.Enum<InvalidTableBehaviour>
com.deltaxml.mergecommon.config.InvalidTableBehaviour
All Implemented Interfaces:
Serializable, Comparable<InvalidTableBehaviour>, Constable
public enum InvalidTableBehaviour extends Enum<InvalidTableBehaviour>

Specifies the behavior to use when inputs contain invalid tables.

Some of the processing used for table comparison makes the assumption that the tables conform to the specification. In order to avoid errors in this processing, the tables are first validated to ensure that it will work as expected. When tables are not valid, there are several options for the behavior that the comparison should take. This enum is used to specify the options.

Since:
8.0

  • Enum Constant Details

    • FAIL

      public static final InvalidTableBehaviour FAIL
      Throw an Exception when invalid tables are encountered. The Exception will be a FilterProcessingException with an underlying cause of XPathException.

    • PROPAGATE_UP

      public static final InvalidTableBehaviour PROPAGATE_UP
      Propagate the changes to the <tgroup> or <table> level of the CALS or HTML table respectively. For example, rather than comparing the tables, each <tgroup> version will be output in the form 
       <table deltaxml:deltaV2='A!=B=C!=D'>
   <tgroup deltaxml:deltaV2='A'>
     ...
   </tgroup>
    <tgroup deltaxml:deltaV2='B'>
     ...
   </tgroup>
 </table>

    • COMPARE_AS_XML

      public static final InvalidTableBehaviour COMPARE_AS_XML

      Compare tables as 'plain' XML. Rather than using the tailored table processing, compare the tables as XML.

      WARNING: This may lead to table results that cannot be rendered successfully.

      Please note that new table processing algorithm currently do not support InvalidTableBehaviour.COMPARE_AS_XML. An exception will be thrown if this setting is used with new table processing.

  • Method Details

    • values

      public static InvalidTableBehaviour[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static InvalidTableBehaviour valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      The camel case string form of each of the enumerated type constants. Here, the string for an enumeration constant of the form 'FIRST_SECOND_THIRD' is 'firstSecondThird'.
      Overrides:
      toString in class Enum<InvalidTableBehaviour>
      Returns:
      The camel case string form of each of the enumerated type constants.

    • getInvalidTableBehaviour

      public static InvalidTableBehaviour getInvalidTableBehaviour(String val)

      Returns a InvalidTableBehaviour object base on the supplied String value.

      This method should not be used under normal circumstances, enum instance values should be used instead.

      Parameters:
      val - a String representation of a InvalidTableBehaviour value or null to get the default value
      Returns:
      the InvalidTableBehaviour instance corresponding to the parameter, or null if the value is invalid