Package adams.flow.transformer

Enum SpreadSheetInfo.InfoType

java.lang.Object

java.lang.Enum<SpreadSheetInfo.InfoType>

adams.flow.transformer.SpreadSheetInfo.InfoType

All Implemented Interfaces:

EnumWithCustomDisplay<SpreadSheetInfo.InfoType>, EnumWithCustomParsing<SpreadSheetInfo.InfoType>, Serializable, Comparable<SpreadSheetInfo.InfoType>

Enclosing class:

SpreadSheetInfo

public static enum SpreadSheetInfo.InfoType
extends Enum<SpreadSheetInfo.InfoType>
implements EnumWithCustomDisplay<SpreadSheetInfo.InfoType>

The type of information to generate.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
CELL_TYPES	all cell types (at specified index).
CELL_VALUES	all (unique) cell values (at specified index).
COLUMN_NAME	the name of the column (at specified index).
COLUMN_NAMES	all column names.
COLUMN_TYPE	the overall column type (at specified index).
COLUMN_VALUES	values in specified column as they appear (unsorted, non-unique).
COMMENTS	the comments.
FIELD_SPEC	field (at specified index).
FIELD_SPECS	fields (all).
FIELD_TYPE	field type (at specified index).
FIELD_TYPES	field types (all).
LOCALE	the locale (eg en_NZ).
NAME	the name.
NUM_COLUMNS	the number of columns.
NUM_ROWS	the number of rows.
SHEET_VALUES	all (unique) cell values.
TIMEZONE	the timezone (eg Pacific/Auckland).

Method Summary

Modifier and Type	Method	Description
SpreadSheetInfo.InfoType	parse(String s)	Parses the given string and returns the associated enum.
String	toDisplay()	Returns the display string.
String	toRaw()	Returns the raw enum string.
String	toString()	Returns the display string.
static SpreadSheetInfo.InfoType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpreadSheetInfo.InfoType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NAME

public static final SpreadSheetInfo.InfoType NAME

the name.

COMMENTS

public static final SpreadSheetInfo.InfoType COMMENTS

the comments.

TIMEZONE

public static final SpreadSheetInfo.InfoType TIMEZONE

the timezone (eg Pacific/Auckland).

LOCALE

public static final SpreadSheetInfo.InfoType LOCALE

the locale (eg en_NZ).

NUM_COLUMNS

public static final SpreadSheetInfo.InfoType NUM_COLUMNS

the number of columns.

NUM_ROWS

public static final SpreadSheetInfo.InfoType NUM_ROWS

the number of rows.

COLUMN_NAME

public static final SpreadSheetInfo.InfoType COLUMN_NAME

the name of the column (at specified index).

COLUMN_NAMES

public static final SpreadSheetInfo.InfoType COLUMN_NAMES

all column names.

COLUMN_TYPE

public static final SpreadSheetInfo.InfoType COLUMN_TYPE

the overall column type (at specified index).

CELL_TYPES

public static final SpreadSheetInfo.InfoType CELL_TYPES

all cell types (at specified index).

CELL_VALUES

public static final SpreadSheetInfo.InfoType CELL_VALUES

all (unique) cell values (at specified index).

COLUMN_VALUES

public static final SpreadSheetInfo.InfoType COLUMN_VALUES

values in specified column as they appear (unsorted, non-unique).

SHEET_VALUES

public static final SpreadSheetInfo.InfoType SHEET_VALUES

all (unique) cell values.

FIELD_SPEC

public static final SpreadSheetInfo.InfoType FIELD_SPEC

field (at specified index).

FIELD_SPECS

public static final SpreadSheetInfo.InfoType FIELD_SPECS

fields (all).

FIELD_TYPE

public static final SpreadSheetInfo.InfoType FIELD_TYPE

field type (at specified index).

FIELD_TYPES

public static final SpreadSheetInfo.InfoType FIELD_TYPES

field types (all).

Method Detail

values

public static SpreadSheetInfo.InfoType[] 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 (SpreadSheetInfo.InfoType c : SpreadSheetInfo.InfoType.values())
    System.out.println(c);

Returns:

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

valueOf

public static SpreadSheetInfo.InfoType valueOf(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:

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

NullPointerException - if the argument is null

toDisplay

public String toDisplay()

Returns the display string.

Specified by:

toDisplay in interface EnumWithCustomDisplay<SpreadSheetInfo.InfoType>

Returns:

the display string

toRaw

public String toRaw()

Returns the raw enum string.

Specified by:

toRaw in interface EnumWithCustomDisplay<SpreadSheetInfo.InfoType>

Returns:

the raw enum string

toString

public String toString()

Returns the display string.

Overrides:

toString in class Enum<SpreadSheetInfo.InfoType>

Returns:

the display string

parse

public SpreadSheetInfo.InfoType parse(String s)

Parses the given string and returns the associated enum.

Specified by:

parse in interface EnumWithCustomParsing<SpreadSheetInfo.InfoType>

Parameters:

s - the string to parse

Returns:

the enum or null if not found