com.essbase.api.metadata
Interface IEssMemberSelection

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssMemberSelection

extends IEssExtendedObject, IEssProperties

The IEssMemberSelection interface.

Nested Class Summary

Nested classes inherited from class com.essbase.api.base.IEssProperties

IEssProperties.EEssPropertyMode

Field Summary

static int	QUERY_OPTION_ALIASESONLY
static int	QUERY_OPTION_COUNTONLY
static int	QUERY_OPTION_EXCLUDEHYBRIDANALYSIS
static int	QUERY_OPTION_FORCECASESENSITIVE
static int	QUERY_OPTION_FORCEIGNORECASE
static int	QUERY_OPTION_INCLUDEHYBRIDANALYSIS
static int	QUERY_OPTION_MEMBERSANDALIASES
static int	QUERY_OPTION_MEMBERSONLY Query options.
static int	QUERY_OPTION_NOTOTALCOUNTS
static int	QUERY_OPTION_UNIQUENAME
static int	QUERY_OPTION_USESUBSTITUTIONVAR
static int	QUERY_TIDIM_TIMEPERIODS Query ID related to Time Dimension for fetching time periods list
static int	QUERY_TYPE_ANCESTORS
static int	QUERY_TYPE_BOTTOMLEVEL
static int	QUERY_TYPE_CHILDREN Query types.
static int	QUERY_TYPE_DESCENDANTS
static int	QUERY_TYPE_DIMENSION
static int	QUERY_TYPE_DIMUSERATTRIBUTES
static int	QUERY_TYPE_DTSMEMBERS
static int	QUERY_TYPE_INDEPDIMS
static int	QUERY_TYPE_NAMEDGENERATION
static int	QUERY_TYPE_NAMEDLEVEL
static int	QUERY_TYPE_PARENT
static int	QUERY_TYPE_SAMEGENERATION
static int	QUERY_TYPE_SAMELEVEL
static int	QUERY_TYPE_SEARCH
static int	QUERY_TYPE_SIBLINGS
static int	QUERY_TYPE_USERATTRIBUTE
static int	QUERY_TYPE_WILDSEARCH

Method Summary

void	close() Closes the member selection.
void	executeQuery(java.lang.String memberName) Executes member selection query to fetch specified member.
void	executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) Executes the member selection query.
void	executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2, int startMemberIndex, int maxMemberCount) Executes the member selection query.
void	executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection) Executes the member selection query.
void	executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection, int maxMemberCount) Executes the member selection query.
java.lang.String[]	getAliasTableNames() Gets the names of alias tables existing in the outline.
int	getBucketingType() Gets the numeric attribute's bucketing type.
int	getCountAliasTables() Gets the count of alias tables existing in the outline.
int	getCountEnabledDTSMembers() Gets the count of defined DTS members for the outline.
int	getCountMembers() Gets the count of resulting members.
IEssCube	getCube() Gets the parent cube.
int	getDateFormat() Gets the format for a datetime attribute.
java.lang.String	getDefaultAttrCalcDimName() Gets the name of the attribute calculations (aggregate) dimension.
java.lang.String	getDefaultAverageMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE.
java.lang.String	getDefaultCountMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate COUNT.
java.lang.String	getDefaultFalseString() Gets the string used with the boolean attribute to indicate false.
java.lang.String	getDefaultMaxMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM.
java.lang.String	getDefaultMinMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM.
java.lang.String	getDefaultSumMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate SUM.
java.lang.String	getDefaultTrueString() Gets the string used with the boolean attribute to indicate true.
int	getDelimiter() Gets the delimiter to use when generating a long name.
IEssIterator	getDimensionGenerations(java.lang.String dimensionName) Gets all the generations for the given dimension.
IEssIterator	getDimensionLevels(java.lang.String dimensionName) Gets all the levels for the given dimension.
java.lang.String[]	getDimensionUDAs(java.lang.String dimensionName) Gets all the User Defined Attributes (used by one or more members) for the given dimension.
java.lang.String	getDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) Gets an alias name for a Dynamic Time Series member.
java.lang.String	getEnabledDTSMember(int index) Gets the defined DTS member name for the outline at the specified index.
int	getGenerationForEnabledDTSMember(int index) Gets the generation for the defined DTS member name for the outline at the specified index.
IEssIterator	getMembers() Gets the resulting members.
java.lang.String	getName() Gets the name of the member selection.
IEssCube.EEssCubeType	getOutlineType() Gets the outline type.
IEssCube.EEssTimePeriod[]	getTimePeriods(java.lang.String dateTimeDimTopMember, int tiDimQueryID) In a time dimension hierarchy, members falling under same generation come from same time period domain.
int	getUseNameOf() Gets which generation(s) of the zero-level member to use when generating a long name.
boolean	isAutoConfigure() Checks if to automatically configure the dimension storage(dense/sparse) when the outline is saved.
boolean	isCaseSensitive() Checks if the member names are case-sensitive.
boolean	isGenerationNameByPrefix() Checks if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name.
boolean	isNonUniqueMemberNameEnabled() Checks if Non Unique Member Names are allowed in this outline.
void	open() Opens the member selection.
void	refreshPropertyValues() Refreshes 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, updatePropertyValues

Field Detail

QUERY_TYPE_CHILDREN

public static final int QUERY_TYPE_CHILDREN

Query types.

See Also:

Constant Field Values

QUERY_TYPE_DESCENDANTS

public static final int QUERY_TYPE_DESCENDANTS

See Also:

Constant Field Values

QUERY_TYPE_BOTTOMLEVEL

public static final int QUERY_TYPE_BOTTOMLEVEL

See Also:

Constant Field Values

QUERY_TYPE_SIBLINGS

public static final int QUERY_TYPE_SIBLINGS

See Also:

Constant Field Values

QUERY_TYPE_SAMELEVEL

public static final int QUERY_TYPE_SAMELEVEL

See Also:

Constant Field Values

QUERY_TYPE_SAMEGENERATION

public static final int QUERY_TYPE_SAMEGENERATION

See Also:

Constant Field Values

QUERY_TYPE_PARENT

public static final int QUERY_TYPE_PARENT

See Also:

Constant Field Values

QUERY_TYPE_DIMENSION

public static final int QUERY_TYPE_DIMENSION

See Also:

Constant Field Values

QUERY_TYPE_NAMEDGENERATION

public static final int QUERY_TYPE_NAMEDGENERATION

See Also:

Constant Field Values

QUERY_TYPE_NAMEDLEVEL

public static final int QUERY_TYPE_NAMEDLEVEL

See Also:

Constant Field Values

QUERY_TYPE_SEARCH

public static final int QUERY_TYPE_SEARCH

See Also:

Constant Field Values

QUERY_TYPE_WILDSEARCH

public static final int QUERY_TYPE_WILDSEARCH

See Also:

Constant Field Values

QUERY_TYPE_USERATTRIBUTE

public static final int QUERY_TYPE_USERATTRIBUTE

See Also:

Constant Field Values

QUERY_TYPE_ANCESTORS

public static final int QUERY_TYPE_ANCESTORS

See Also:

Constant Field Values

QUERY_TYPE_DTSMEMBERS

public static final int QUERY_TYPE_DTSMEMBERS

See Also:

Constant Field Values

QUERY_TYPE_DIMUSERATTRIBUTES

public static final int QUERY_TYPE_DIMUSERATTRIBUTES

See Also:

Constant Field Values

QUERY_TYPE_INDEPDIMS

public static final int QUERY_TYPE_INDEPDIMS

See Also:

Constant Field Values

QUERY_OPTION_MEMBERSONLY

public static final int QUERY_OPTION_MEMBERSONLY

Query options.

See Also:

Constant Field Values

QUERY_OPTION_ALIASESONLY

public static final int QUERY_OPTION_ALIASESONLY

See Also:

Constant Field Values

QUERY_OPTION_MEMBERSANDALIASES

public static final int QUERY_OPTION_MEMBERSANDALIASES

See Also:

Constant Field Values

QUERY_OPTION_COUNTONLY

public static final int QUERY_OPTION_COUNTONLY

See Also:

Constant Field Values

QUERY_OPTION_INCLUDEHYBRIDANALYSIS

public static final int QUERY_OPTION_INCLUDEHYBRIDANALYSIS

See Also:

Constant Field Values

QUERY_OPTION_EXCLUDEHYBRIDANALYSIS

public static final int QUERY_OPTION_EXCLUDEHYBRIDANALYSIS

See Also:

Constant Field Values

QUERY_OPTION_FORCECASESENSITIVE

public static final int QUERY_OPTION_FORCECASESENSITIVE

See Also:

Constant Field Values

QUERY_OPTION_FORCEIGNORECASE

public static final int QUERY_OPTION_FORCEIGNORECASE

See Also:

Constant Field Values

QUERY_OPTION_NOTOTALCOUNTS

public static final int QUERY_OPTION_NOTOTALCOUNTS

See Also:

Constant Field Values

QUERY_OPTION_UNIQUENAME

public static final int QUERY_OPTION_UNIQUENAME

See Also:

Constant Field Values

QUERY_OPTION_USESUBSTITUTIONVAR

public static final int QUERY_OPTION_USESUBSTITUTIONVAR

See Also:

Constant Field Values

QUERY_TIDIM_TIMEPERIODS

public static final int QUERY_TIDIM_TIMEPERIODS

Query ID related to Time Dimension for fetching time periods list

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()
                         throws EssException

Gets the name of the member selection.

Specified by:

getName in interface IEssExtendedObject

Returns:

The member selection name.

Throws:

EssException - if an error occurs.

open

public void open()
          throws EssException

Opens the member selection.

Throws:

EssException - if an error occurs.

close

public void close()
           throws EssException

Closes the member selection. This will not throw exception if member selection is not open already. Once this call is made, make sure not to use the member objects obtained prior to closing.

Throws:

EssException - if an error occurs.

executeQuery

public void executeQuery(java.lang.String memberName)
                  throws EssException

Executes member selection query to fetch specified member.

Parameters:

memberName - The member name.

Throws:

EssException - if an error occurs.

executeQuery

public void executeQuery(java.lang.String mbrName,
                         int queryType,
                         int queryOptions,
                         java.lang.String dimName,
                         java.lang.String input1,
                         java.lang.String input2)
                  throws EssException

Executes the member selection query. If you invoke executeQuery multiple times, make sure to get the resulting member objects and use those, and discard member objects obtained from prior executeQuery results.

Parameters:

mbrName - The name of the member to do the operation on. If this value is null, it is assumed to be the very top of the outline, representing the logical parent of the dimensions. This value will be ignored for the following query types (specified by queryType param): QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE, QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH.

queryType - Type of the query. Value defining the operation to perform. It can be one of the following: QUERY_TYPE_CHILDREN, QUERY_TYPE_DESCENDANTS, QUERY_TYPE_BOTTOMLEVEL, QUERY_TYPE_SIBLINGS, QUERY_TYPE_SAMELEVEL, QUERY_TYPE_SAMEGENERATION, QUERY_TYPE_PARENT, QUERY_TYPE_DIMENSION, QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH, QUERY_TYPE_USERATTRIBUTE, QUERY_TYPE_ANCESTORS, QUERY_TYPE_DTSMEMBERS, QUERY_TYPE_DIMUSERATTRIBUTES, QUERY_TYPE_INDEPDIMS.

queryOptions - Options dependent on the query type. For the query types (specified via queryType param) QUERY_TYPE_SEARCH/ QUERY_TYPE_WILDSEARCH you can specify one of the following query options: QUERY_OPTION_MEMBERSONLY, QUERY_OPTION_ALIASESONLY, QUERY_OPTION_MEMBERSANDALIASES. With any of the query type, you can combine QUERY_OPTION_COUNTONLY, QUERY_OPTION_NOTOTALCOUNTS QUERY_OPTION_INCLUDEHYBRIDANALYSIS, QUERY_OPTION_EXCLUDEHYBRIDANALYSIS, QUERY_OPTION_FORCECASESENSITIVE, QUERY_OPTION_FORCEIGNORECASE, QUERY_OPTION_UNIQUENAME, QUERY_OPTION_USESUBSTITUTIONVAR.

dimName - Dimension to limit the scope of the query. It is used with the following query options and ignored otherwise: QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE QUERY_TYPE_SEARCH (set to NULL to search through all dimensions), QUERY_TYPE_WILDSEARCH (set to NULL to search through all dimensions).

input1 - Input string that is determined by the option. It is used with the following query options and ignored otherwise: QUERY_TYPE_NAMEDGENERATION (The name of the generation), QUERY_TYPE_NAMEDLEVEL (The name of the level), QUERY_TYPE_SEARCH (The string to search for. The string is defined as an exact), QUERY_TYPE_WILDSEARCH (The string to search for. The string is defined as an exact search string with an optional '*' at the end to mean any set of characters), QUERY_TYPE_USERATTRIBUTE (The user defined attribute).

input2 - Input string that is determined by the option. It is used with the following query options and ignored otherwise: QUERY_TYPE_USERATTRIBUTE (The user defined attribute), QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH (If the options are set to look in the alias tables, this string specifies the alias table to search in. If it's null, all alias tables will be searched).

Throws:

EssException - if an error occurs.

executeQuery

public void executeQuery(java.lang.String mbrName,
                         int queryType,
                         int queryOptions,
                         java.lang.String dimName,
                         java.lang.String input1,
                         java.lang.String input2,
                         int startMemberIndex,
                         int maxMemberCount)
                  throws EssException

Executes the member selection query. If you invoke executeQuery multiple times, make sure to get the resulting member objects and use those, and discard member objects obtained from prior executeQuery results. This method supports cursoring through two extra parameters that it takes. If the query is large, use the last two parameters to control how many members will be returned at a time. For example : if you think your query may return 1000 members but you want only 100 members at the most at a time, then do the following:

                        int total = 0;
                        IEssIterator mbrs = null;
                        do {
                                memberSelection.executeQuery(... , total, 100);
                                mbrs = mbrSel.getMembers();
                                if(mbrs != null) {
                                        // add results to result list, process the result

                                        total += mbrs.getCount();
                                }

                        } while( (total <= 1000) && (mbrs != null && mbrs.getCount() > 0) );
                

Parameters:

mbrName - The name of the member to do the operation on.

queryType - Type of the query. Value defining the operation to perform.

queryOptions - Options dependent on the query type.

dimName - Dimension to limit the scope of the query.

input1 - Input string that is determined by the option.

input2 - Input string that is determined by the option. See executeQuery(String mbrName, int queryType, int queryOptions, String dimName, String input1, String input) for details of parameters listed above.

startMemberIndex - Defines where (in a large result set)to start getting the members from.

maxMemberCount - Defines how many members to get at a time. The resulting member count will be at the most this value.

Throws:

EssException - if an error occurs.

Note:

Cursoring will not work if member selection was opened over outline cache. The last two parameters will be igonored in that case.

executeQuery

public void executeQuery(java.lang.String fieldSelection,
                         java.lang.String mbrSelection)
                  throws EssException

Executes the member selection query. NOTE: If you invoke executeQuery multiple times, make sure to get the resulting member objects and use those, and discard the members objects obtained from prior executeQuery results. Example usage:

executeQuery("<OutputType Binary <SelectMbrInfo (MemberName, MemberLevel, Consolidation, MemberFormula )", "@ichild(Product), @ichild(Market)");

Parameters:

fieldSelection - The query string which defines the set of fields that will be returned for each member. The syntax is "<OutputType Binary | Text <SelectMbrInfo ( FieldName {, FieldName}, ... )" where FieldName is one of the following: MemberName (Member name), MemberLevel (Member level number), MemberGeneration (Member generation number), Cosolidation (Whether this member is consolidated), TwoPass (Whether this member undergoes a two pass operation), Expense (Whether this is an expense member), CurrencyConvType (Currency conversion type), CurrencyMember (Whether this is a currency member), TimeBalance (Time balance measure), SkipOption (Whether this member skips the time balance operation), ShareOption (Whether this is a shared member), StorageType (Dimension's storage type), DimensionCategory (Dimension category: accounts, time, currency, etc.), DimensionStorageCategory (Dimension storage category: time, units, scenario, etc.), Comment (Member comment), ChildrenCount (Number of children), MemberNumber (Member number), DimensionName (Dimension name), DimensionNumber (Dimension number), MemberAliasName (Alias for this member), ParentMemberName (Parent's name), ChildMemberName (Child's name), PreviousMemberName (Left sibling's name), NextMemberName (Right sibling's name), CurrencyConversionDatabase (Whether this database has currency conversion), MemberStatus (Member status), UDAList (List of UDAs attached to this member), MemberFormula (Formula for this member), MemberValidity (Whether this member is valid), AttrDimensionNames (Attribute dimensions associated with this member's dimension), MemberAttributed (Whether this member is attributed), AttributeDataType (Attribute data type for this member), AttributeDataValue (Attribute data value for this member).

mbrSelection - The query string which defines the set of members to be returned. The syntax of this query string is the syntax for member selection; that is, the query string can be anything that you can use in a FIX() statement.

Throws:

EssException - if an error occurs.

executeQuery

public void executeQuery(java.lang.String fieldSelection,
                         java.lang.String mbrSelection,
                         int maxMemberCount)
                  throws EssException

Executes the member selection query. NOTE: If you invoke executeQuery multiple times, make sure to get the resulting member objects and use those, and discard the members objects obtained from prior executeQuery results. Example usage:

executeQuery("<OutputType Binary <SelectMbrInfo (MemberName, MemberLevel, Consolidation, MemberFormula )", "@ichild(Product), @ichild(Market)");

Parameters:

fieldSelection - The query string which defines the set of fields that will be returned for each member.

mbrSelection - The query string which defines the set of members to be returned. See executeQuery(String fieldSelection, String mbrSelection) for details of parameters listed above.

maxMemberCount - Defines how many members to get at the most. The resulting member count will be at the most this value.

Throws:

EssException - if an error occurs.

getCountMembers

public int getCountMembers()
                    throws EssException

Gets the count of resulting members.

Returns:

The count of members.

Throws:

EssException - if an error occurs.

getMembers

public IEssIterator getMembers()
                        throws EssException

Gets the resulting members.

Returns:

The list of members (each of type IEssMember).

Throws:

EssException

getCube

public IEssCube getCube()
                 throws EssException

Gets the parent cube.

Returns:

The cube.

Throws:

EssException - if an error occurs.

isCaseSensitive

public boolean isCaseSensitive()
                        throws EssException

Checks if the member names are case-sensitive.

Returns:

true if the member names are case-sensitive.

Throws:

EssException - if an error occurs.

isAutoConfigure

public boolean isAutoConfigure()
                        throws EssException

Checks if to automatically configure the dimension storage(dense/sparse) when the outline is saved.

Returns:

true to auto configure.

Throws:

EssException - if an error occurs.

isNonUniqueMemberNameEnabled

public boolean isNonUniqueMemberNameEnabled()
                                     throws EssException

Checks if Non Unique Member Names are allowed in this outline.

Returns:

true if non-unique member names are allowed.

Throws:

EssException - if an error occurs.

getOutlineType

public IEssCube.EEssCubeType getOutlineType()
                                     throws EssException

Gets the outline type.

Returns:

The outline type.

Throws:

EssException - if an error occurs.

getCountAliasTables

public int getCountAliasTables()
                        throws EssException

Gets the count of alias tables existing in the outline.

Returns:

The count of alias tables.

Throws:

EssException - if an error occurs.

getAliasTableNames

public java.lang.String[] getAliasTableNames()
                                      throws EssException

Gets the names of alias tables existing in the outline.

Returns:

The alias table names.

Throws:

EssException - if an error occurs.

isGenerationNameByPrefix

public boolean isGenerationNameByPrefix()
                                 throws EssException

Checks if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name. This is an attribute specification for the outline. The default value is true.

Returns:

true to use generation name by prefix.

Throws:

EssException - if an error occurs.

getUseNameOf

public int getUseNameOf()
                 throws EssException

Gets which generation(s) of the zero-level member to use when generating a long name. This is an attribute specification for the outline.

Returns:

0 for none (default), 1 for parent, 2 for grand parent and parent, 3 for all ancestors, 4 for dimension.

Throws:

EssException - if an error occurs.

getDelimiter

public int getDelimiter()
                 throws EssException

Gets the delimiter to use when generating a long name. This is an attribute specification for the outline.

Returns:

0 for underscore (default), 1 for pipe, 2 for caret.

Throws:

EssException - if an error occurs.

getDateFormat

public int getDateFormat()
                  throws EssException

Gets the format for a datetime attribute. This is an attribute specification for the outline.

Returns:

0 for MMDDYYYY (default), 1 for DDMMYY.

Throws:

EssException - if an error occurs.

getBucketingType

public int getBucketingType()
                     throws EssException

Gets the numeric attribute's bucketing type. This is an attribute specification for the outline.

Returns:

0 for upper bound inclusive (default), 1 for lower bound inclusive, 2 for upper bound non inclusive, 3 for lower bound non inclusive.

Throws:

EssException - if an error occurs.

getDefaultTrueString

public java.lang.String getDefaultTrueString()
                                      throws EssException

Gets the string used with the boolean attribute to indicate true. This is an attribute specification for the outline.

Returns:

The string used to indicate true. Default value is "True".

Throws:

EssException - if an error occurs.

getDefaultFalseString

public java.lang.String getDefaultFalseString()
                                       throws EssException

Gets the string used with the boolean attribute to indicate false. This is an attribute specification for the outline.

Returns:

The string used to indicate false. Default value is "False".

Throws:

EssException - if an error occurs.

getDefaultAttrCalcDimName

public java.lang.String getDefaultAttrCalcDimName()
                                           throws EssException

Gets the name of the attribute calculations (aggregate) dimension. The default value is "Attribute Calculations". This is an attribute specification for the outline.

Returns:

The default attribute calculation dimension name.

Throws:

EssException - if an error occurs.

getDefaultSumMbrName

public java.lang.String getDefaultSumMbrName()
                                      throws EssException

Gets the name used with the attribute calculations (aggregate) dimension to indicate SUM. The default value is "Sum". This is an attribute specification for the outline.

Returns:

The name to indicate SUM.

Throws:

EssException - if an error occurs.

getDefaultCountMbrName

public java.lang.String getDefaultCountMbrName()
                                        throws EssException

Gets the name used with the attribute calculations (aggregate) dimension to indicate COUNT. The default value is "Count". This is an attribute specification for the outline.

Returns:

The name to indicate COUNT.

Throws:

EssException - if an error occurs.

getDefaultAverageMbrName

public java.lang.String getDefaultAverageMbrName()
                                          throws EssException

Gets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE. The default value is "Average". This is an attribute specification for the outline.

Returns:

The name to indicate AVERAGE.

Throws:

EssException - if an error occurs.

getDefaultMinMbrName

public java.lang.String getDefaultMinMbrName()
                                      throws EssException

Gets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM. The default value is "Min". This is an attribute specification for the outline.

Returns:

The name to indicate MINIMUM.

Throws:

EssException - if an error occurs.

getDefaultMaxMbrName

public java.lang.String getDefaultMaxMbrName()
                                      throws EssException

Gets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM. The default value is "Max". This is an attribute specification for the outline.

Returns:

The name to indicate MAXIMUM.

Throws:

EssException - if an error occurs.

getDTSMemberAlias

public java.lang.String getDTSMemberAlias(java.lang.String dtsMemberName,
                                          java.lang.String aliasTableName)
                                   throws EssException

Gets an alias name for a Dynamic Time Series member.

Parameters:

dtsMemberName - The DTS member name which provides the alias.

aliasTableName - The alias table name which provides the alias. If null, the default alias table is used

Returns:

The alias name for the DTS member.

Throws:

EssException - if an error occurs.

getCountEnabledDTSMembers

public int getCountEnabledDTSMembers()
                              throws EssException

Gets the count of defined DTS members for the outline.

Returns:

The count of defined DTS members.

Throws:

EssException - if an error occurs.

getEnabledDTSMember

public java.lang.String getEnabledDTSMember(int index)
                                     throws EssException

Gets the defined DTS member name for the outline at the specified index.

Parameters:

index - The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().

Returns:

The DTS member name.

Throws:

EssException - if an error occurs.

getGenerationForEnabledDTSMember

public int getGenerationForEnabledDTSMember(int index)
                                     throws EssException

Gets the generation for the defined DTS member name for the outline at the specified index.

Parameters:

index - The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().

Returns:

The generation number.

Throws:

EssException - if an error occurs.

getDimensionGenerations

public IEssIterator getDimensionGenerations(java.lang.String dimensionName)
                                     throws EssException

Gets all the generations for the given dimension.

Parameters:

dimensionName - The dimension name.

Returns:

The generations.

Throws:

EssException - if an error occurs.

getDimensionLevels

public IEssIterator getDimensionLevels(java.lang.String dimensionName)
                                throws EssException

Gets all the levels for the given dimension.

Parameters:

dimensionName - The dimension name.

Returns:

The levels.

Throws:

EssException - if an error occurs.

getDimensionUDAs

public java.lang.String[] getDimensionUDAs(java.lang.String dimensionName)
                                    throws EssException

Gets all the User Defined Attributes (used by one or more members) for the given dimension.

Parameters:

dimensionName - The dimension name.

Returns:

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

Throws:

EssException - if an error occurs.

getTimePeriods

public IEssCube.EEssTimePeriod[] getTimePeriods(java.lang.String dateTimeDimTopMember,
                                                int tiDimQueryID)
                                         throws EssException

In a time dimension hierarchy, members falling under same generation come from same time period domain. This API helps gives you the mapping between the the time periods and the generations of the time dimension. First Element of the returned array corresponds to the Generation 1, Second Element of the returned array corresponds to the Generation 2, and so on...

Parameters:

tiDimQueryID - Time Intelligence related query id. Any possible QUERY_TIDIM_*.

Returns:

all associated time periods for the specified Time Dimension/Member Name.

Throws:

EssException - if an error occurs.

refreshPropertyValues

public void refreshPropertyValues()
                           throws 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:

EssException - if an error occurs.