Package com.microstrategy.web.app.beans
Class AbstractTemplateElementsBean
- 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.AbstractTemplateElementsBean
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AppComponent
,DataSetParserBean
,TemplateElementsBean
,ViewBeanParserBean
,RequestPersistable
,Transformable
,WebComponent
public class AbstractTemplateElementsBean extends AbstractViewBeanParserBean implements TemplateElementsBean
- 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.TemplateElementsBean
ALL_DATASET_MODE, DATASET_MODE, GRID_MODE
-
-
Constructor Summary
Constructors Constructor Description AbstractTemplateElementsBean()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Speciefies which bean's properties are persisted.java.lang.String
getActiveDatasetId()
Returns the active dataset Id.RWDataSets
getDatasets()
int
getMode()
Indicates which mode this bean has active.java.util.ArrayList
getTemplateElementsList()
RWUserMetrics
getUserMetricsFromDataset()
Returns list of all user metrics available in active dataset.WebTemplate
getWebTemplate()
WebWorkingSet
getWebWorkingSet()
void
setActiveDatasetId(java.lang.String activeDatasetId)
Set the active dataset Id.void
setMode(int mode)
Specified which mode this bean should activate.-
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, 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, newDefaultEventHandler, 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.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.app.beans.ViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey
-
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
-
getWebWorkingSet
public WebWorkingSet getWebWorkingSet()
- Specified by:
getWebWorkingSet
in interfaceTemplateElementsBean
- Returns:
WebWorkingSet
instance for the target bean
-
getWebTemplate
public WebTemplate getWebTemplate()
- Specified by:
getWebTemplate
in interfaceTemplateElementsBean
-
getDatasets
public RWDataSets getDatasets()
- Specified by:
getDatasets
in interfaceTemplateElementsBean
-
getMode
public int getMode()
Description copied from interface:TemplateElementsBean
Indicates which mode this bean has active.
It could either be any of the following values:- 0 - Grid Mode
TemplateElementsBean.GRID_MODE
- 1 - Single Dataset Mode
TemplateElementsBean.DATASET_MODE
- 2 - All Dataset Mode
TemplateElementsBean.ALL_DATASET_MODE
- Specified by:
getMode
in interfaceTemplateElementsBean
- Returns:
- int mode value.
- 0 - Grid Mode
-
setMode
public void setMode(int mode)
Description copied from interface:TemplateElementsBean
Specified which mode this bean should activate.
It could either be any of the following values:- 0 - Grid Mode
TemplateElementsBean.GRID_MODE
- 1 - Single Dataset Mode
TemplateElementsBean.DATASET_MODE
- 2 - All Dataset Mode
TemplateElementsBean.ALL_DATASET_MODE
- Specified by:
setMode
in interfaceTemplateElementsBean
- Parameters:
mode
- int value.
- 0 - Grid Mode
-
getActiveDatasetId
public java.lang.String getActiveDatasetId()
Description copied from interface:DataSetParserBean
Returns the active dataset Id.- Specified by:
getActiveDatasetId
in interfaceDataSetParserBean
- Returns:
- String Id.
-
setActiveDatasetId
public void setActiveDatasetId(java.lang.String activeDatasetId)
Description copied from interface:DataSetParserBean
Set the active dataset Id.
It's used for initializing current bean from a dataset collection.- Specified by:
setActiveDatasetId
in interfaceDataSetParserBean
- Parameters:
activeDatasetId
- The specific dataset to set as active.
-
getUserMetricsFromDataset
public RWUserMetrics getUserMetricsFromDataset()
Description copied from interface:DataSetParserBean
Returns list of all user metrics available in active dataset.- Specified by:
getUserMetricsFromDataset
in interfaceDataSetParserBean
- Returns:
- RWUserMetrics collection
-
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 classAbstractViewBeanParserBean
- Parameters:
serializer
-FlatStateSerializer
initialized instance where the state of the instance is handledhowMuchState
-int
value fromEnumWebPersistableState
indicating how much state should be handled by this instancetokenizer
-FlatStateTokenizer
initialized instance where the state of the instance is handled.
-
getTemplateElementsList
public java.util.ArrayList getTemplateElementsList()
- Specified by:
getTemplateElementsList
in interfaceTemplateElementsBean
-
-