|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssCubeView interface.
Nested Class Summary | |
static class |
IEssCubeView.EEssIndentStyle
The EEssIndentStyle is an enumeration of indent styles. |
static class |
IEssCubeView.EEssQueryGrammar
The EEssQueryGrammar class is an enumeration of query language grammars. |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Field Summary | |
static int |
PROP_ALIAS_TABLE_NAME
|
static int |
PROP_CONNECTION_POOL_NAME
|
static int |
PROP_DESCRIPTION
|
static int |
PROP_DISPLAY_UNKNOWN_MEMBERS
|
static int |
PROP_DRILL_LEVEL
|
static int |
PROP_ENABLE_HYBRID_ANALYSIS
|
static int |
PROP_INDENT_STYLE
|
static int |
PROP_IS_ALIAS_NAMES
|
static int |
PROP_IS_EMPTY_GRID_ERROR
|
static int |
PROP_IS_ENABLE_DATALESS_NAVIGATION
|
static int |
PROP_IS_INCLUDE_SELECTION
|
static int |
PROP_IS_REPEAT_MEMBER_NAMES
|
static int |
PROP_IS_SELECTION_ONLY
|
static int |
PROP_IS_SPECIFY_LATEST_MEMBER
|
static int |
PROP_IS_SUPPRESS_MISSING
|
static int |
PROP_IS_SUPPRESS_UNDERSCORE
|
static int |
PROP_IS_SUPPRESS_ZERO
|
static int |
PROP_IS_USE_BOTH_FOR_ROW_DIMENSIONS
|
static int |
PROP_IS_WITHIN_SELECTED_GROUP
|
static int |
PROP_LATEST_MEMBER_NAME
|
static int |
PROP_MID_TIER_CACHING_ENABLED
|
static int |
PROP_NAME
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
Method Summary | |
void |
close()
Closes the cube view. |
IEssOpCalculate |
createIEssOpCalculate()
Creates an object for the interface IEssOpCalculate. |
IEssOpKeepOnly |
createIEssOpKeepOnly()
Creates an object for the interface IEssOpKeepOnly. |
IEssOpLock |
createIEssOpLock()
Creates an object for the interface IEssOpLock. |
IEssOpMdxQuery |
createIEssOpMdxQuery()
Creates an object for the interface IEssOpMdxQuery. |
IEssOpPivot |
createIEssOpPivot()
Creates an object for the interface IEssOpPivot. |
IEssOpRemoveOnly |
createIEssOpRemoveOnly()
Creates an object for the interface IEssOpRemoveOnly. |
IEssOpReport |
createIEssOpReport()
Creates an object for the interface IEssOpReport. |
IEssOpRetrieve |
createIEssOpRetrieve()
Creates an object for the interface IEssOpRetrieve. |
IEssOpUndo |
createIEssOpUndo()
Creates an object for the interface IEssOpUndo. |
IEssOpUnlock |
createIEssOpUnlock()
Creates an object for the interface IEssOpUnlock. |
IEssOpUpdate |
createIEssOpUpdate()
Creates an object for the interface IEssOpUpdate. |
IEssOpZoomIn |
createIEssOpZoomIn()
Creates an object for the interface IEssOpZoomIn. |
IEssOpZoomOut |
createIEssOpZoomOut()
Creates an object for the interface IEssOpZoomOut. |
void |
emailOutput(java.lang.String to,
java.lang.String cc,
java.lang.String bcc,
java.lang.String subject)
Send an e-mail of the output to the specified recipients. |
java.lang.String |
getAliasTable()
Gets the alias table name. |
java.lang.String |
getConnectionPoolName()
Gets the name of the connection pool used. |
IEssCube |
getCube()
Gets the parent cube. |
java.lang.String |
getDescription()
Gets the cube view description. |
IEssOpZoomIn.EEssZoomInPreference |
getDrillLevel()
Gets the drill level. |
IEssGridView |
getGridView()
Gets the grid view of the cube view. |
java.lang.String |
getHtmlOutput()
Gets the HTML view of the output. |
IEssCubeView.EEssIndentStyle |
getIndentStyle()
Gets the indent style. |
java.lang.String |
getLatestMemberName()
Gets the latest member name. |
IEssMdDataSet |
getMdDataSet()
Gets the result after running MDX query operation. |
java.lang.String |
getName()
Gets the cube view name. |
boolean |
isAliasNames()
Checks if alias names. |
boolean |
isDatalessNavigation()
Checks if data less navigation is enabled. |
boolean |
isDisplayUnknownMembers()
Checks if to display unknown members in the grid. |
boolean |
isEmptyGridError()
Checks if to error on empty grid. |
boolean |
isHybridAnalysisEnabled()
Checks if hybrid analysis is enabled. |
boolean |
isIncludeSelection()
Checks if to include selection. |
boolean |
isMidTierCachingEnabled()
Checks if mid-tier caching is enabled. |
boolean |
isRepeatMemberNames()
Checks if to repeat member names. |
boolean |
isSelectionOnly()
Checks if selection only. |
boolean |
isSpecifyLatestMember()
Checks if to specify latest member. |
boolean |
isSuppressMissing()
Checks if suppress missing. |
boolean |
isSuppressUnderscore()
Checks if suppress underscore. |
boolean |
isSuppressZero()
Checks if suppress zero. |
boolean |
isUseBothForRowDimensions()
Checks if to use both for row dimensions. |
boolean |
isWithinSelectedGroup()
Checks if within selected group. |
IEssMember[] |
memberSelection(java.lang.String mbrName,
int queryType,
int queryOptions,
java.lang.String dimName,
java.lang.String input1,
java.lang.String input2)
Performs member selection. |
IEssMember[] |
memberSelection(java.lang.String mbrSel,
java.lang.String fldSel)
Performs member selection. |
void |
performOperation(IEssOperation operation)
Performs an operation on the cube view. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
save()
Saves the cube view to the domain store with the current name. |
void |
save(java.lang.String cubeViewName)
Saves the cube view to the domain store with the new name. |
void |
setAliasNames(boolean aliasNames)
Sets if alias names. |
void |
setAliasTable(java.lang.String aliasTableName)
Sets the alias table name. |
void |
setDatalessNavigation(boolean datalessNavigation)
Sets if data less navigation is enabled. |
void |
setDescription(java.lang.String description)
Sets the cube view description. |
void |
setDisplayUnknownMembers(boolean dispUnknown)
Sets if to display unknown members in the grid. |
void |
setDrillLevel(IEssOpZoomIn.EEssZoomInPreference drillLevel)
Sets the drill level. |
void |
setEmptyGridError(boolean emptyGridError)
Sets if to error on empty grid. |
void |
setHybridAnalysisEnabled(boolean enableHa)
Sets if hybrid analysis is enabled. |
void |
setIncludeSelection(boolean includeSelection)
Sets to include selection. |
void |
setIndentStyle(IEssCubeView.EEssIndentStyle indentStyle)
Sets the indent style. |
void |
setLatestMemberName(java.lang.String latestMemberName)
Sets the latest member name. |
void |
setMidTierCachingEnabled(boolean mtCachingEnabled)
Sets if mid-tier caching is enabled. |
void |
setRepeatMemberNames(boolean repeatMemberNames)
Sets to repeat member names. |
void |
setSelectionOnly(boolean selectionOnly)
Sets if selection only. |
void |
setSpecifyLatestMember(boolean specifyLatestMember)
Sets if to specify latest member. |
void |
setSuppressMissing(boolean suppressMissing)
Sets if suppress missing. |
void |
setSuppressUnderscore(boolean suppUnderscore)
Sets if suppress underscore. |
void |
setSuppressZero(boolean suppressZero)
Sets if suppress zero. |
void |
setUseBothForRowDimensions(boolean useBothForRowDimensions)
Sets if to use both for row dimensions. |
void |
setWithinSelectedGroup(boolean withinSelectedGroup)
Sets if within selected group. |
void |
updatePropertyValues()
Updates the property values. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
Field Detail |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_DRILL_LEVEL
public static final int PROP_IS_INCLUDE_SELECTION
public static final int PROP_IS_SELECTION_ONLY
public static final int PROP_IS_WITHIN_SELECTED_GROUP
public static final int PROP_INDENT_STYLE
public static final int PROP_IS_SUPPRESS_MISSING
public static final int PROP_IS_SUPPRESS_ZERO
public static final int PROP_IS_SUPPRESS_UNDERSCORE
public static final int PROP_IS_ALIAS_NAMES
public static final int PROP_ALIAS_TABLE_NAME
public static final int PROP_IS_ENABLE_DATALESS_NAVIGATION
public static final int PROP_IS_EMPTY_GRID_ERROR
public static final int PROP_IS_REPEAT_MEMBER_NAMES
public static final int PROP_IS_USE_BOTH_FOR_ROW_DIMENSIONS
public static final int PROP_IS_SPECIFY_LATEST_MEMBER
public static final int PROP_LATEST_MEMBER_NAME
public static final int PROP_MID_TIER_CACHING_ENABLED
public static final int PROP_CONNECTION_POOL_NAME
public static final int PROP_ENABLE_HYBRID_ANALYSIS
public static final int PROP_DISPLAY_UNKNOWN_MEMBERS
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs.refreshPropertyValues()
public void setDescription(java.lang.String description) throws EssException
description
- The cube view description.
EssException
- if an error occurs.updatePropertyValues()
public IEssOpZoomIn.EEssZoomInPreference getDrillLevel() throws EssException
EssException
- if an error occurs.public void setDrillLevel(IEssOpZoomIn.EEssZoomInPreference drillLevel) throws EssException
drillLevel
- The drill level (i.e zoom in preference).
EssException
- if an error occurs.public boolean isIncludeSelection() throws EssException
EssException
- if an error occurs.public void setIncludeSelection(boolean includeSelection) throws EssException
includeSelection
- true if to include selection.
EssException
- if an error occurs.public boolean isSelectionOnly() throws EssException
EssException
- if an error occurs.public void setSelectionOnly(boolean selectionOnly) throws EssException
selectionOnly
- true if selection only.
EssException
- if an error occurs.public boolean isWithinSelectedGroup() throws EssException
EssException
- if an error occurs.public void setWithinSelectedGroup(boolean withinSelectedGroup) throws EssException
withinSelectedGroup
- true if within selected group.
EssException
- if an error occurs.public IEssCubeView.EEssIndentStyle getIndentStyle() throws EssException
EssException
- if an error occurs.public void setIndentStyle(IEssCubeView.EEssIndentStyle indentStyle) throws EssException
indentStyle
- The indent style.
EssException
- if an error occurs.public boolean isSuppressMissing() throws EssException
EssException
- if an error occurs.public void setSuppressMissing(boolean suppressMissing) throws EssException
suppressMissing
- true if suppress missing.
EssException
- if an error occurs.public boolean isSuppressZero() throws EssException
EssException
- if an error occurs.public void setSuppressZero(boolean suppressZero) throws EssException
suppressZero
- true if suppress zero.
EssException
- if an error occurs.public boolean isSuppressUnderscore() throws EssException
EssException
- if an error occurs.public void setSuppressUnderscore(boolean suppUnderscore) throws EssException
suppUnderscore
- true if suppress underscore.
EssException
- if an error occurs.public boolean isAliasNames() throws EssException
EssException
- if an error occurs.public void setAliasNames(boolean aliasNames) throws EssException
EssException
- if an error occurs.public java.lang.String getAliasTable() throws EssException
EssException
- if an error occurs.public void setAliasTable(java.lang.String aliasTableName) throws EssException
aliasTableName
- The alias table name.
EssException
- if an error occurs.public boolean isDatalessNavigation() throws EssException
EssException
- if an error occurs.public void setDatalessNavigation(boolean datalessNavigation) throws EssException
datalessNavigation
- true if data less navigation.
EssException
- if an error occurs.public boolean isEmptyGridError() throws EssException
EssException
- if an error occurs.public void setEmptyGridError(boolean emptyGridError) throws EssException
emptyGridError
- Error on empty grid.
EssException
- if an error occurs.public boolean isRepeatMemberNames() throws EssException
EssException
- if an error occurs.public void setRepeatMemberNames(boolean repeatMemberNames) throws EssException
EssException
- if an error occurs.public boolean isUseBothForRowDimensions() throws EssException
EssException
- if an error occurs.public void setUseBothForRowDimensions(boolean useBothForRowDimensions) throws EssException
useBothForRowDimensions
- true to use both for row dimensions
EssException
- if an error occurs.public boolean isSpecifyLatestMember() throws EssException
EssException
- if an error occurs.public void setSpecifyLatestMember(boolean specifyLatestMember) throws EssException
specifyLatestMember
- true to specify latest member.
EssException
- if an error occurs.public java.lang.String getLatestMemberName() throws EssException
EssException
- if an error occurs.public void setLatestMemberName(java.lang.String latestMemberName) throws EssException
latestMemberName
- The latest member name.
EssException
- if an error occurs.public boolean isMidTierCachingEnabled() throws EssException
EssException
- if an error occurs.public void setMidTierCachingEnabled(boolean mtCachingEnabled) throws EssException
EssException
- if an error occurs.public java.lang.String getConnectionPoolName() throws EssException
EssException
- if an error occurs.public boolean isHybridAnalysisEnabled() throws EssException
EssException
- if an error occurs.public void setHybridAnalysisEnabled(boolean enableHa) throws EssException
enableHa
- true to enable hybrid analysis.
EssException
- if an error occurs.public boolean isDisplayUnknownMembers() throws EssException
EssException
- if an error occurs.public void setDisplayUnknownMembers(boolean dispUnknown) throws EssException
dispUnknown
- true to display unknown members.
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void performOperation(IEssOperation operation) throws EssException
operation
- The operation.
EssException
- if an error occurs.public IEssMember[] memberSelection(java.lang.String mbrSel, java.lang.String fldSel) throws EssException
EssException
public IEssMember[] memberSelection(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) throws EssException
EssException
public IEssGridView getGridView() throws EssException
EssException
- if an error occurs.public void emailOutput(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject) throws EssException
to
- To recipient names.cc
- Cc receipient names.subject
- The subject for the message.
EssException
- if an error occurs.public java.lang.String getHtmlOutput() throws EssException
EssException
- if an error occurs.public void save() throws EssException
EssException
- if an error occurs.public void save(java.lang.String cubeViewName) throws EssException
EssException
- if an error occurs.public void close() throws EssException
EssException
- if an error occurs.public IEssOpZoomIn createIEssOpZoomIn() throws EssException
EssException
- if an error occurs.public IEssOpZoomOut createIEssOpZoomOut() throws EssException
EssException
- if an error occurs.public IEssOpPivot createIEssOpPivot() throws EssException
EssException
- if an error occurs.public IEssOpKeepOnly createIEssOpKeepOnly() throws EssException
EssException
- if an error occurs.public IEssOpRemoveOnly createIEssOpRemoveOnly() throws EssException
EssException
- if an error occurs.public IEssOpRetrieve createIEssOpRetrieve() throws EssException
EssException
- if an error occurs.public IEssOpMdxQuery createIEssOpMdxQuery() throws EssException
EssException
- if an error occurs.public IEssOpReport createIEssOpReport() throws EssException
EssException
- if an error occurs.public IEssOpLock createIEssOpLock() throws EssException
EssException
- if an error occurs.public IEssOpUnlock createIEssOpUnlock() throws EssException
EssException
- if an error occurs.public IEssOpUpdate createIEssOpUpdate() throws EssException
EssException
- if an error occurs.public IEssOpUndo createIEssOpUndo() throws EssException
EssException
- if an error occurs.public IEssOpCalculate createIEssOpCalculate() throws EssException
EssException
- if an error occurs.public IEssMdDataSet getMdDataSet() 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 |