Skip navigation links

com.essbase.api.dataquery
Class IEssCell.EEssCellType

java.lang.Object
com.essbase.api.dataquery.IEssCell.EEssCellType

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssCell

public static final class IEssCell.EEssCellType

extends java.lang.Object

implements IEssEnum

The EEssCellType class is an enumeration of cell types.

Version:

1.0, 09/01/00

Author:

Srini Ranga

Field Summary

static IEssCell.EEssCellType	DATA Cell type: Data.
static int	DATA_INT_VALUE Cell type (int value): Data.
static IEssCell.EEssCellType	MEMBER Cell type: Member.
static int	MEMBER_INT_VALUE Cell type (int value): Member.
static IEssCell.EEssCellType	MEMBERwKEY
static int	MEMBERwKEY_INT_VALUE Cell type (member with key): For non-unique outlines.
static IEssCell.EEssCellType	TEXT Cell type: Text (label/comment, formula etc).
static int	TEXT_INT_VALUE Cell type (int value): Text (label/comment, formula etc).

Constructor Summary

IEssCell.EEssCellType()

Method Summary

IEssEnum	fromInt(int intValue) Gets the IEssEnum from the int value.
IEssEnum	fromString(java.lang.String strValue) Gets the IEssEnum from the String display value.
int	getCountPossibleValues() Gets the count of possible values of the enumeration.
java.lang.String[]	getPossibleValues() Gets the list of possible values of the enumeration.
int	intValue() Gets the int value of the IEssEnum.
static IEssCell.EEssCellType	sm_fromInt(int intValue) Gets an enumeration object from its int value.
static IEssCell.EEssCellType	sm_fromString(java.lang.String strValue) Gets an enumeration object from its string display value.
static IEssCell.EEssCellType[]	sm_values() Gets all the enumeration objects.
java.lang.String	stringValue() Gets the String display value of the IEssEnum.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MEMBER

public static final IEssCell.EEssCellType MEMBER

Cell type: Member.

DATA

public static final IEssCell.EEssCellType DATA

Cell type: Data.

TEXT

public static final IEssCell.EEssCellType TEXT

Cell type: Text (label/comment, formula etc).

MEMBERwKEY

public static final IEssCell.EEssCellType MEMBERwKEY

MEMBER_INT_VALUE

public static final int MEMBER_INT_VALUE

Cell type (int value): Member.

See Also:

Constant Field Values

DATA_INT_VALUE

public static final int DATA_INT_VALUE

Cell type (int value): Data.

See Also:

Constant Field Values

TEXT_INT_VALUE

public static final int TEXT_INT_VALUE

Cell type (int value): Text (label/comment, formula etc).

See Also:

Constant Field Values

MEMBERwKEY_INT_VALUE

public static final int MEMBERwKEY_INT_VALUE

Cell type (member with key): For non-unique outlines.

See Also:

Constant Field Values

Constructor Detail

IEssCell.EEssCellType

public IEssCell.EEssCellType()

Method Detail

sm_fromString

public static IEssCell.EEssCellType sm_fromString(java.lang.String strValue)
                                           throws com.essbase.api.base.EssException

Gets an enumeration object from its string display value.

Parameters:

strValue - The string display value.

Returns:

The enumeration object.

Throws:

com.essbase.api.base.EssException - if an error occurs.

sm_fromInt

public static IEssCell.EEssCellType sm_fromInt(int intValue)
                                        throws com.essbase.api.base.EssException

Gets an enumeration object from its int value.

Parameters:

intValue - The int value.

Returns:

The enumeration object.

Throws:

com.essbase.api.base.EssException - if an error occurs.

sm_values

public static IEssCell.EEssCellType[] sm_values()
                                         throws com.essbase.api.base.EssException

Gets all the enumeration objects.

Returns:

The enumeration objects.

Throws:

com.essbase.api.base.EssException - if an error occurs.

stringValue

public java.lang.String stringValue()
                             throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the String display value of the IEssEnum.

Specified by:

stringValue in interface IEssEnum

Returns:

The String display value of the IEssEnum.

Throws:

EssException - if an error occurs.

intValue

public int intValue()
             throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the int value of the IEssEnum.

Specified by:

intValue in interface IEssEnum

Returns:

The int value of the IEssEnum.

Throws:

EssException - if an error occurs.

fromInt

public IEssEnum fromInt(int intValue)
                 throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the IEssEnum from the int value.

Specified by:

fromInt in interface IEssEnum

Parameters:

intValue - The int value.

Returns:

The IEssEnum interface.

Throws:

EssException - if an error occurs.

fromString

public IEssEnum fromString(java.lang.String strValue)
                    throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the IEssEnum from the String display value.

Specified by:

fromString in interface IEssEnum

Parameters:

strValue - The String display value.

Returns:

The IEssEnum interface.

Throws:

EssException - if an error occurs.

getCountPossibleValues

public int getCountPossibleValues()
                           throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the count of possible values of the enumeration.

Specified by:

getCountPossibleValues in interface IEssEnum

Returns:

The count of possible values in the enumeration.

Throws:

EssException - if an error occurs.

getPossibleValues

public java.lang.String[] getPossibleValues()
                                     throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the list of possible values of the enumeration.

Specified by:

getPossibleValues in interface IEssEnum

Returns:

The list of possible values in the enumeration.

Throws:

EssException - if an error occurs.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Skip navigation links