Package com.microstrategy.web.app.beans
Class AllObjectBrowserBeanImpl
- 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.AllObjectBrowserBeanImpl
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AllObjectBrowserBean
,AppComponent
,FolderObjectExplorerBean
,ObjectExplorerBean
,RequestPersistable
,Transformable
,WebComponent
public class AllObjectBrowserBeanImpl extends FolderObjectExplorerBeanImpl implements AllObjectBrowserBean
- Since:
- MicroStrategy Web 9.0.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.AllObjectBrowserBean
BROWSE_FOR_FOLDER, BROWSE_FOR_OBJECTS
-
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 AllObjectBrowserBeanImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowAllObjectBrowsing()
Specifies whether the user is allowed to browse all Objects to the project levelvoid
doCollectData()
Extends collectDataprotected void
doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
java.util.ArrayList
getAncestors()
int
getBrowseFor()
protected java.lang.String
getFilterTypeRestriction()
protected java.lang.String
getReportTypeRestriction()
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 pluginjava.lang.String
getStartingFolderID()
Specifies whether a specific report is configured to browse from a certain folder.WebFolder
getTreeRootFolder()
Get the root folder for the entire object browser tree.java.lang.String
getTypeRestriction()
boolean
hasDataExplorer()
Gets the information of whether to use the data explorer to render the browse contents or not NOTE: used when browsing from attributes to the elementsprotected boolean
hasTargetBeanChanged()
When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.protected boolean
isSaveStateEnabled()
boolean
isTargetingFilter()
Gets the information of whether in report creation or filter creationboolean
isTargetingTemplate()
protected void
restoreTypeRestrictions(boolean restoring, FlatStateSerializer serializer, FlatStateTokenizer tokenizer)
void
setBrowseFor(int browseFor)
Sets the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)void
setFilterTypeRestriction(java.lang.String restrictions)
void
setHasDataExplorer(boolean hasDataExplorer)
Sets whether to use the data explorer to render the browse contents or notvoid
setReportTypeRestriction(java.lang.String restrictions)
-
Methods inherited from class com.microstrategy.web.app.beans.FolderObjectExplorerBeanImpl
doFlatState, getConfiguredRootFolderID, getContents, getContents, getContextID, getCurrentUnit, getFolderBean, getFolderBeanName, getFolderFromFolderLink, getLinks, getLinksContextID, getObjectCount, getProjectID, getRenderRoot, getSearchName, getTotalObjectCount, getTrimedAncestors, handleRequest, isExcludeShortcut, isQuickSearch, newDefaultEventHandler, resetFolderBean, setContextID, setExcludeShortcut, setIgnoreAccessDenialError, setQuickSearch, setRenderRoot, setupFolderBean
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractObjectExplorerBean
getBlockBegin, getBlockCount, getErrorMessage, 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, 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, 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
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, getTrimedAncestors, isExcludeShortcut, isQuickSearch, resetFolderBean, setContextID, setExcludeShortcut, setQuickSearch, setRenderRoot
-
Methods inherited from interface com.microstrategy.web.app.beans.ObjectExplorerBean
getBlockBegin, getBlockCount, getContents, getContents, getCurrentUnit, getErrorMessage, getLinks, getObjectCount, getSearchName, getTotalObjectCount, 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
-
-
-
-
Method Detail
-
setHasDataExplorer
public void setHasDataExplorer(boolean hasDataExplorer)
Description copied from interface:AllObjectBrowserBean
Sets whether to use the data explorer to render the browse contents or not- Specified by:
setHasDataExplorer
in interfaceAllObjectBrowserBean
-
hasDataExplorer
public boolean hasDataExplorer()
Description copied from interface:AllObjectBrowserBean
Gets the information of whether to use the data explorer to render the browse contents or not NOTE: used when browsing from attributes to the elements- Specified by:
hasDataExplorer
in interfaceAllObjectBrowserBean
-
setReportTypeRestriction
public void setReportTypeRestriction(java.lang.String restrictions)
- Specified by:
setReportTypeRestriction
in interfaceAllObjectBrowserBean
-
setFilterTypeRestriction
public void setFilterTypeRestriction(java.lang.String restrictions)
- Specified by:
setFilterTypeRestriction
in interfaceAllObjectBrowserBean
-
getBrowseFor
public int getBrowseFor()
- Specified by:
getBrowseFor
in interfaceAllObjectBrowserBean
- Returns:
- the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)
-
setBrowseFor
public void setBrowseFor(int browseFor)
Description copied from interface:AllObjectBrowserBean
Sets the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)- Specified by:
setBrowseFor
in interfaceAllObjectBrowserBean
-
getTypeRestriction
public java.lang.String getTypeRestriction()
- Specified by:
getTypeRestriction
in interfaceObjectExplorerBean
- Overrides:
getTypeRestriction
in classAbstractObjectExplorerBean
- Returns:
- a comma-separated String that represents the type of objects (from
EnumDSSXMLObjectTypes
) to display - See Also:
ObjectExplorerBean.getTypeRestriction()
-
doCollectData
public void doCollectData()
Extends collectData- Overrides:
doCollectData
in classFolderObjectExplorerBeanImpl
-
getStartingFolderID
public java.lang.String getStartingFolderID()
Description copied from interface:AllObjectBrowserBean
Specifies whether a specific report is configured to browse from a certain folder.- Specified by:
getStartingFolderID
in interfaceAllObjectBrowserBean
- Returns:
- the folder ID if the report is configured with a specific browsing point.
-
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 interfaceFolderObjectExplorerBean
- Overrides:
getRootFolderID
in classFolderObjectExplorerBeanImpl
- Returns:
- the id of the root folder the
FolderBean
is based on when browsing
-
allowAllObjectBrowsing
public boolean allowAllObjectBrowsing()
Description copied from interface:AllObjectBrowserBean
Specifies whether the user is allowed to browse all Objects to the project level- Specified by:
allowAllObjectBrowsing
in interfaceAllObjectBrowserBean
-
isTargetingTemplate
public boolean isTargetingTemplate()
-
isTargetingFilter
public boolean isTargetingFilter()
Description copied from interface:AllObjectBrowserBean
Gets the information of whether in report creation or filter creation- Specified by:
isTargetingFilter
in interfaceAllObjectBrowserBean
- Returns:
- true if in filter creation mode
-
getTreeRootFolder
public WebFolder getTreeRootFolder()
Get the root folder for the entire object browser tree.- Specified by:
getTreeRootFolder
in interfaceAllObjectBrowserBean
- Returns:
- the root folder.
-
getAncestors
public java.util.ArrayList getAncestors()
- Specified by:
getAncestors
in interfaceObjectExplorerBean
- Overrides:
getAncestors
in classFolderObjectExplorerBeanImpl
- Returns:
- an
List
ofWebDisplayUnit
objects containing the list of of the current object's ancestors (parent folders) - See Also:
ObjectExplorerBean.getAncestors()
-
getReportTypeRestriction
protected java.lang.String getReportTypeRestriction()
-
getFilterTypeRestriction
protected java.lang.String getFilterTypeRestriction()
-
restoreTypeRestrictions
protected void restoreTypeRestrictions(boolean restoring, FlatStateSerializer serializer, FlatStateTokenizer tokenizer)
- Overrides:
restoreTypeRestrictions
in classFolderObjectExplorerBeanImpl
-
hasTargetBeanChanged
protected boolean hasTargetBeanChanged()
Description copied from class:AbstractAppComponent
When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false. If #compareChildsTargetWithCurrent method returns true, then we check if any of the child's target bean is same as this object's target bean and return true if this is the case. If you want to check the targetbean of this component, then override compareChildsTargetWithCurrent to return true- Overrides:
hasTargetBeanChanged
in classAbstractAppComponent
-
isSaveStateEnabled
protected boolean isSaveStateEnabled()
- Overrides:
isSaveStateEnabled
in classAbstractPersistableAppComponent
- Returns:
- boolean value indicating if the state should be saved for the current instance or not. By default it checks if the instance is marked as opened.
- Since:
- MicroStrategy Web 9.0.1
-
doFlatState
protected void doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
- Overrides:
doFlatState
in classAbstractPersistable
- Since:
- MicroStrategy Web 9.0.1
-
-