Package com.microstrategy.web.app.beans

Class ProjectBrowserBeanImpl

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

com.microstrategy.web.app.beans.ProjectBrowserBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, FrameElement, ProjectBrowser, ReportFrameElement, ViewBeanParserBean, RequestPersistable, Transformable, WebComponent

public class ProjectBrowserBeanImpl
extends AbstractViewBeanParserBean
implements ProjectBrowser

Title:

Description:

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Since:

MicroStrategy Web 9.0.0

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

LIST_DISPLAY_FORMAT, REQUEST_FROM_DATA_EXPLORER, TREE_DISPLAY_FORMAT

Constructor Summary

Constructors

Constructor	Description
ProjectBrowserBeanImpl()

Method Summary

Modifier and Type	Method	Description
void	collectData()	Triggers execution to the back end no matter whether it is synchronous or asynchronous.
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Speciefies which bean's properties are persisted.
int	getMaximumStateLevel()	Returns the maximum state level that is supported by the WebComponent.
int	getXMLStatus()	Returns the EnumRequestStatus status of the component.
boolean	hasChanged()	Verifies the state of the component has changed
boolean	isDataExplorerOpen()
boolean	isEnabled()	Checks if a bean is enabled
boolean	isTargetingFilter()
boolean	isTargetingTemplate()
protected WebEventHandler	newDefaultEventHandler()
void	setDataExplorerStatus(boolean isOpen)
void	setDesignModeStage(int designModeStage)	Holds the stage of the design mode (EnumReportDesignMode) .
void	setReportDesignMode(int reportDesignMode)	Holds the stage of the report design mode (EnumReportViewModes) .

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

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

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

doCollectData, 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, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, 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, 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.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, setTargetBean, setTargetBeanPath, setUseIFrame

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

restoreState, restoreState, saveState, saveState, saveState, saveState

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

getReportFrameBean, isGridDataNecessary

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.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

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

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

Constructor Detail

ProjectBrowserBeanImpl

public ProjectBrowserBeanImpl()

Method Detail

isEnabled

public boolean isEnabled()

Checks if a bean is enabled

Specified by:

isEnabled in interface FrameElement

Returns:

true if the bean is enabled.

setDesignModeStage

public void setDesignModeStage(int designModeStage)

Holds the stage of the design mode (EnumReportDesignMode) . The report frame bean will be responsible for setting this property of the objectbrowser tab beans.

Specified by:

setDesignModeStage in interface ProjectBrowser

Parameters:

designModeStage -

setReportDesignMode

public void setReportDesignMode(int reportDesignMode)

Holds the stage of the report design mode (EnumReportViewModes) . The report frame bean will be responsible for setting this property of the objectbrowser beans.

Specified by:

setReportDesignMode in interface ProjectBrowser

Parameters:

reportDesignMode -

isTargetingFilter

public boolean isTargetingFilter()

Specified by:

isTargetingFilter in interface ProjectBrowser

See Also:

ObjectBrowserTabBean.isTargetingFilter()

isTargetingTemplate

public boolean isTargetingTemplate()

Specified by:

isTargetingTemplate in interface ProjectBrowser

getMaximumStateLevel

public int getMaximumStateLevel()

Returns the maximum state level that is supported by the WebComponent. This value will come from EnumWebPersistableState.

Specified by:

getMaximumStateLevel in interface WebComponent

Overrides:

getMaximumStateLevel in class AbstractWebComponent

Returns:

A value from EnumWebPersistableState which indicates the maximum state level supported.

isDataExplorerOpen

public boolean isDataExplorerOpen()

Specified by:

isDataExplorerOpen in interface ProjectBrowser

setDataExplorerStatus

public void setDataExplorerStatus(boolean isOpen)

Specified by:

setDataExplorerStatus in interface ProjectBrowser

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.

collectData

public void collectData()
                 throws WebBeanException

Description copied from class: AbstractAppComponent

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance. If AbstractAppComponent.isOpen(), this method will first perform a AbstractAppComponent.doCollectData(), then proceeds to call AbstractAppComponent.collectData() on all child components AbstractWebComponent.getChild(int).

Specified by:

collectData in interface WebComponent

Overrides:

collectData in class AbstractAppComponent

Throws:

WebBeanException - thrown if there is any exception

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent

doFlatState

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

Description copied from class: AbstractViewBeanParserBean

Speciefies which bean's properties are persisted.

Overrides:

doFlatState in class AbstractViewBeanParserBean

Parameters:

serializer - FlatStateSerializer initialized instance where the state of the instance is handled

howMuchState - int value from EnumWebPersistableState indicating how much state should be handled by this instance

tokenizer - FlatStateTokenizer initialized instance where the state of the instance is handled.

hasChanged

public boolean hasChanged()

Description copied from class: AbstractWebComponent

Verifies the state of the component has changed

Specified by:

hasChanged in interface WebComponent

Overrides:

hasChanged in class AbstractAppComponent

Returns:

boolean value indicating if the current instance or its base bean (if any defined) has been marked as changed.