com.deltaxml.cores9api.config

Enum CalsColumnKeyingMode

java.lang.Object

java.lang.Enum<CalsColumnKeyingMode>

com.deltaxml.cores9api.config.CalsColumnKeyingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CalsColumnKeyingMode>

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.

Since:

14.0

Enum Constant Summary

Enum Constants

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.

Method Summary

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.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTO

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.

COLNAME

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.

POSITION

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.

Method Detail

values

public static CalsColumnKeyingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CalsColumnKeyingMode c : CalsColumnKeyingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CalsColumnKeyingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

The string form of each of the enumerated type constants.

Overrides:

toString in class java.lang.Enum<CalsColumnKeyingMode>

Returns:

The string form of each of the enumerated type constants.

getColumnKeyingMode

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.

Parameters:

val - a String representation of a CalsColumnKeyingMode value or null to get the default value

Returns:

the CalsColumnKeyingMode instance corresponding to the parameter, or null if the value is invalid