Package com.microstrategy.web.app.beans

Class AbstractViewBeanParserBean

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

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, ViewBeanParserBean, RequestPersistable, Transformable, WebComponent

Direct Known Subclasses:

AbstractColorGradientEditorBeanImpl, AbstractObjectBrowserTabBean, AbstractTemplateElementsBean, AccordionTabManagerBeanImpl, AttributeFormsQualificationBeanImpl, ColorGradientEditorBeanImpl, GraphTitleTabBeanImpl, OptimizedTabBeanImpl, ProjectBrowserBeanImpl, RibbonBeanImpl, RWGraphDropZonesEditorBeanImpl, SecondaryDataSourcesEditorBeanImpl, ViewFilterElementPanelBeanImpl, VisualizationsEditorBeanImpl

public abstract class AbstractViewBeanParserBean
extends AbstractPersistableFrameElement
implements ViewBeanParserBean

The ViewBeanParserBeanBean is used to represent an application bean that will manipiulate a View Bean from either a Report Bean or a Report Writer Bean.

Since:

MicroStrategy Web 8.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

Constructor Summary

Constructors

Constructor	Description
AbstractViewBeanParserBean()	Class constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Speciefies which bean's properties are persisted.
int	getActiveElementIndex()	Deprecated. This method will no longer be part of this class.
java.lang.String	getActiveViewKey()	Returns the active view key.
java.util.ArrayList	getTemplateElementList()	Deprecated. This method will no longer be part of this interface.
ViewBean	getViewBean()	Get a instance of the ViewBean associated with the bean.
ViewBean	getViewBean(int viewInstance)	Get a specific instance of the ViewBean associated with the bean.
void	setActiveElementIndex(int activeElementIndex)	Deprecated. This method will no longer be part of this class.
void	setActiveViewKey(java.lang.String activeViewKey)	Set the active view key.

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

Constructor Detail

AbstractViewBeanParserBean

public AbstractViewBeanParserBean()

Class constructor. Initializes a new -empty- instance of the ViewBeanParserBeanBean class.

Method Detail

getActiveElementIndex

@Deprecated
public int getActiveElementIndex()

Deprecated.

This method will no longer be part of this class.

Specified by:

getActiveElementIndex in interface ViewBeanParserBean

Returns:

the Active element index. It's used to pre-select an item in the template elements list

See Also:

ViewBeanParserBean.getActiveElementIndex()

setActiveElementIndex

@Deprecated
public void setActiveElementIndex(int activeElementIndex)

Deprecated.

This method will no longer be part of this class.

Description copied from interface: ViewBeanParserBean

Set the Active element index. It's used to pre-select an item in the template elements list

Specified by:

setActiveElementIndex in interface ViewBeanParserBean

Parameters:

activeElementIndex - the active element index

See Also:

ViewBeanParserBean.setActiveElementIndex(int)

setActiveViewKey

public void setActiveViewKey(java.lang.String activeViewKey)

Set the active view key. It's used for initializing current bean from a view Bean.

Specified by:

setActiveViewKey in interface ViewBeanParserBean

Parameters:

activeViewKey - The specific element to set as active.

getActiveViewKey

public java.lang.String getActiveViewKey()

Returns the active view key.

Specified by:

getActiveViewKey in interface ViewBeanParserBean

Returns:

String activeElementIndex The specific element to set as active.

getTemplateElementList

@Deprecated
public java.util.ArrayList getTemplateElementList()

Deprecated.

This method will no longer be part of this interface. Create the TemplateParser using the getViewBean to access the template element list.

Description copied from interface: ViewBeanParserBean

Get a list of template elements from ReportBean or RWBean.

Specified by:

getTemplateElementList in interface ViewBeanParserBean

Returns:

An arraylist containing the elements.

See Also:

ViewBeanParserBean.getTemplateElementList()

getViewBean

public ViewBean getViewBean()

Get a instance of the ViewBean associated with the bean. It will not return the data of the specific view bean. Just the definition will be returned.

Specified by:

getViewBean in interface ViewBeanParserBean

Returns:

ViewBean instance

getViewBean

public ViewBean getViewBean(int viewInstance)

Description copied from interface: ViewBeanParserBean

Get a specific instance of the ViewBean associated with the bean. It will return the data of the specific view bean along with the definition.

Specified by:

getViewBean in interface ViewBeanParserBean

Returns:

ViewBean instance

See Also:

ViewBeanParserBean.getViewBean(int)

doFlatState

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

Speciefies which bean's properties are persisted.

Overrides:

doFlatState in class AbstractPersistableAppComponent

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.