Package com.microstrategy.web.app.beans

Class FolderObjectExplorerBeanImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AllObjectBrowserBeanImpl, DatasetObjectExplorerBeanImpl

public class FolderObjectExplorerBeanImpl
extends AbstractObjectExplorerBean
implements FolderObjectExplorerBean

Implementation of the FolderObjectExplorerBean that represents an editor used to browse the contents of a FolderBean

Since:

MicroStrategy Web 8.0.2

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.ArrayList	_ancestors
protected int	_rootSysFolder
protected java.util.ArrayList	_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
FolderObjectExplorerBeanImpl()

Method Summary

Modifier and Type	Method	Description
void	doCollectData()	Extends collectData by initializing the folder bean
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Proceses the save/restore state opperation of the AppComponent
java.util.ArrayList	getAncestors()
java.lang.String	getConfiguredRootFolderID()	Gets the root folder specified in the context
java.util.ArrayList	getContents()
java.util.ArrayList	getContents(boolean sortAscending)
int	getContextID()
WebDisplayUnit	getCurrentUnit()
FolderBean	getFolderBean()
protected java.lang.String	getFolderBeanName()
protected WebFolder	getFolderFromFolderLink(FolderLink fl)
java.util.ArrayList	getLinks()
int	getLinksContextID()	get the contextID used by links
int	getObjectCount()
protected java.lang.String	getProjectID()	Get the Project ID from the session manager
boolean	getRenderRoot()
java.lang.String	getRootFolderID()	This method returns the ID of the root folder of the editor it can be read either from the list of configured links or a plugin
java.lang.String	getSearchName()
int	getTotalObjectCount()
java.util.ArrayList<WebDisplayUnit>	getTrimedAncestors()	Get an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders), it will trim the user profile folder if it is in the ancestor list
boolean	handleRequest(RequestKeys keys)	Handles the request specified by the RequestKeys instance.
boolean	isExcludeShortcut()	Set flag to exclude Shortcut objects from search results
boolean	isQuickSearch()
protected WebEventHandler	newDefaultEventHandler()
void	resetFolderBean()
protected void	restoreTypeRestrictions(boolean restoring, FlatStateSerializer serializer, FlatStateTokenizer tokenizer)
void	setContextID(int contextID)	Sets the context id.
void	setExcludeShortcut(boolean excludeShortcut)	Set flag to exclude Shortcut objects from search results
void	setIgnoreAccessDenialError(boolean ignoreAccessDenialError)
void	setQuickSearch(boolean quickSearch)	set flag whether to use Quick Search engine
void	setRenderRoot(boolean renderRoot)
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.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, 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, 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

_rootSysFolder

protected int _rootSysFolder

_ancestors

protected java.util.ArrayList _ancestors

_trimedAncestors

protected java.util.ArrayList _trimedAncestors

Constructor Detail

FolderObjectExplorerBeanImpl

public FolderObjectExplorerBeanImpl()

Method Detail

handleRequest

public boolean handleRequest(RequestKeys keys)
                      throws WebException

Description copied from class: AbstractWebComponent

Handles the request specified by the RequestKeys instance. The RequestKeys object might contain all information sent from the Web browser along with any cookies, session variables, etc. Most importantly, it contains WebEvent related information. If this instance in the namespace of the src request key attribute, it will forward the request to its associated event handler.

Specified by:

handleRequest in interface WebComponent

Overrides:

handleRequest in class AbstractWebComponent

Parameters:

keys - the RequestKeys object.

Returns:

true if the request is successfully handled; false if the request or event is not supported.

Throws:

WebException - thrown if there is any error occurred when handling the request.

doCollectData

public void doCollectData()

Extends collectData by initializing the folder bean

Overrides:

doCollectData in class AbstractPersistableFrameElement

getAncestors

public java.util.ArrayList getAncestors()

Specified by:

getAncestors in interface ObjectExplorerBean

Returns:

an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders)

See Also:

ObjectExplorerBean.getAncestors()

getTrimedAncestors

public java.util.ArrayList<WebDisplayUnit> getTrimedAncestors()

Description copied from interface: FolderObjectExplorerBean

Get an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders), it will trim the user profile folder if it is in the ancestor list

Specified by:

getTrimedAncestors in interface FolderObjectExplorerBean

Returns:

getContents

public java.util.ArrayList getContents()

Specified by:

getContents in interface ObjectExplorerBean

Returns:

an List of WebDisplayUnit objects that represent the objects contained inside the current object (folder). The type of objects can be specified using the typeRestriction property

See Also:

ObjectExplorerBean.getContents()

getContents

public java.util.ArrayList getContents(boolean sortAscending)

Specified by:

getContents in interface ObjectExplorerBean

Parameters:

sortAscending - specifies if the results should be sorted ascending or descending.

Returns:

an List of WebDisplayUnit objects that represent the objects contained inside the current object (folder). The type of objects can be specified using the typeRestriction property

See Also:

ObjectExplorerBean.getContents(boolean)

isExcludeShortcut

public boolean isExcludeShortcut()

Description copied from interface: FolderObjectExplorerBean

Set flag to exclude Shortcut objects from search results

Specified by:

isExcludeShortcut in interface FolderObjectExplorerBean

setExcludeShortcut

public void setExcludeShortcut(boolean excludeShortcut)

Description copied from interface: FolderObjectExplorerBean

Set flag to exclude Shortcut objects from search results

Specified by:

setExcludeShortcut in interface FolderObjectExplorerBean

isQuickSearch

public boolean isQuickSearch()

Specified by:

isQuickSearch in interface FolderObjectExplorerBean

setQuickSearch

public void setQuickSearch(boolean quickSearch)

Description copied from interface: FolderObjectExplorerBean

set flag whether to use Quick Search engine

Specified by:

setQuickSearch in interface FolderObjectExplorerBean

getFolderBean

public FolderBean getFolderBean()

Specified by:

getFolderBean in interface FolderObjectExplorerBean

Returns:

the FolderBean that represents the objects contained by the editor

See Also:

FolderObjectExplorerBean.getFolderBean()

getFolderBeanName

protected java.lang.String getFolderBeanName()

Returns:

The name of the FolderBean created by getFolderBean()

Since:

MicroStrategy Web 9.0.1

setupFolderBean

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

getLinks

public java.util.ArrayList getLinks()

Specified by:

getLinks in interface ObjectExplorerBean

Returns:

an List of WebDisplayUnit objects that represent the project links.

See Also:

ObjectExplorerBean.getLinks()

getFolderFromFolderLink

protected WebFolder getFolderFromFolderLink(FolderLink fl)

getCurrentUnit

public WebDisplayUnit getCurrentUnit()

Specified by:

getCurrentUnit in interface ObjectExplorerBean

Returns:

a WebDisplayUnit that represents the current object

See Also:

ObjectExplorerBean.getCurrentUnit()

getTotalObjectCount

public int getTotalObjectCount()

Specified by:

getTotalObjectCount in interface ObjectExplorerBean

Returns:

the total number of objects contained in the current object

See Also:

ObjectExplorerBean.getTotalObjectCount()

getContextID

public int getContextID()

Specified by:

getContextID in interface FolderObjectExplorerBean

Returns:

the context id. A value from EnumObjectBrowserContexts used to obtain the links

See Also:

ObjectExplorerBean.getSearchName()

getLinksContextID

public int getLinksContextID()

get the contextID used by links

Specified by:

getLinksContextID in interface FolderObjectExplorerBean

Returns:

the context id used to retrieve links

Since:

MicroStrategy Web 9.0.0

setContextID

public void setContextID(int contextID)

Description copied from interface: FolderObjectExplorerBean

Sets the context id. A value from EnumObjectBrowserContexts used to obtain the links

Specified by:

setContextID in interface FolderObjectExplorerBean

Parameters:

contextID - the context id. A value from EnumObjectBrowserContexts used to obtain the links

See Also:

FolderObjectExplorerBean.setContextID(int)

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

restoreTypeRestrictions

protected void restoreTypeRestrictions(boolean restoring,
                                       FlatStateSerializer serializer,
                                       FlatStateTokenizer tokenizer)

Since:

MicroStrategy Web 9.0.0

getSearchName

public java.lang.String getSearchName()

Specified by:

getSearchName in interface ObjectExplorerBean

Returns:

The current search name if any.

See Also:

ObjectExplorerBean.getSearchName()

getObjectCount

public int getObjectCount()

Specified by:

getObjectCount in interface ObjectExplorerBean

Returns:

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

See Also:

ObjectExplorerBean.getObjectCount()

resetFolderBean

public void resetFolderBean()

Specified by:

resetFolderBean in interface FolderObjectExplorerBean

Since:

MicroStrategy Web 9.0.0

getConfiguredRootFolderID

public java.lang.String getConfiguredRootFolderID()
                                           throws WebObjectsException

Description copied from interface: FolderObjectExplorerBean

Gets the root folder specified in the context

Specified by:

getConfiguredRootFolderID in interface FolderObjectExplorerBean

Throws:

WebObjectsException

getRootFolderID

public java.lang.String getRootFolderID()

This method returns the ID of the root folder of the editor it can be read either from the list of configured links or a plugin

Specified by:

getRootFolderID in interface FolderObjectExplorerBean

Returns:

the id of the root folder the FolderBean is based on when browsing

Since:

MicroStrategy Web 9.0.0

getProjectID

protected java.lang.String getProjectID()

Get the Project ID from the session manager

Returns:

String projectID

getRenderRoot

public boolean getRenderRoot()

Specified by:

getRenderRoot in interface FolderObjectExplorerBean

Since:

MicroStrategy Web 9.0.0

setRenderRoot

public void setRenderRoot(boolean renderRoot)

Specified by:

setRenderRoot in interface FolderObjectExplorerBean

Since:

MicroStrategy Web 9.0.0

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent

Since:

MicroStrategy Web 9.0.0

setIgnoreAccessDenialError

public void setIgnoreAccessDenialError(boolean ignoreAccessDenialError)