Package com.microstrategy.web.app.beans

Class DatasetObjectExplorerBeanImpl

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.FolderObjectExplorerBeanImpl

com.microstrategy.web.app.beans.DatasetObjectExplorerBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, DatasetObjectExplorerBean, FolderObjectExplorerBean, ObjectExplorerBean, RequestPersistable, Transformable, WebComponent

public class DatasetObjectExplorerBeanImpl
extends FolderObjectExplorerBeanImpl
implements DatasetObjectExplorerBean

Implementation of the DatasetObjectExplorerBean that represents an editor used to browse the contents of a FolderBean within a dataset link context

Since:

MicroStrategy Web 8.1.0

Field Summary

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

_ancestors, _rootSysFolder, _trimedAncestors

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

Constructor Summary

Constructors

Constructor	Description
DatasetObjectExplorerBeanImpl()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Proceses the save/restore state opperation of the AppComponent
java.lang.String	getBaseFolderId()
java.lang.String	getFolderId()
java.util.ArrayList	getLinks()
java.lang.String	getTargetTemplateKey()
int	getXMLStatus()	Returns the EnumRequestStatus status of the component.
boolean	isRestrictBrowse()
boolean	isRootFolder()
protected WebEventHandler	newDefaultEventHandler()
void	setFolderId(java.lang.String folderId)	Set the folder identifier where the explorer will be opened by default
void	setRestrictBrowse(boolean value)	Define whether the user will be able to browse above (or parents) the folder specified as base for this explorer
void	setTargetTemplateKey(java.lang.String key)	Set the key of the template to be the target of the manipulation requested with this explorer
protected void	setupFolderBean()	Initialize a FolderBean instance in order to process the folder information to be displayed as part of the explorer bean's interface

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

doCollectData, getAncestors, getConfiguredRootFolderID, getContents, getContents, getContextID, getCurrentUnit, getFolderBean, getFolderBeanName, getFolderFromFolderLink, getLinksContextID, getObjectCount, getProjectID, getRenderRoot, getRootFolderID, getSearchName, getTotalObjectCount, getTrimedAncestors, handleRequest, isExcludeShortcut, isQuickSearch, resetFolderBean, restoreTypeRestrictions, setContextID, setExcludeShortcut, setIgnoreAccessDenialError, setQuickSearch, setRenderRoot

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, 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, 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.FolderObjectExplorerBean

getConfiguredRootFolderID, getContextID, getFolderBean, getLinksContextID, getRenderRoot, getRootFolderID, getTrimedAncestors, isExcludeShortcut, isQuickSearch, resetFolderBean, setContextID, setExcludeShortcut, setQuickSearch, setRenderRoot

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

getAncestors, getBlockBegin, getBlockCount, getContents, getContents, getCurrentUnit, getErrorMessage, getObjectCount, getSearchName, getTotalObjectCount, 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, 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

DatasetObjectExplorerBeanImpl

public DatasetObjectExplorerBeanImpl()

Default constructor

Method Detail

getFolderId

public java.lang.String getFolderId()

Specified by:

getFolderId in interface DatasetObjectExplorerBean

Returns:

the folder identifier where the explorer will be opened by default

setFolderId

public void setFolderId(java.lang.String folderId)

Set the folder identifier where the explorer will be opened by default

Specified by:

setFolderId in interface DatasetObjectExplorerBean

Parameters:

folderId - String

getTargetTemplateKey

public java.lang.String getTargetTemplateKey()

Specified by:

getTargetTemplateKey in interface DatasetObjectExplorerBean

Returns:

String value with the key of the template to be the target of the manipulation requested with this explorer

setTargetTemplateKey

public void setTargetTemplateKey(java.lang.String key)

Description copied from interface: DatasetObjectExplorerBean

Set the key of the template to be the target of the manipulation requested with this explorer

Specified by:

setTargetTemplateKey in interface DatasetObjectExplorerBean

Parameters:

key - String value with the target template key

getBaseFolderId

public java.lang.String getBaseFolderId()

Specified by:

getBaseFolderId in interface DatasetObjectExplorerBean

Returns:

String value with the id of the folder indicated to be the base, or starting point, for the explorer

isRestrictBrowse

public boolean isRestrictBrowse()

Specified by:

isRestrictBrowse in interface DatasetObjectExplorerBean

Returns:

boolean value indicating if the browsing action has been restricted for the user

setRestrictBrowse

public void setRestrictBrowse(boolean value)

Description copied from interface: DatasetObjectExplorerBean

Define whether the user will be able to browse above (or parents) the folder specified as base for this explorer

Specified by:

setRestrictBrowse in interface DatasetObjectExplorerBean

Parameters:

value - boolean indicating if the browsing action has been restricted for the user

getXMLStatus

public int getXMLStatus()

Description copied from class: AbstractAppComponent

Returns the EnumRequestStatus status of the component. The status determined by by the status of its children with the following precedence.

EnumRequestStatus.WebBeanRequestEndsInError EnumRequestStatus.WebBeanRequestCanceled EnumRequestStatus.WebBeanRequestProcessing EnumRequestStatus.WebBeanRequestNotInitiated EnumRequestStatus.WebBeanRequestWaitingForUserInput EnumRequestStatus.WebBeanRequestSuccessful

Specified by:

getXMLStatus in interface WebComponent

Overrides:

getXMLStatus in class AbstractAppComponent

Returns:

an EnumRequestStatus enumeration value for the component.

setupFolderBean

protected void setupFolderBean()

Description copied from class: FolderObjectExplorerBeanImpl

Initialize a FolderBean instance in order to process the folder information to be displayed as part of the explorer bean's interface

Overrides:

setupFolderBean in class FolderObjectExplorerBeanImpl

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 FolderObjectExplorerBeanImpl

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

isRootFolder

public boolean isRootFolder()

Specified by:

isRootFolder in interface DatasetObjectExplorerBean

Returns:

boolean value indicating if the current folder being viewed on the explorer is the root, as indicated on the folder links configuration

getLinks

public java.util.ArrayList getLinks()

Specified by:

getLinks in interface ObjectExplorerBean

Overrides:

getLinks in class FolderObjectExplorerBeanImpl

Returns:

an List of WebDisplayUnit objects that represent the project links.

See Also:

ObjectExplorerBean.getLinks()

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class FolderObjectExplorerBeanImpl

Since:

MicroStrategy Web 9.0.0