|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
The IEssDimension is the dimension.
| Nested Class Summary | |
static class |
IEssDimension.EEssAttributeDataType
EEssAttributeDataType class is the enumeration of attribute member or dimension data types. |
static class |
IEssDimension.EEssDimensionCategory
EEssDimensionCategory class is the dimension category. |
static class |
IEssDimension.EEssDimensionStorageCategory
EEssDimensionStorageCategory class is the Dimension storage category. |
static class |
IEssDimension.EEssDimensionStorageType
EEssDimensionStorageType class is the dimension storage type. |
static class |
IEssDimension.EEssDimensionTag
EEssDimensionTag class is the enumeration of dimension tags. |
| Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
| Field Summary | |
static int |
PROP_ACTUAL_SIZE
|
static int |
PROP_DECLARED_SIZE
|
static int |
PROP_NAME
|
static int |
PROP_NUMBER
|
static int |
PROP_TAG
|
static int |
PROP_TYPE
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
| Method Summary | |
void |
clearGenerationName(int genNum)
Clears the name of a specific generation. |
void |
clearLevelName(int levelNum)
Clears the name of a specific level. |
void |
delete(java.lang.String dataMbrName)
Delete the dimension from the outline. |
int |
getActualSize()
Gets the actual dimension size. |
IEssDimension.EEssAttributeDataType |
getAttributeDimensionDataType()
Gets the attribute dimension data type. |
IEssDimension.EEssDimensionCategory |
getCategory()
Gets the dimension category. |
int |
getDeclaredSize()
Gets the declared dimension size. |
java.lang.String |
getDescription()
Gets the dimension description. |
int |
getDimensionNumber()
Gets the dimension number. |
IEssMember |
getDimensionRootMember()
Gets the root member for this dimension. |
java.lang.String |
getGenerationName(int genNum)
Gets the generation name for the specified generation number. |
IEssIterator |
getGenerations()
Gets all the generations in this dimension. |
java.lang.String |
getLevelName(int levelNum)
Gets the level name for the specified level number. |
IEssIterator |
getLevels()
Gets all the levels in this dimension. |
java.lang.String |
getName()
Gets the dimension name. |
IEssDimension.EEssDimensionStorageType |
getStorageType()
Gets the dimension storage type. |
IEssDimension.EEssDimensionTag |
getTag()
Gets the dimension tag. |
java.lang.String[] |
getUDAs()
Gets all the User Defined Attributes (used by one or more members) in this dimension. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
setAttributeDimensionDataType(IEssDimension.EEssAttributeDataType attrDimDataType)
Gets the attribute dimension data type. |
void |
setCategory(IEssDimension.EEssDimensionCategory dimCategory)
Sets the dimension category. |
void |
setDescription(java.lang.String desc)
Sets the dimension description for standard. |
void |
setGenerationName(int genNum,
java.lang.String genName)
Sets the generation name for the specified generation number. |
void |
setLevelName(int levelNum,
java.lang.String levelName)
Sets the level name for the specified level number. |
void |
setStorageType(IEssDimension.EEssDimensionStorageType storageType)
Sets the dimension storage type. |
void |
updatePropertyValues()
Updates the property values. |
| Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
| Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
| Field Detail |
public static final int PROP_NAME
public static final int PROP_NUMBER
public static final int PROP_TYPE
public static final int PROP_TAG
public static final int PROP_DECLARED_SIZE
public static final int PROP_ACTUAL_SIZE
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
| Method Detail |
public java.lang.String getName()
throws EssException
getName in interface IEssExtendedObjectEssException - if an error occurs.
public java.lang.String getDescription()
throws EssException
EssException - if an error occurs.
public void setDescription(java.lang.String desc)
throws EssException
desc - The dimension description.
EssException - if an error occurs.
public int getDimensionNumber()
throws EssException
EssException - if an error occurs.
public IEssDimension.EEssDimensionStorageType getStorageType()
throws EssException
EssException - if an error occurs.
public void setStorageType(IEssDimension.EEssDimensionStorageType storageType)
throws EssException
EssException - if an error occurs.
public IEssDimension.EEssDimensionCategory getCategory()
throws EssException
EssException - if an error occurs.
public void setCategory(IEssDimension.EEssDimensionCategory dimCategory)
throws EssException
EssException - if an error occurs.
public IEssDimension.EEssAttributeDataType getAttributeDimensionDataType()
throws EssException
EssException - if an error occurs.
public void setAttributeDimensionDataType(IEssDimension.EEssAttributeDataType attrDimDataType)
throws EssException
attrDimDataType - The attribute dimension data type.
EssException - if an error occurs.
public IEssDimension.EEssDimensionTag getTag()
throws EssException
EssException - if an error occurs.
public int getDeclaredSize()
throws EssException
EssException - if an error occurs.
public int getActualSize()
throws EssException
EssException - if an error occurs.
public void refreshPropertyValues()
throws EssException
refreshPropertyValues in interface IEssPropertiesEssException - if an error occurs.
public void updatePropertyValues()
throws EssException
updatePropertyValues in interface IEssPropertiesEssException - if an error occurs.
public void delete(java.lang.String dataMbrName)
throws EssException
dataMbrName - The member name in the dimension to be deleted from
which data will be saved when the outline is restructured. If this field
is null, the dimension is used.
EssException - if an error occurs.
public java.lang.String getGenerationName(int genNum)
throws EssException
genNum - The number of the generation for which to get a name. The
dimension itself is generation 1.
EssException - if an error occurs.
public void setGenerationName(int genNum,
java.lang.String genName)
throws EssException
genNum - The number of the generation for which to set a name.
The dimension itself is generation 1.genName - The name to give the generation.
EssException - if an error occurs.
public void clearGenerationName(int genNum)
throws EssException
genNum - The number of the generation for which to delete name.
EssException - if an error occurs.
public IEssIterator getGenerations()
throws EssException
EssException - if an error occurs.
public java.lang.String getLevelName(int levelNum)
throws EssException
levelNum - The number of the level for which to get a name. The leaf
members are level 0.
EssException - if an error occurs.
public void setLevelName(int levelNum,
java.lang.String levelName)
throws EssException
levelNum - The number of the level for which to set a name. The
leaf members are level 0.levelName - The name to give the level.
EssException - if an error occurs.
public void clearLevelName(int levelNum)
throws EssException
levelNum - The number of the level for which to delete name.
EssException - if an error occurs.
public IEssIterator getLevels()
throws EssException
EssException - if an error occurs.
public java.lang.String[] getUDAs()
throws EssException
EssException - if an error occurs.
public IEssMember getDimensionRootMember()
throws EssException
EssException - if an error occurs.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||