|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssCubeOutline is the cube outline.
Nested Class Summary |
Nested classes inherited from class 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_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 |
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 |
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 |
createAliasTable(java.lang.String aliasTableName)
Creates an empty alias table in the outline. |
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. |
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 |
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. |
IEssIterator |
findMembers(java.lang.String[] mbrNames)
Finds members. |
IEssCubeOutline |
generateCurrencyOutline()
Generates a currency outline based on the current (source) outline. |
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. |
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 |
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 |
getSharedMembers(java.lang.String mbrName)
Gets all the shared members of the specified member. |
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 |
isOpen()
Checks if the outline is open. |
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 |
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 |
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 |
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 |
setOutlineType(IEssCube.EEssCubeType otlType)
Sets the outline type. |
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. |
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 |
public static final int PROP_NAME
public static final int PROP_CASE_SENSITIVE
public static final int PROP_OUTLINE_TYPE
public static final int PROP_AUTO_CONFIGURE
public static final int PROP_COUNT_ALIAS_TABLES
public static final int PROP_ALIAS_TABLE_NAMES
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 boolean isCaseSensitive() throws EssException
EssException
- if an error occurs.public void setCaseSensitive(boolean caseSensitive) throws EssException
caseSensitive
- true if the member names are case-sensitive.
EssException
- if an error occurs.public IEssCube.EEssCubeType getOutlineType() throws EssException
EssException
- if an error occurs.public void setOutlineType(IEssCube.EEssCubeType otlType) throws EssException
otlType
- The outline type.
EssException
- if an error occurs.public boolean isAutoConfigure() throws EssException
EssException
- if an error occurs.public void setAutoConfigure(boolean autoConfigure) throws EssException
autoConfigure
- true to auto configure.
EssException
- if an error occurs.public int getCountAliasTables() throws EssException
EssException
- if an error occurs.public java.lang.String[] getAliasTableNames() throws EssException
EssException
- if an error occurs.public boolean isGenerationNameByPrefix() throws EssException
EssException
- if an error occurs.public void setGenerationNameByPrefix(boolean genNameByPrefix) throws EssException
genNameByPrefix
- true to use generation name by prefix.
EssException
- if an error occurs.public int getUseNameOf() throws EssException
EssException
- if an error occurs.public void setUseNameOf(int whichGen) throws EssException
whichGen
- 0 for none (default), 1 for parent, 2 for grand parent
and parent, 3 for all ancestors, 4 for dimension.
EssException
- if an error occurs.public int getDelimiter() throws EssException
EssException
- if an error occurs.public void setDelimiter(int delimiter) throws EssException
delimiter
- 0 for underscore (default), 1 for pipe, 2 for caret.
EssException
- if an error occurs.public int getDateFormat() throws EssException
EssException
- if an error occurs.public void setDateFormat(int dateFormat) throws EssException
dateFormat
- 0 for MMDDYYYY (default), 1 for DDMMYY.
EssException
- if an error occurs.public int getBucketingType() throws EssException
EssException
- if an error occurs.public void setBucketingType(int bucketingType) throws 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.
EssException
- if an error occurs.public java.lang.String getDefaultTrueString() throws EssException
EssException
- if an error occurs.public void setDefaultTrueString(java.lang.String defTrueString) throws EssException
defTrueString
- The default true string.
EssException
- if an error occurs.public java.lang.String getDefaultFalseString() throws EssException
EssException
- if an error occurs.public void setDefaultFalseString(java.lang.String defFalseString) throws EssException
defFalseString
- The default false string.
EssException
- if an error occurs.public java.lang.String getDefaultAttrCalcDimName() throws EssException
EssException
- if an error occurs.public void setDefaultAttrCalcDimName(java.lang.String defAttrCalcDimName) throws EssException
EssException
- if an error occurs.public java.lang.String getDefaultSumMbrName() throws EssException
EssException
- if an error occurs.public void setDefaultSumMbrName(java.lang.String defSumMbrName) throws EssException
defSumMbrName
- The name to indicate SUM.
EssException
- if an error occurs.public java.lang.String getDefaultCountMbrName() throws EssException
EssException
- if an error occurs.public void setDefaultCountMbrName(java.lang.String defCountMbrName) throws EssException
defCountMbrName
- The name to indicate COUNT.
EssException
- if an error occurs.public java.lang.String getDefaultAverageMbrName() throws EssException
EssException
- if an error occurs.public void setDefaultAverageMbrName(java.lang.String defAverageMbrName) throws EssException
EssException
- if an error occurs.public java.lang.String getDefaultMinMbrName() throws EssException
EssException
- if an error occurs.public void setDefaultMinMbrName(java.lang.String defMinMbrName) throws EssException
defMinMbrName
- The name to indicate MINIMUM.
EssException
- if an error occurs.public java.lang.String getDefaultMaxMbrName() throws EssException
EssException
- if an error occurs.public void setDefaultMaxMbrName(java.lang.String defMaxMbrName) throws EssException
defMaxMbrName
- The name to indicate MAXIMUM.
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void open() throws EssException
EssException
- if an error occurs.public void open(boolean readOnly, boolean lock, boolean keepTrans) throws 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.
EssException
- if an error occurs.public boolean isOpen() throws EssException
EssException
- if an error occurs.public void create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure) throws 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.
EssException
- is an error occurs.public void close() throws EssException
EssException
- if an error occurs.public void close(boolean ignoreErrors) throws 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.
EssException
- if an error occurs.public void save() throws EssException
EssException
- if an error occurs.public void save(IEssCube.EEssRestructureOption restructOption) throws EssException
restructOption
- The restructure option.
EssException
- if an error occurs.public java.util.Date getUpdateTime() throws EssException
EssException
- if an error occurs.public void verify() throws EssException
EssException
- if an error occurs.public IEssDimension createDimension(java.lang.String dimName) throws EssException
dimName
- The dimension name.
EssException
- if an error occurs.public IEssDimension createDimension(java.lang.String dimName, IEssDimension prevSibling) throws EssException
dimName
- The dimension name.prevSibling
- The previous sibling dimension. The new dimension will
be placed after this dimension.
EssException
- if an error occurs.public IEssDimension createAttributeDimension(java.lang.String dimName, IEssDimension.EEssAttributeDataType attrDataType, IEssDimension prevSibling) throws 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.
EssException
- if an error occurs.public IEssIterator getDimensions() throws EssException
EssException
- if an error occurs.public void moveMember(IEssMember mbrToMove, IEssMember newParent, IEssMember newPrevSibling) throws EssException
mbrToMove
- The member to movenewParent
- The new parent. Use this field only if the
newPrevSibling field is null.newPrevSibling
- The new previous sibling.
EssException
- if an error occurs.public IEssMember findMember(java.lang.String mbrName) throws EssException
mbrName
- The member name to find.
EssException
- if an error occurs. If the member is not found,
the error code is set to ERROR_OBJECT_NOT_FOUND.public IEssIterator findMembers(java.lang.String[] mbrNames) throws EssException
EssException
- if an error occurs. If the member is not found,
the error code is set to ERROR_OBJECT_NOT_FOUND.public IEssDimension findDimension(java.lang.String mbrName) throws EssException
mbrName
- The member name.
EssException
- if an error occurs. If the dimension is not found,
the error code is set to ERROR_OBJECT_NOT_FOUND.public void restructureCube(IEssCube.EEssRestructureOption restructOption) throws EssException
restructOption
- The restructure option.
EssException
- if an error occurs.public void createAliasTable(java.lang.String aliasTableName) throws EssException
aliasTableName
- The name of alias table to create.
EssException
- if an error occurs.public void copyAliasTable(java.lang.String srcAliasTableName, java.lang.String destAliasTableName, boolean merge) throws 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.
EssException
- if an error occurs.public void renameAliasTable(java.lang.String aliasTableName, java.lang.String newAliasTableName) throws EssException
aliasTableName
- The name of alias table to rename.newAliasTableName
- The new name for alias table.
EssException
- if an error occurs.public void clearAliasTable(java.lang.String aliasTableName) throws EssException
aliasTableName
- The name of alias table to clear. Use null or
"Default" for the default table.
EssException
- if an error occurs.public void deleteAliasTable(java.lang.String aliasTableName) throws EssException
aliasTableName
- The name of alias table to delete.
EssException
- if an error occurs.public IEssMember findAlias(java.lang.String aliasName, java.lang.String aliasTableName) throws EssException
aliasName
- The alias name to find member for.aliasTableName
- The alias table name which provides the alias.
EssException
- if an error occurs. If the member is not found,
the error code is set to ERROR_OBJECT_NOT_FOUND.public java.lang.String getDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) throws 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 used
EssException
- if an error occurs.public void setDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName, java.lang.String alias) throws 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.
EssException
- if an error occurs.public void deleteDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) throws 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.
EssException
- if an error occurs.public void enableDTSMember(java.lang.String dtsMemberName, int genNum, boolean enable) throws EssException
dtsMemberName
- The name of the DTS member.genNum
- The generation to assign to the DTS member.enable
- true to enable the DTS member.
EssException
- if an error occurs.public int getCountEnabledDTSMembers() throws EssException
EssException
- if an error occurs.public java.lang.String getEnabledDTSMember(int index) throws EssException
index
- The index where to get the DTS member from. This should be
between 0 and the value returned by getCountEnabledDTSMembers().
EssException
- if an error occurs.public int getGenerationForEnabledDTSMember(int index) throws EssException
index
- The index where to get the DTS member from. This should be
between 0 and the value returned by getCountEnabledDTSMembers().
EssException
- if an error occurs.public IEssCubeOutline generateCurrencyOutline() throws EssException
EssException
- if an error occurs.public void associateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim) throws EssException
standardDim
- The standard or base dimension.attributeDim
- The attribute dimension.
EssException
- if an error occurs.public void disassociateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim) throws EssException
standardDim
- The standard or base dimension.attributeDim
- The attribute dimension.
EssException
- if an error occurs.public void associateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr) throws EssException
standardMbr
- The standard or base member.attributeMbr
- The attribute member.
EssException
- if an error occurs.public void associateAttributeMember(java.lang.String standardMbrName, java.lang.String attributeMbrName) throws EssException
standardMbrName
- The standard or base member name.attributeMbrName
- The attribute member name.
EssException
- if an error occurs.public void disassociateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr) throws EssException
standardMbr
- The standard or base member.attributeMbr
- The attribute member.
EssException
- if an error occurs.public IEssIterator findAttributeMembers(java.lang.String attShortName, java.lang.String dimName) throws 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.
EssException
- if an error occurs.public IEssIterator getSharedMembers(java.lang.String mbrName) throws EssException
EssException
- if an error occurs.public IEssIterator executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) throws EssException
EssException
- if an error occurs.public IEssIterator executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection) throws EssException
EssException
- if an error occurs.public IEssCube getCube() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |