public enum CalsColumnKeyingMode extends java.lang.Enum<CalsColumnKeyingMode>
Specifies the column keying mode used to match CALS columns when table processing is enabled.
Different column keying modes allow for more precise CALS table column alignment.
Enum Constant and Description |
---|
AUTO
DocumentComparator manages the entire keying process automatically.
|
COLNAME
DocumentComparator matches table columns based on colname attribute declared as a part of colspec.
|
POSITION
DocumentComparator matches table columns based on their position.
|
Modifier and Type | Method and Description |
---|---|
static CalsColumnKeyingMode |
getColumnKeyingMode(java.lang.String val)
Returns a
CalsColumnKeyingMode object based on the supplied String value. |
java.lang.String |
toString()
The string form of each of the enumerated type constants.
|
static CalsColumnKeyingMode |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static CalsColumnKeyingMode[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final CalsColumnKeyingMode AUTO
DocumentComparator manages the entire keying process automatically. If desired this mode also allows for user-defined column keys in the input files.
public static final CalsColumnKeyingMode COLNAME
DocumentComparator matches table columns based on colname attribute declared as a part of colspec. If colname for a particular column is missing this column is NOT explicitly matched with its counterpart in B version.
This mode throws an exception if user-defined keys are found in the input files.
public static final CalsColumnKeyingMode POSITION
DocumentComparator matches table columns based on their position. Indexing starts from 1 and the maximum position is defined by the number of columns described by cols attribute.
This mode throws an exception if user-defined keys are found in the input files.
public static CalsColumnKeyingMode[] values()
for (CalsColumnKeyingMode c : CalsColumnKeyingMode.values()) System.out.println(c);
public static CalsColumnKeyingMode valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String toString()
toString
in class java.lang.Enum<CalsColumnKeyingMode>
public static CalsColumnKeyingMode getColumnKeyingMode(java.lang.String val)
Returns a CalsColumnKeyingMode
object based on the supplied String value.
This method should not be used under normal circumstances, enum instance values should be used instead.
val
- a String representation of a CalsColumnKeyingMode
value or null
to get the default valueCalsColumnKeyingMode
instance corresponding to the parameter, or null if the value is invalid