com.essbase.api.metadata

Interface IEssDimension

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssDimension
extends IEssExtendedObject, IEssProperties

The IEssDimension is the dimension.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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/interfaces inherited from interface com.essbase.api.base.IEssProperties

IEssProperties.EEssPropertyMode

Field Summary

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
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	getAssociatedBaseDimension() Gets the associated base dimension for this attribute dimension.
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.
boolean	getDimensionNameUniqueness() Returns if the Dimension Uniqueness is enabled or disabled.
int	getDimensionNumber() Gets the dimension number.
IEssMember	getDimensionRootMember() Gets the root member for this dimension.
IEssDimension.EEssDimensionStorageCategory	getDimensionStorageCategory() Gets the dimension storage category.
IEssGeneration	getGeneration(int genNum) Gets the generation for the specified generation number.
java.lang.String	getGenerationName(int genNum) Gets the generation name for the specified generation number.
IEssIterator	getGenerations() Gets all the generations in this dimension.
IEssLevel	getLevel(int levelNum) Gets the level for the specified level number.
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.
IEssMember	getRenegadeMember() Returns the Renegade member of this dimension.
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.
boolean	setDataMember(IEssMember iEssMember) Associate a member name to retain data.
void	setDescription(java.lang.String desc) Sets the dimension description for standard.
void	setDimensionNameUniqueness(boolean enableUnique) If uniqueness is enabled for this Dimension, then, any member referred through this Dimension cannot have duplicate member names.
void	setDimensionStorageCategory(IEssDimension.EEssDimensionStorageCategory dimStorageCategory) Sets the dimension storage category.
void	setGenerationName(int genNum, java.lang.String genName) Sets the generation name for the specified generation number.
void	setGenerationName(int genNum, java.lang.String genName, boolean enableUniqName) 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	setLevelName(int levelNum, java.lang.String levelName, boolean enableUniqName) Sets the level name for the specified level number.
void	setRenegadeMember(IEssMember rengMbr) Tags the specified member of this dimension as a Renegade member.
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

PROP_NAME

static final int PROP_NAME

See Also:

Constant Field Values

PROP_NUMBER

static final int PROP_NUMBER

See Also:

Constant Field Values

PROP_TYPE

static final int PROP_TYPE

See Also:

Constant Field Values

PROP_TAG

static final int PROP_TAG

See Also:

Constant Field Values

PROP_DECLARED_SIZE

static final int PROP_DECLARED_SIZE

See Also:

Constant Field Values

PROP_ACTUAL_SIZE

static final int PROP_ACTUAL_SIZE

See Also:

Constant Field Values

s_countProperties

static final int s_countProperties

See Also:

Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

Method Detail

getName

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

Gets the dimension name.

Specified by:

getName in interface IEssExtendedObject

Returns:

The dimension name.

Throws:

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

getDescription

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

Gets the dimension description. This method will not work if the IEssDimension object is obtainded through IEssCube interface. This method is effective only for standard/base dimension. For attribute dimension, this method always returns "";

Returns:

The dimension description.

Throws:

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

setDescription

void setDescription(java.lang.String desc)
             throws com.essbase.api.base.EssException

Sets the dimension description for standard. This method is effective only for standard/base dimension, and has no effect for the attribute dimension. The change will become effective after you invoke updatePropertyValues().

Parameters:

desc - The dimension description.

Throws:

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

getDimensionNumber

int getDimensionNumber()
                throws com.essbase.api.base.EssException

Gets the dimension number.

Returns:

The dimension number.

Throws:

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

getStorageType

IEssDimension.EEssDimensionStorageType getStorageType()
                                               throws com.essbase.api.base.EssException

Gets the dimension storage type.

Returns:

The dimension storage type.

Throws:

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

setStorageType

void setStorageType(IEssDimension.EEssDimensionStorageType storageType)
             throws com.essbase.api.base.EssException

Sets the dimension storage type. The change will become effective after you invoke updatePropertyValues().

Parameters:

storageType - The dimension storage type.

Throws:

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

getCategory

IEssDimension.EEssDimensionCategory getCategory()
                                         throws com.essbase.api.base.EssException

Gets the dimension category.

Returns:

The dimension category.

Throws:

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

setCategory

void setCategory(IEssDimension.EEssDimensionCategory dimCategory)
          throws com.essbase.api.base.EssException

Sets the dimension category. The change will become effective after you invoke updatePropertyValues().

Parameters:

dimCategory - The dimension category.

Throws:

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

getDimensionStorageCategory

IEssDimension.EEssDimensionStorageCategory getDimensionStorageCategory()
                                                                throws com.essbase.api.base.EssException

Gets the dimension storage category.

Returns:

IEssDimension.EEssDimensionStorageCategory The dimension storage category

Throws:

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

setDimensionStorageCategory

void setDimensionStorageCategory(IEssDimension.EEssDimensionStorageCategory dimStorageCategory)
                          throws com.essbase.api.base.EssException

Sets the dimension storage category. The change will become effective after you invoke updatePropertyValues().

Parameters:

dimStorageCategory - The dimension storage category from IEssDimension.EEssDimensionStorageCategory

Throws:

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

getAttributeDimensionDataType

IEssDimension.EEssAttributeDataType getAttributeDimensionDataType()
                                                           throws com.essbase.api.base.EssException

Gets the attribute dimension data type. This method is to be used only for attribute dimension (i.e for EEssDimensionCategory == ATTRIBUTE).

Returns:

The attribute dimension data type.

Throws:

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

setAttributeDimensionDataType

void setAttributeDimensionDataType(IEssDimension.EEssAttributeDataType attrDimDataType)
                            throws com.essbase.api.base.EssException

Gets the attribute dimension data type. This method is to be used only for attribute dimension (i.e for EEssDimensionCategory == ATTRIBUTE). The change will become effective after you invoke updatePropertyValues().

Parameters:

attrDimDataType - The attribute dimension data type.

Throws:

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

getTag

IEssDimension.EEssDimensionTag getTag()
                               throws com.essbase.api.base.EssException

Gets the dimension tag.

Returns:

The dimension tag.

Throws:

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

getDeclaredSize

int getDeclaredSize()
             throws com.essbase.api.base.EssException

Gets the declared dimension size.

Returns:

The declared dimension size.

Throws:

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

getActualSize

int getActualSize()
           throws com.essbase.api.base.EssException

Gets the actual dimension size.

Returns:

The actual dimension size.

Throws:

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

refreshPropertyValues

void refreshPropertyValues()
                    throws com.essbase.api.base.EssException

Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.

Specified by:

refreshPropertyValues in interface IEssProperties

Throws:

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

updatePropertyValues

void updatePropertyValues()
                   throws com.essbase.api.base.EssException

Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues().

Specified by:

updatePropertyValues in interface IEssProperties

Throws:

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

delete

void delete(java.lang.String dataMbrName)
     throws com.essbase.api.base.EssException

Delete the dimension from the outline. The method also specifies a member of the dimension being deleted from which to keep data when the outline is restructured.

Parameters:

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.

Throws:

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

getGenerationName

java.lang.String getGenerationName(int genNum)
                            throws com.essbase.api.base.EssException

Gets the generation name for the specified generation number.

Parameters:

genNum - The number of the generation for which to get a name. The dimension itself is generation 1.

Returns:

The generation name.

Throws:

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

setGenerationName

void setGenerationName(int genNum,
                       java.lang.String genName)
                throws com.essbase.api.base.EssException

Sets the generation name for the specified generation number.

Parameters:

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.

Throws:

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

clearGenerationName

void clearGenerationName(int genNum)
                  throws com.essbase.api.base.EssException

Clears the name of a specific generation.

Parameters:

genNum - The number of the generation for which to delete name.

Throws:

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

getGenerations

IEssIterator getGenerations()
                     throws com.essbase.api.base.EssException

Gets all the generations in this dimension.

Returns:

The generations.

Throws:

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

getLevelName

java.lang.String getLevelName(int levelNum)
                       throws com.essbase.api.base.EssException

Gets the level name for the specified level number.

Parameters:

levelNum - The number of the level for which to get a name. The leaf members are level 0.

Returns:

The level name.

Throws:

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

setLevelName

void setLevelName(int levelNum,
                  java.lang.String levelName)
           throws com.essbase.api.base.EssException

Sets the level name for the specified level number.

Parameters:

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.

Throws:

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

clearLevelName

void clearLevelName(int levelNum)
             throws com.essbase.api.base.EssException

Clears the name of a specific level.

Parameters:

levelNum - The number of the level for which to delete name.

Throws:

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

getLevels

IEssIterator getLevels()
                throws com.essbase.api.base.EssException

Gets all the levels in this dimension.

Returns:

The levels.

Throws:

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

getUDAs

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

Gets all the User Defined Attributes (used by one or more members) in this dimension. NOTE: This method will work only if this dimension object is obtained via IEssCube.openOutline(), and will not work if this dimension object is obtained via IEssCube.openMemberSelection().

Returns:

The User Defined Attributes. null if there are no attributes.

Throws:

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

getDimensionRootMember

IEssMember getDimensionRootMember()
                           throws com.essbase.api.base.EssException

Gets the root member for this dimension.

Returns:

The dimension root member.

Throws:

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

setDimensionNameUniqueness

void setDimensionNameUniqueness(boolean enableUnique)
                         throws com.essbase.api.base.EssException

If uniqueness is enabled for this Dimension, then, any member referred through this Dimension cannot have duplicate member names.

Parameters:

enableUnique - Enable or Disable Uniqueness

Throws:

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

getDimensionNameUniqueness

boolean getDimensionNameUniqueness()
                            throws com.essbase.api.base.EssException

Returns if the Dimension Uniqueness is enabled or disabled.

Returns:

true if the Dimension cannot have duplicate member names.

Throws:

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

setGenerationName

void setGenerationName(int genNum,
                       java.lang.String genName,
                       boolean enableUniqName)
                throws com.essbase.api.base.EssException

Sets the generation name for the specified generation number.

Parameters:

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.

enableUniqName - If true, members at genNum in this Dimension cannot have duplicate names.

Throws:

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

getGeneration

IEssGeneration getGeneration(int genNum)
                      throws com.essbase.api.base.EssException

Gets the generation for the specified generation number.

Parameters:

genNum - The number of the generation for which to get a name. The dimension itself is generation 1.

Returns:

Generation information.

Throws:

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

setLevelName

void setLevelName(int levelNum,
                  java.lang.String levelName,
                  boolean enableUniqName)
           throws com.essbase.api.base.EssException

Sets the level name for the specified level number.

Parameters:

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.

enableUniqName - If true, members at levelNum in this Dimension cannot have duplicate names.

Throws:

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

getLevel

IEssLevel getLevel(int levelNum)
            throws com.essbase.api.base.EssException

Gets the level for the specified level number.

Parameters:

levelNum - The number of the level for which to set a name. The leaf members are level 0.

Returns:

level information.

Throws:

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

setRenegadeMember

void setRenegadeMember(IEssMember rengMbr)
                throws com.essbase.api.base.EssException

Tags the specified member of this dimension as a Renegade member. Currently this is supported only for ASO type of outlines. This API is supported only in the Outline Editing mode.

Parameters:

rengMbr - Level-0 Member of this dimension that can be made a renegade member. If pass NULL, then unset the renegade member

Throws:

com.essbase.api.base.EssException - if the member name is invalid or there is a failure to set the association.

getRenegadeMember

IEssMember getRenegadeMember()
                      throws com.essbase.api.base.EssException

Returns the Renegade member of this dimension. If there is no member in this dimension, tagged as a renegade member, then, returns null. Currently this is applicable for ASO type of outlines only and it is supported in the Outline Editing mode only.

Returns:

renegade member object.

Throws:

com.essbase.api.base.EssException - failure to get the Renegade Member from Essbase.

getAssociatedBaseDimension

IEssDimension getAssociatedBaseDimension()
                                  throws com.essbase.api.base.EssException

Gets the associated base dimension for this attribute dimension.

Returns:

Associated base dimension for this attribute dimension. null will be returned if this attribute dimension is not associated with any base dimension.

Throws:

com.essbase.api.base.EssException - If an exception occurs.

setDataMember

boolean setDataMember(IEssMember iEssMember)
               throws com.essbase.api.base.EssException

Associate a member name to retain data. This function will only work on a new dimension before restructuring the dimension.

Parameters:

iEssMember - IEssMember to retain data with

Returns:

boolean -TRUE : Data member association succeeded. -FALSE : Data member association failed.

Throws:

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