Package com.microstrategy.web.app.beans

Class XDADataExplorerBeanImpl

java.lang.Object

com.microstrategy.utils.serialization.AbstractPersistable

com.microstrategy.web.beans.AbstractTransformable

com.microstrategy.web.beans.AbstractWebComponent

com.microstrategy.web.app.beans.AbstractAppComponent

com.microstrategy.web.app.beans.AbstractPersistableAppComponent

com.microstrategy.web.app.beans.AbstractPersistableFrameElement

com.microstrategy.web.app.beans.AbstractObjectExplorerBean

com.microstrategy.web.app.beans.XDADataExplorerBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, ObjectExplorerBean, XDADataExplorerBean, RequestPersistable, Transformable, WebComponent

public class XDADataExplorerBeanImpl
extends AbstractObjectExplorerBean
implements XDADataExplorerBean

Since:

MicroStrategy Web 8.0.2

Field Summary

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

STATE_DELIMITOR, STATE_ITEM_SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

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

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

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

BROWSE_LEVEL_CATALOGS, BROWSE_LEVEL_CUBES, BROWSE_LEVEL_DATA_SOURCES, BROWSE_LEVEL_DIMENSIONS, BROWSE_LEVEL_ELEMENTS, BROWSE_LEVEL_HIERARCHIES

Constructor Summary

Constructors

Constructor	Description
XDADataExplorerBeanImpl()

Method Summary

Modifier and Type	Method	Description
void	doCollectData()	Extends collectData to prune the current unit, if necessary.
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Proceses the save/restore state opperation of the AppComponent
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
java.util.ArrayList	getAncestors()	Returns a list of the current element's ancestors if the curretn element is a WebDisplayUnit
java.util.ArrayList	getContents()	Returns a list with the WebMDXDisplayUnit children of the current element.
java.util.ArrayList	getContents(boolean sortAscending)	Returns a sorted list with the WebMDXDisplayUnit children of the current element.
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
WebDisplayUnit	getCurrentUnit()	Returns the element whose contents are displayed by the browser
java.util.ArrayList	getLinks()	An instance of XDADataExplorerBeanImpl does not support shortcuts.
int	getObjectCount()
java.lang.String	getSearchName()	Not supported.
int	getTotalObjectCount()	Returns the total number children of the current element.
boolean	isTargetingFilter()	This method returns a boolean value indicating if the data explorer is targeting the filter.
protected WebEventHandler	newDefaultEventHandler()
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 class com.microstrategy.web.app.beans.AbstractObjectExplorerBean

getBlockBegin, getBlockCount, getErrorMessage, getTypeRestriction, setBlockBegin, setBlockCount, setErrorMessage, setTypeRestriction

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isEditor, isGridDataNecessary, isIFrameEnabled, isOpen, setIsOpen, setUseIFrame

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getBlockBegin, getBlockCount, getErrorMessage, getTypeRestriction, setBlockBegin, setBlockCount, setErrorMessage, setTypeRestriction

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState

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

restoreStateFromRequest, restoreStateFromRequest

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

Constructor Detail

XDADataExplorerBeanImpl

public XDADataExplorerBeanImpl()

Method Detail

doCollectData

public void doCollectData()

Extends collectData to prune the current unit, if necessary.

Overrides:

doCollectData in class AbstractPersistableFrameElement

getAncestors

public java.util.ArrayList getAncestors()

Returns a list of the current element's ancestors if the curretn element is a WebDisplayUnit

Specified by:

getAncestors in interface ObjectExplorerBean

Returns:

ArrayList list of the current element's ancestors

getAncestorBrowseLevel

public int getAncestorBrowseLevel(WebDisplayUnit du)

Description copied from interface: XDADataExplorerBean

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

Specified by:

getAncestorBrowseLevel in interface XDADataExplorerBean

Parameters:

du - WebDisplayUnit

Returns:

int

See Also:

XDADataExplorerBean.getAncestorBrowseLevel(WebDisplayUnit)

getAncestorPath

public java.lang.String getAncestorPath(WebMDXDisplayUnit du)

Description copied from interface: XDADataExplorerBean

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

Specified by:

getAncestorPath in interface XDADataExplorerBean

Parameters:

du - ancestor unit

Returns:

the unit path

getContents

public java.util.ArrayList getContents()

Returns a list with the WebMDXDisplayUnit children of the current element. The current element is an instance of WebDisplayUnit

Specified by:

getContents in interface ObjectExplorerBean

Returns:

ArrayList list of the current element's contents

getContents

public java.util.ArrayList getContents(boolean sortAscending)

Returns a sorted list with the WebMDXDisplayUnit children of the current element. The current element is an instance of WebDisplayUnit

Specified by:

getContents in interface ObjectExplorerBean

Parameters:

sortAscending - boolean that indicated the order of the sort method
ascending = true
descending = false

Returns:

ArrayList list of the current element's contents

getLinks

public java.util.ArrayList getLinks()

An instance of XDADataExplorerBeanImpl does not support shortcuts.

Specified by:

getLinks in interface ObjectExplorerBean

Returns:

null.

getTotalObjectCount

public int getTotalObjectCount()

Returns the total number children of the current element.

Specified by:

getTotalObjectCount in interface ObjectExplorerBean

Returns:

int number children of the current element

getObjectCount

public int getObjectCount()

Specified by:

getObjectCount in interface ObjectExplorerBean

Returns:

the number of objects contained in the object's current block.

See Also:

getTotalObjectCount()

getCurrentUnit

public WebDisplayUnit getCurrentUnit()

Returns the element whose contents are displayed by the browser

Specified by:

getCurrentUnit in interface ObjectExplorerBean

Returns:

WebDisplayUnit

setCurrentUnitProperties

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

Description copied from interface: XDADataExplorerBean

Sets the browse level and current unit id.

Specified by:

setCurrentUnitProperties in interface XDADataExplorerBean

Parameters:

browseLevel - int

currentUnitId - String

See Also:

XDADataExplorerBean.setCurrentUnitProperties(int, String)

setCurrentBrowseLevel

public void setCurrentBrowseLevel(int browseLevel)

Description copied from interface: XDADataExplorerBean

Set the current browse level of the bean

Specified by:

setCurrentBrowseLevel in interface XDADataExplorerBean

See Also:

XDADataExplorerBean.setCurrentBrowseLevel(int)

getCurrentBrowseLevel

public int getCurrentBrowseLevel()

Description copied from interface: XDADataExplorerBean

Returns the current browse level of the bean

Specified by:

getCurrentBrowseLevel in interface XDADataExplorerBean

See Also:

XDADataExplorerBean.getCurrentBrowseLevel()

getCurrentPath

public java.lang.String getCurrentPath()

Description copied from interface: XDADataExplorerBean

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

Specified by:

getCurrentPath in interface XDADataExplorerBean

Returns:

current metric folder path

isTargetingFilter

public boolean isTargetingFilter()

Description copied from interface: XDADataExplorerBean

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

Specified by:

isTargetingFilter in interface XDADataExplorerBean

Returns:

boolean

See Also:

XDADataExplorerBean.isTargetingFilter()

getSearchName

public java.lang.String getSearchName()

Not supported.

Specified by:

getSearchName in interface ObjectExplorerBean

Returns:

null

doFlatState

protected void doFlatState(FlatStateSerializer serializer,
                           int howMuchState,
                           FlatStateTokenizer tokenizer)

Description copied from class: AbstractPersistableAppComponent

Proceses the save/restore state opperation of the AppComponent

Overrides:

doFlatState in class AbstractPersistableAppComponent

Parameters:

serializer - an instance of the FlatStateSerializer object to use

howMuchState - defines how much information needs to be saved

tokenizer - an instance of the FlatStateTokenizer object to use

See Also:

AbstractPersistableAppComponent.doFlatState(FlatStateSerializer, int, FlatStateTokenizer)

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent

Since:

MicroStrategy Web 9.0.0