Package com.appliedolap.essbase

Enum Class EssMember.DimensionType

java.lang.Object

java.lang.Enum<EssMember.DimensionType>

com.appliedolap.essbase.EssMember.DimensionType

All Implemented Interfaces:

Serializable, Comparable<EssMember.DimensionType>, Constable

Enclosing interface:

EssMember

public static enum EssMember.DimensionType
extends Enum<EssMember.DimensionType>

The role a dimension plays in the outline. The server names it only on the dimension's own row, and only when it is something other than ordinary.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCOUNTS
ATTRIBUTE
ATTRIBUTE_CALC
COUNTRY
CURRENCY_PARTITION
NONE	An ordinary dimension, and what an absent value means.
TIME
UNKNOWN	A type this version of the client doesn't name; the raw value is in EssMember.getProperties().

Method Summary

Modifier and Type	Method	Description
String	getLabel()	The type as Essbase's own tools write it, or null for NONE, which has nothing to say.
static EssMember.DimensionType	parse(String text)
static EssMember.DimensionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EssMember.DimensionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final EssMember.DimensionType NONE

An ordinary dimension, and what an absent value means.

TIME

public static final EssMember.DimensionType TIME

ACCOUNTS

public static final EssMember.DimensionType ACCOUNTS

ATTRIBUTE

public static final EssMember.DimensionType ATTRIBUTE

ATTRIBUTE_CALC

public static final EssMember.DimensionType ATTRIBUTE_CALC

COUNTRY

public static final EssMember.DimensionType COUNTRY

CURRENCY_PARTITION

public static final EssMember.DimensionType CURRENCY_PARTITION

UNKNOWN

public static final EssMember.DimensionType UNKNOWN

A type this version of the client doesn't name; the raw value is in EssMember.getProperties().

Method Details

values

public static EssMember.DimensionType[] 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 EssMember.DimensionType 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

getLabel

public String getLabel()

The type as Essbase's own tools write it, or null for NONE, which has nothing to say.

Returns:

the display name, or null

parse

public static EssMember.DimensionType parse(String text)

Parameters:

text - the value from the outline, or null for an absent one

Returns:

the type it names, NONE for null, UNKNOWN for anything unrecognized