com.github.jferard.fastods.attribute

Enum FieldOrientation

java.lang.Object

java.lang.Enum<FieldOrientation>

com.github.jferard.fastods.attribute.FieldOrientation

All Implemented Interfaces:

AttributeValue, Serializable, Comparable<FieldOrientation>

public enum FieldOrientation
extends Enum<FieldOrientation>
implements AttributeValue

19.686.2 table:data-pilot-field

Author:

J. Férard

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLUMN field specifies a category column
DATA field specifies a data column
HIDDEN field has a corresponding column in a data pilot's source but are not visible in the data pilot table.
PAGE specifies that an automatic filter (one that allows to choose one of the values that are contained in the column) should be generated for the corresponding column.
ROW specifies a category row

Method Summary

Modifier and Type	Method and Description
CharSequence	getValue()
String	toString()
static FieldOrientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldOrientation[]	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

COLUMN

public static final FieldOrientation COLUMN

field specifies a category column

DATA

public static final FieldOrientation DATA

field specifies a data column

HIDDEN

public static final FieldOrientation HIDDEN

field has a corresponding column in a data pilot's source but are not visible in the data pilot table.

PAGE

public static final FieldOrientation PAGE

specifies that an automatic filter (one that allows to choose one of the values that are contained in the column) should be generated for the corresponding column. In that case, an additional field with row, column or data orientation shall exist for the column. The table:selected-page attribute specifies which value is selected for the filter.

ROW

public static final FieldOrientation ROW

specifies a category row

Method Detail

values

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

Returns:

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

valueOf

public static FieldOrientation 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

toString

public String toString()

Overrides:

toString in class Enum<FieldOrientation>

getValue

public CharSequence getValue()

Specified by:

getValue in interface AttributeValue

Returns:

the string representation of the attribute