|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssCubeOutline
The IEssCubeOutline is the cube outline.
Nested Class Summary | |
---|---|
static class |
IEssCubeOutline.EEssAliasTableOption EEssAliasTableOption class is the alias table option type. |
Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
---|
IEssProperties.EEssPropertyMode |
Field Summary | |
---|---|
static int |
PROP_ALIAS_TABLE_NAMES |
static int |
PROP_AUTO_CONFIGURE |
static int |
PROP_CASE_SENSITIVE |
static int |
PROP_COUNT_ALIAS_TABLES |
static int |
PROP_NAME |
static int |
PROP_NON_UNIQUE_NAMES |
static int |
PROP_OUTLINE_TYPE |
static int |
s_countProperties |
static IEssValueAny.EEssDataType[] |
s_propDataTypes |
static IEssProperties.EEssPropertyMode[] |
s_propModes |
static java.lang.String[] |
s_propNames |
Method Summary | |
---|---|
void |
addQueryHint(IEssMember[] memberArray) Adds a query hint to the outline. |
void |
associateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim) Associates an attribute dimension with a base dimension. |
void |
associateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr) Associates an attribute member with a base member. |
void |
associateAttributeMember(java.lang.String standardMbrName, java.lang.String attributeMbrName) Associates an attribute member with a base member. |
void |
clearAliasTable(java.lang.String aliasTableName) Clears all entries from an existing alias table without deleting the alias table |
void |
clearAliasTableLanguage(java.lang.String aliasTableName) Clears the languages for the alias table |
void |
close() Closes the outline freeing all resources associated with the outline. |
void |
close(boolean ignoreErrors) Closes the outline freeing all resources associated with the outline. |
void |
copyAliasTable(java.lang.String srcAliasTableName, java.lang.String destAliasTableName, boolean merge) Copies an alias table to another alias table. |
void |
create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure) Creates a new outline. |
void |
create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure, boolean allowNonUniqueNames) Creates a new outline. |
void |
createAliasTable(java.lang.String aliasTableName) Creates an empty alias table in the outline. |
void |
createAliasTable(java.lang.String aliasTableName, IEssCubeOutline.EEssAliasTableOption atOption) Creates an empty alias table in the outline, with the specified Alias table option. |
IEssDimension |
createAttributeDimension(java.lang.String dimName, IEssDimension.EEssAttributeDataType attrDataType, IEssDimension prevSibling) Creates an attribute dimension. |
IEssDimension |
createDimension(java.lang.String dimName) Creates a dimension. |
IEssDimension |
createDimension(java.lang.String dimName, IEssDimension prevSibling) Creates a dimension. |
IEssSmartList |
createSmartList(java.lang.String smartListName) Creates a smartlist and retruns its instance. |
void |
deleteAliasTable(java.lang.String aliasTableName) Deletes the alias table from the outline and clears all of its entries. |
void |
deleteDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) Deletes an alias name for a Dynamic Time Series member. |
void |
deleteQueryHint(int hintNumber) Deletes a query hint from the outline. |
boolean |
dimensionHasHybridChildren() Checks if the outline has any relational descedents. |
void |
disassociateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim) Disassociates an attribute dimension from a base dimension. |
void |
disassociateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr) Disassociates an attribute member from a base member |
void |
enableDTSMember(java.lang.String dtsMemberName, int genNum, boolean enable) Enables a new Dynamic Time Series members for the outline. |
IEssIterator |
executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) Member selection over outline. |
IEssIterator |
executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection) Member selection over outline. |
IEssMember |
findAlias(java.lang.String aliasName, java.lang.String aliasTableName) Finds a member for the alias name. |
IEssIterator |
findAttributeMembers(java.lang.String attShortName, java.lang.String dimName) Gets all the attribute members having the specified short name. |
IEssDimension |
findDimension(java.lang.String mbrName) Finds a dimension for the member. |
IEssMember |
findMember(java.lang.String mbrName) Finds a member. |
IEssMember |
findMemberOnId(java.lang.String mbrID) Finds the Member for a given Member ID. |
IEssIterator |
findMembers(java.lang.String[] mbrNames) Finds members. |
IEssSmartList |
findSmartList(java.lang.String smartListName) Finds a smartlist in the outline and returns its instance. |
IEssCubeOutline |
generateCurrencyOutline() Generates a currency outline based on the current (source) outline. |
java.lang.String[] |
getAliasTableLanguages(java.lang.String aliasTableName) Gets the languages associated with the specified alias table |
java.lang.String[] |
getAliasTableNames() Gets the names of alias tables existing in the outline. |
IEssSmartList[] |
getAllSmartLists() Returns list of all samrtlist for the given outline. |
IEssDimension |
getASOCompressionDimension() Gets the compression dimension in an ASO cube 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. |
IEssCube |
getCube() Gets the parent cube. |
int |
getDateFormat() Gets the format for a datetime attribute. |
java.lang.String |
getDateFormatString() Gets Date Format String. |
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 |
getDimensions() Gets the list of dimensions. |
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. |
IEssCube.EEssCubeType |
getOutlineType() Gets the outline type. |
IEssIterator |
getQueryHint(int hintNumber, int numMembers) Gets the members associated with a query hint from the outline. |
int |
getQueryHintsCount() Gets the number of query hints associated with the outline. |
int |
getQueryHintsSize() Gets the count of members in query hints associated with the outline. |
java.lang.String[][] |
getServerDateFormats(java.lang.String essbaseLocaleString) Gets the date formats supported by Essbase Server. |
IEssIterator |
getSharedMembers(java.lang.String mbrName) Gets all the shared members of the specified member. |
IEssSmartList |
getSmartListInfo(IEssSmartList smartList) Returns the smartlist instance containing the smartlist info. |
java.util.Date |
getUpdateTime() Gets a timestamp for this outline. |
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 |
isMemberTypeEnabled() Indicates if the outline supports different Member types such as Smartlist & Date type of members & cells. |
boolean |
isNonUniqueMemberNameEnabled() Checks if Non Unique Member Names are allowed in this outline. |
boolean |
isOpen() Checks if the outline is open. |
boolean |
isVaryingAttributeEnabled() Indicates if the outline is enabled to have Varying Attributes. |
void |
moveMember(IEssMember mbrToMove, IEssMember newParent, IEssMember newPrevSibling) Moves a member. |
void |
open() Opens the cube outline in read-only mode. |
void |
open(boolean readOnly, boolean lock, boolean keepTrans) Opens the cube outline in read-only or read-write mode. |
void |
open(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental) Opens the cube outline in read-only or read-write mode. |
void |
open(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental, boolean dimBldOtl) |
void |
refreshPropertyValues() Refreshes the property values. |
void |
renameAliasTable(java.lang.String aliasTableName, java.lang.String newAliasTableName) Renames an existing alias table |
void |
restructureCube(IEssCube.EEssRestructureOption restructOption) Restructures the cube based on the newly saved outline. |
void |
save() Writes the existing outline information to disk. |
void |
save(IEssCube.EEssRestructureOption restructOption) Performs 3 operations in one shot: 1. |
void |
setAliasTableLanguage(java.lang.String aliasTableName, java.lang.String languageCode) Sets the language for the alias table. |
void |
setASOCompressionDimension(IEssDimension dim) Sets the compression dimension in an ASO cube outline. |
void |
setAutoConfigure(boolean autoConfigure) Sets if to automatically configure the dimension storage(dense/sparse) when the outline is saved. |
void |
setBucketingType(int bucketingType) Sets the numeric attribute's bucketing type. |
void |
setCaseSensitive(boolean caseSensitive) Sets if the member names are case-sensitive. |
void |
setDateFormat(int dateFormat) Sets the format for a datetime attribute. |
void |
setDateFormatString(java.lang.String dateFormatString) Sets the Date Format String. |
void |
setDefaultAttrCalcDimName(java.lang.String defAttrCalcDimName) Sets the name of the attribute calculations (aggregate) dimension. |
void |
setDefaultAverageMbrName(java.lang.String defAverageMbrName) Sets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE. |
void |
setDefaultCountMbrName(java.lang.String defCountMbrName) Sets the name used with the attribute calculations (aggregate) dimension to indicate COUNT. |
void |
setDefaultFalseString(java.lang.String defFalseString) Sets the string used with the boolean attribute to indicate false. |
void |
setDefaultMaxMbrName(java.lang.String defMaxMbrName) Sets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM. |
void |
setDefaultMinMbrName(java.lang.String defMinMbrName) Sets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM. |
void |
setDefaultSumMbrName(java.lang.String defSumMbrName) Sets the name used with the attribute calculations (aggregate) dimension to indicate SUM. |
void |
setDefaultTrueString(java.lang.String defTrueString) Sets the string used with the boolean attribute to indicate true. |
void |
setDelimiter(int delimiter) Sets the delimiter to use when generating a long name. |
void |
setDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName, java.lang.String alias) Sets an alias name for a Dynamic Time Series member. |
void |
setGenerationNameByPrefix(boolean genNameByPrefix) Sets if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name. |
void |
setMemberTypeEnabled(boolean enableMemberType) This is to enable an outline for supporting Smartlist, format strings & Date type of members & cells. |
void |
setNonUniqueMemberNameEnabled(boolean enabled) Enables/Disables Non Unique Member Names are allowed in this outline. |
void |
setOutlineType(IEssCube.EEssCubeType otlType) Sets the outline type. |
void |
setQueryHint(int hintNumber, IEssMember[] memberArray) Sets the members associated with a query hint in the outline. |
void |
setUseNameOf(int whichGen) Sets which generation(s) of the zero-level member to use when generating a long name. |
void |
updatePropertyValues() Updates the property values. |
void |
verify() Verifies the outline for correctness. |
void |
verify(boolean verifyFormula) Verifies the outline for correctness. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
---|
clearClientCache, getName, 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 |
---|
static final int PROP_NAME
static final int PROP_CASE_SENSITIVE
static final int PROP_OUTLINE_TYPE
static final int PROP_AUTO_CONFIGURE
static final int PROP_COUNT_ALIAS_TABLES
static final int PROP_ALIAS_TABLE_NAMES
static final int PROP_NON_UNIQUE_NAMES
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
---|
boolean isCaseSensitive() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setCaseSensitive(boolean caseSensitive) throws com.essbase.api.base.EssException
caseSensitive
- true if the member names are case-sensitive.com.essbase.api.base.EssException
- if an error occurs.IEssCube.EEssCubeType getOutlineType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setOutlineType(IEssCube.EEssCubeType otlType) throws com.essbase.api.base.EssException
otlType
- The outline type.com.essbase.api.base.EssException
- if an error occurs.boolean isAutoConfigure() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setAutoConfigure(boolean autoConfigure) throws com.essbase.api.base.EssException
autoConfigure
- true to auto configure.com.essbase.api.base.EssException
- if an error occurs.boolean isNonUniqueMemberNameEnabled() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setNonUniqueMemberNameEnabled(boolean enabled) throws com.essbase.api.base.EssException
enabled
- true to enable.com.essbase.api.base.EssException
- if an error occurs.boolean isMemberTypeEnabled() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setMemberTypeEnabled(boolean enableMemberType) throws com.essbase.api.base.EssException
Note: An outline enabled for supporting Member types cannot be disabled as its a restriction at the Essbase level.
enableMemberType
- true to enable Member types .com.essbase.api.base.EssException
- if an error occurs.boolean isVaryingAttributeEnabled() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getCountAliasTables() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getAliasTableNames() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isGenerationNameByPrefix() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setGenerationNameByPrefix(boolean genNameByPrefix) throws com.essbase.api.base.EssException
genNameByPrefix
- true to use generation name by prefix.com.essbase.api.base.EssException
- if an error occurs.int getUseNameOf() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setUseNameOf(int whichGen) throws com.essbase.api.base.EssException
whichGen
- 0 for none (default), 1 for parent, 2 for grand parent and parent, 3 for all ancestors, 4 for dimension.com.essbase.api.base.EssException
- if an error occurs.int getDelimiter() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDelimiter(int delimiter) throws com.essbase.api.base.EssException
delimiter
- 0 for underscore (default), 1 for pipe, 2 for caret.com.essbase.api.base.EssException
- if an error occurs.int getDateFormat() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDateFormat(int dateFormat) throws com.essbase.api.base.EssException
dateFormat
- 0 for MMDDYYYY (default), 1 for DDMMYY.com.essbase.api.base.EssException
- if an error occurs.int getBucketingType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setBucketingType(int bucketingType) throws com.essbase.api.base.EssException
bucketingType
- 0 for upper bound inclusive (default), 1 for lower bound inclusive, 2 for upper bound non inclusive, 3 for lower bound non inclusive.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultTrueString() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultTrueString(java.lang.String defTrueString) throws com.essbase.api.base.EssException
defTrueString
- The default true string.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultFalseString() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultFalseString(java.lang.String defFalseString) throws com.essbase.api.base.EssException
defFalseString
- The default false string.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultAttrCalcDimName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultAttrCalcDimName(java.lang.String defAttrCalcDimName) throws com.essbase.api.base.EssException
defAttrCalcDimName
- The default attribute calculation dimension name.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultSumMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultSumMbrName(java.lang.String defSumMbrName) throws com.essbase.api.base.EssException
defSumMbrName
- The name to indicate SUM.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultCountMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultCountMbrName(java.lang.String defCountMbrName) throws com.essbase.api.base.EssException
defCountMbrName
- The name to indicate COUNT.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultAverageMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultAverageMbrName(java.lang.String defAverageMbrName) throws com.essbase.api.base.EssException
defAverageMbrName
- The name to indicate AVERAGE.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultMinMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultMinMbrName(java.lang.String defMinMbrName) throws com.essbase.api.base.EssException
defMinMbrName
- The name to indicate MINIMUM.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultMaxMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDefaultMaxMbrName(java.lang.String defMaxMbrName) throws com.essbase.api.base.EssException
defMaxMbrName
- The name to indicate MAXIMUM.com.essbase.api.base.EssException
- if an error occurs.void refreshPropertyValues() throws com.essbase.api.base.EssException
refreshPropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void updatePropertyValues() throws com.essbase.api.base.EssException
updatePropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void open() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void open(boolean readOnly, boolean lock, boolean keepTrans) throws com.essbase.api.base.EssException
readOnly
- true to open the outline in read-only mode. false to open the outline in read-write mode.lock
- true if the outline should be locked when it is opened in any mode.keepTrans
- true to keep transactions. If you are opening an existing outline to make changes (readOnly == false), and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory.com.essbase.api.base.EssException
- if an error occurs.void open(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental) throws com.essbase.api.base.EssException
readOnly
- true to open the outline in read-only mode. false to open the outline in read-write mode.lock
- true if the outline should be locked when it is opened in any mode.keepTrans
- true to keep transactions. If you are opening an existing outline to make changes (readOnly == false), and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory.incremental
- if outline should be opened in incremental mode.com.essbase.api.base.EssException
- if an error occurs.void open(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental, boolean dimBldOtl) throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
boolean isOpen() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure) throws com.essbase.api.base.EssException
caseSensitive
- true for case-sensitive member names.outlineType
- The Outline type.autoConfigure
- true to automatically configure the dimension. storage (dense/sparse) when the outline is saved.com.essbase.api.base.EssException
- is an error occurs.void create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure, boolean allowNonUniqueNames) throws com.essbase.api.base.EssException
caseSensitive
- true for case-sensitive member names.outlineType
- The Outline type.autoConfigure
- true to automatically configure the dimension. storage (dense/sparse) when the outline is saved.allowNonUniqueNames
- if true, the outline created will allow non unique member names.com.essbase.api.base.EssException
- is an error occurs.void close() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void close(boolean ignoreErrors) throws com.essbase.api.base.EssException
ignoreErrors
- true to ignore errors if any and close the outline, false to throw exception in case of errors and not close the outline.com.essbase.api.base.EssException
- if an error occurs.void save() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void save(IEssCube.EEssRestructureOption restructOption) throws com.essbase.api.base.EssException
restructOption
- The restructure option.com.essbase.api.base.EssException
- if an error occurs.java.util.Date getUpdateTime() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void verify() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void verify(boolean verifyFormula) throws com.essbase.api.base.EssException
verifyFormula
- true if formulas should be verified while verifying outline.com.essbase.api.base.EssException
- if an error occurs.IEssDimension createDimension(java.lang.String dimName) throws com.essbase.api.base.EssException
dimName
- The dimension name.com.essbase.api.base.EssException
- if an error occurs.IEssDimension createDimension(java.lang.String dimName, IEssDimension prevSibling) throws com.essbase.api.base.EssException
dimName
- The dimension name.prevSibling
- The previous sibling dimension. The new dimension will be placed after this dimension.com.essbase.api.base.EssException
- if an error occurs.IEssDimension createAttributeDimension(java.lang.String dimName, IEssDimension.EEssAttributeDataType attrDataType, IEssDimension prevSibling) throws com.essbase.api.base.EssException
dimName
- The attribute dimension name.attrDataType
- The attribute dimension data type.prevSibling
- The previous sibling dimension. The new dimension will be placed after this dimension.com.essbase.api.base.EssException
- if an error occurs.IEssIterator getDimensions() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void moveMember(IEssMember mbrToMove, IEssMember newParent, IEssMember newPrevSibling) throws com.essbase.api.base.EssException
mbrToMove
- The member to movenewParent
- The new parent. Use this field only if the newPrevSibling field is null.newPrevSibling
- The new previous sibling.com.essbase.api.base.EssException
- if an error occurs.IEssMember findMember(java.lang.String mbrName) throws com.essbase.api.base.EssException
mbrName
- The member name to find.com.essbase.api.base.EssException
- if an error occurs. If the member is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.IEssIterator findMembers(java.lang.String[] mbrNames) throws com.essbase.api.base.EssException
mbrNames
- The member names to find.com.essbase.api.base.EssException
- if an error occurs. If the member is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.IEssMember findMemberOnId(java.lang.String mbrID) throws com.essbase.api.base.EssException
mbrID
- member IDcom.essbase.api.base.EssException
- if an error occurs.IEssDimension findDimension(java.lang.String mbrName) throws com.essbase.api.base.EssException
mbrName
- The member name.com.essbase.api.base.EssException
- if an error occurs. If the dimension is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.void restructureCube(IEssCube.EEssRestructureOption restructOption) throws com.essbase.api.base.EssException
restructOption
- The restructure option.com.essbase.api.base.EssException
- if an error occurs.void createAliasTable(java.lang.String aliasTableName) throws com.essbase.api.base.EssException
aliasTableName
- The name of alias table to create.com.essbase.api.base.EssException
- if an error occurs.void createAliasTable(java.lang.String aliasTableName, IEssCubeOutline.EEssAliasTableOption atOption) throws com.essbase.api.base.EssException
aliasTableName
- The name of alias table to create.atOption
- Option type while creating the alias table.com.essbase.api.base.EssException
- if an error occurs.void copyAliasTable(java.lang.String srcAliasTableName, java.lang.String destAliasTableName, boolean merge) throws com.essbase.api.base.EssException
srcAliasTableName
- The name of alias table to copy from. If this parameter is null, the default alias table is used.destAliasTableName
- The name of alias table to copy to. Cannot be the same as srcAliasTableName.merge
- true to merge the source file into the existing destination alias table. false to clear the destination alias table before copying.com.essbase.api.base.EssException
- if an error occurs.void renameAliasTable(java.lang.String aliasTableName, java.lang.String newAliasTableName) throws com.essbase.api.base.EssException
aliasTableName
- The name of alias table to rename.newAliasTableName
- The new name for alias table.com.essbase.api.base.EssException
- if an error occurs.void clearAliasTable(java.lang.String aliasTableName) throws com.essbase.api.base.EssException
aliasTableName
- The name of alias table to clear. Use null or "Default" for the default table.com.essbase.api.base.EssException
- if an error occurs.void deleteAliasTable(java.lang.String aliasTableName) throws com.essbase.api.base.EssException
aliasTableName
- The name of alias table to delete.com.essbase.api.base.EssException
- if an error occurs.IEssMember findAlias(java.lang.String aliasName, java.lang.String aliasTableName) throws com.essbase.api.base.EssException
aliasName
- The alias name to find member for.aliasTableName
- The alias table name which provides the alias.com.essbase.api.base.EssException
- if an error occurs. If the member is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.java.lang.String getDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) throws com.essbase.api.base.EssException
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 usedcom.essbase.api.base.EssException
- if an error occurs.void setDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName, java.lang.String alias) throws com.essbase.api.base.EssException
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 usedalias
- The alias name for the DTS member.com.essbase.api.base.EssException
- if an error occurs.void deleteDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) throws com.essbase.api.base.EssException
dtsMemberName
- The name of the DTS member which provides the alias.aliasTableName
- The name of the alias table which provides the alias. If null, use the default alias table.com.essbase.api.base.EssException
- if an error occurs.void enableDTSMember(java.lang.String dtsMemberName, int genNum, boolean enable) throws com.essbase.api.base.EssException
dtsMemberName
- The name of the DTS member.genNum
- The generation to assign to the DTS member.enable
- true to enable the DTS member.com.essbase.api.base.EssException
- if an error occurs.int getCountEnabledDTSMembers() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getEnabledDTSMember(int index) throws com.essbase.api.base.EssException
index
- The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().com.essbase.api.base.EssException
- if an error occurs.int getGenerationForEnabledDTSMember(int index) throws com.essbase.api.base.EssException
index
- The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().com.essbase.api.base.EssException
- if an error occurs.IEssCubeOutline generateCurrencyOutline() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void associateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim) throws com.essbase.api.base.EssException
standardDim
- The standard or base dimension.attributeDim
- The attribute dimension.com.essbase.api.base.EssException
- if an error occurs.void disassociateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim) throws com.essbase.api.base.EssException
standardDim
- The standard or base dimension.attributeDim
- The attribute dimension.com.essbase.api.base.EssException
- if an error occurs.void associateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr) throws com.essbase.api.base.EssException
standardMbr
- The standard or base member.attributeMbr
- The attribute member.com.essbase.api.base.EssException
- if an error occurs.void associateAttributeMember(java.lang.String standardMbrName, java.lang.String attributeMbrName) throws com.essbase.api.base.EssException
standardMbrName
- The standard or base member name.attributeMbrName
- The attribute member name.com.essbase.api.base.EssException
- if an error occurs.void disassociateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr) throws com.essbase.api.base.EssException
standardMbr
- The standard or base member.attributeMbr
- The attribute member.com.essbase.api.base.EssException
- if an error occurs.IEssIterator findAttributeMembers(java.lang.String attShortName, java.lang.String dimName) throws com.essbase.api.base.EssException
attShortName
- The attribute short name (A zero-level attribute member that is not of type ESS_ATTRMBRDT_STRING is called a short name).dimName
- The attribute dimension name. "" can also be passed.com.essbase.api.base.EssException
- if an error occurs.IEssIterator getSharedMembers(java.lang.String mbrName) throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssIterator executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssIterator executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection) throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssCube getCube() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean dimensionHasHybridChildren() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
int getQueryHintsCount() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
int getQueryHintsSize() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void addQueryHint(IEssMember[] memberArray) throws com.essbase.api.base.EssException
memberArray
- The member array to associate with the query hint.com.essbase.api.base.EssException
void deleteQueryHint(int hintNumber) throws com.essbase.api.base.EssException
hintNumber
- The hint number to delete.com.essbase.api.base.EssException
IEssIterator getQueryHint(int hintNumber, int numMembers) throws com.essbase.api.base.EssException
hintNumber
- The hint number to delete.numMembers
- The number of members to get.com.essbase.api.base.EssException
void setQueryHint(int hintNumber, IEssMember[] memberArray) throws com.essbase.api.base.EssException
hintNumber
- The hint number to delete.memberArray
- The member array to associate with the query hint.com.essbase.api.base.EssException
IEssDimension getASOCompressionDimension() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setASOCompressionDimension(IEssDimension dim) throws com.essbase.api.base.EssException
dim
- The dimension to set as a compression dim.com.essbase.api.base.EssException
- if an error occurs.java.lang.String[][] getServerDateFormats(java.lang.String essbaseLocaleString) throws com.essbase.api.base.EssException
essbaseLocaleString
- A locale string in Essbase Server format (in ESSLANG format e.g. German_Germany.ISO-8859-15@Default)com.essbase.api.base.EssException
IEssSmartList createSmartList(java.lang.String smartListName) throws com.essbase.api.base.EssException
smartListName
- - Name of the smartlist to be created.com.essbase.api.base.EssException
- if an error occurs.IEssSmartList findSmartList(java.lang.String smartListName) throws com.essbase.api.base.EssException
smartListName
-com.essbase.api.base.EssException
- if an error occurs or smartlist not found.IEssSmartList getSmartListInfo(IEssSmartList smartList) throws com.essbase.api.base.EssException
smartList
- - smartlist whos information is to be retrived.com.essbase.api.base.EssException
- if an error occurs.IEssSmartList[] getAllSmartLists() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDateFormatString() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- If an error occurs.void setDateFormatString(java.lang.String dateFormatString) throws com.essbase.api.base.EssException
dateFormatString
- Date Format String to be set.com.essbase.api.base.EssException
- If an error occursjava.lang.String[] getAliasTableLanguages(java.lang.String aliasTableName) throws com.essbase.api.base.EssException
aliasTableName
- - name of the alias table.com.essbase.api.base.EssException
- - If an error occurs.void setAliasTableLanguage(java.lang.String aliasTableName, java.lang.String languageCode) throws com.essbase.api.base.EssException
aliasTableName
- - name of the alias table whose language has to be set.languageCode
- - language code of the languagecom.essbase.api.base.EssException
- - If an error occurs.void clearAliasTableLanguage(java.lang.String aliasTableName) throws com.essbase.api.base.EssException
aliasTableName
- - name of the alias table whose languages have to be cleared.com.essbase.api.base.EssException
- - If an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |