Package com.microstrategy.web.app.beans

Interface XDADataExplorerBean

All Superinterfaces:

AppComponent, ObjectExplorerBean, Transformable, WebComponent

All Known Implementing Classes:

XDADataExplorerBeanImpl

public interface XDADataExplorerBean
extends ObjectExplorerBean

This interface extends the ObjectExplorerBean by adding information specific to XDA elements

Since:

MicroStrategy Web 8.0.2

Field Summary

Fields

Modifier and Type	Field	Description
static int	BROWSE_LEVEL_CATALOGS
static int	BROWSE_LEVEL_CUBES
static int	BROWSE_LEVEL_DATA_SOURCES
static int	BROWSE_LEVEL_DIMENSIONS
static int	BROWSE_LEVEL_ELEMENTS
static int	BROWSE_LEVEL_HIERARCHIES

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
int	getAncestorBrowseLevel(WebDisplayUnit du)	This method returns an integer representing browse level of the ancestor WebDisplayUnit provided.
java.lang.String	getAncestorPath(WebMDXDisplayUnit du)	Returns the path for a unit that is an ancestor of the current unit
int	getCurrentBrowseLevel()	Returns the current browse level of the bean
java.lang.String	getCurrentPath()	Returns current metric folder path or empty string if the current unit is not a metric folder
boolean	isTargetingFilter()	This method returns a boolean value indicating if the data explorer is targeting the filter.
void	setCurrentBrowseLevel(int browseLevel)	Set the current browse level of the bean
void	setCurrentUnitProperties(int browseLevel, java.lang.String currentUnitId)	Sets the browse level and current unit id.

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.ObjectExplorerBean

getAncestors, getBlockBegin, getBlockCount, getContents, getContents, getCurrentUnit, getErrorMessage, getLinks, getObjectCount, getSearchName, getTotalObjectCount, getTypeRestriction, setBlockBegin, setBlockCount, setErrorMessage, setTypeRestriction

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Field Detail

BROWSE_LEVEL_DATA_SOURCES

static final int BROWSE_LEVEL_DATA_SOURCES

See Also:

Constant Field Values

BROWSE_LEVEL_CATALOGS

static final int BROWSE_LEVEL_CATALOGS

See Also:

Constant Field Values

BROWSE_LEVEL_CUBES

static final int BROWSE_LEVEL_CUBES

See Also:

Constant Field Values

BROWSE_LEVEL_DIMENSIONS

static final int BROWSE_LEVEL_DIMENSIONS

See Also:

Constant Field Values

BROWSE_LEVEL_HIERARCHIES

static final int BROWSE_LEVEL_HIERARCHIES

See Also:

Constant Field Values

BROWSE_LEVEL_ELEMENTS

static final int BROWSE_LEVEL_ELEMENTS

See Also:

Constant Field Values

Method Detail

getCurrentBrowseLevel

int getCurrentBrowseLevel()

Returns the current browse level of the bean

setCurrentBrowseLevel

void setCurrentBrowseLevel(int browseLevel)

Set the current browse level of the bean

Parameters:

browseLevel -

setCurrentUnitProperties

void setCurrentUnitProperties(int browseLevel,
                              java.lang.String currentUnitId)

Sets the browse level and current unit id.

Parameters:

browseLevel - int

currentUnitId - String

getAncestorBrowseLevel

int getAncestorBrowseLevel(WebDisplayUnit du)

This method returns an integer representing browse level of the ancestor WebDisplayUnit provided.

Parameters:

du - WebDisplayUnit

Returns:

int

isTargetingFilter

boolean isTargetingFilter()

This method returns a boolean value indicating if the data explorer is targeting the filter.

Returns:

boolean

getCurrentPath

java.lang.String getCurrentPath()

Returns current metric folder path or empty string if the current unit is not a metric folder

Returns:

current metric folder path

getAncestorPath

java.lang.String getAncestorPath(WebMDXDisplayUnit du)

Returns the path for a unit that is an ancestor of the current unit

Parameters:

du - ancestor unit

Returns:

the unit path