Package com.microstrategy.web.app.beans
Class ViewFilterElementPanelBeanImpl
- 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.ViewFilterElementPanelBeanImpl
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AppComponent
,FilterElementBean
,FrameElement
,ReportFrameElement
,ViewBeanParserBean
,ViewFilterElementPanelBean
,RequestPersistable
,Transformable
,WebComponent
public class ViewFilterElementPanelBeanImpl extends AbstractViewBeanParserBean implements ViewFilterElementPanelBean
- 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
-
-
Method Summary
All Methods Instance Methods Concrete Methods 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.boolean
getAutoApply()
Returns whether auto-apply is enabled.ExpressionBean
getExpressionBean()
This is a shortcut method that returns theExpressionBean
that this FilterElement refers to.int
getFilterType()
protected int
getPromptEditKey()
WebComponent
getTargetBean()
Get the target bean associated with this instanceboolean
getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its outputint
getVFExpressionEditMode()
Returns the current view filter expression edit mode of the bean, fromEnumExpressionEditMode
.ExpressionBean
getViewFilterBean()
ExpressionBean
getViewLimitBean()
int
getVLExpressionEditMode()
Returns the current view limit expression edit mode of the bean, fromEnumExpressionEditMode
.int
getXMLStatus()
Returns theEnumRequestStatus
status of the component.void
initBean()
Initialize the component after it's created and its properties initializedprotected void
initExpressionBean()
boolean
isAddingNewCondition()
Whether we are adding a new condition to the view filter.boolean
isEditable()
Returns whether the FilterElement is editable.boolean
isEditor()
Indicates whether a ReportFrameElement most be considered editor.boolean
isEnabled()
Indicates whether a ReportFrameElement is Enabled.boolean
isModified()
Returns whether this filter is modified from the filter object that it synchronizes with.boolean
isViewFilter()
Returns whether this FilterElement is used for a ViewFilter or a ReportFilter.protected WebEventHandler
newDefaultEventHandler()
void
setActiveViewKey(java.lang.String activeViewKey)
Set the active view key.void
setAutoApply(boolean autoApply)
Sets the auto-apply setting.void
setChanged(boolean value)
Sets the changed state of the componentvoid
setFilterType(int value)
Set the filter type to usevoid
setIsAddingNewCondition(boolean isAddingNewCondition)
Whether we are adding a new condition to the view filter.void
setIsViewFilter(boolean view)
Sets the current View setting for this FilterElement.protected void
setPromptEditKey(int key)
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
doCollectData, getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, 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, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, 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, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, 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.FilterElementBean
getAutoApply, getExpressionBean, getFilterType, isViewFilter, setAutoApply, setFilterType, setIsViewFilter
-
Methods inherited from interface com.microstrategy.web.app.beans.FrameElement
getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, 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
-
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, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler
-
-
-
-
Method Detail
-
newDefaultEventHandler
protected WebEventHandler newDefaultEventHandler()
-
isEnabled
public boolean isEnabled()
Description copied from interface:FrameElement
Indicates whether a ReportFrameElement is Enabled. Each bean checks its own features and other settings to determine whether it is enabled or not.- Specified by:
isEnabled
in interfaceFrameElement
- Returns:
- true if the bean is enabled and ready to be rendered.
-
isEditable
public boolean isEditable()
Description copied from interface:FilterElementBean
Returns whether the FilterElement is editable. If it is not editable, then the transform should not render any of the manipulation GUI elements to the user.- Specified by:
isEditable
in interfaceFilterElementBean
- Returns:
- Whether the user should be able to edit the expression at the current time.
-
getViewFilterBean
public ExpressionBean getViewFilterBean()
- Specified by:
getViewFilterBean
in interfaceViewFilterElementPanelBean
- Returns:
- The View Filter
ExpressionBean
-
getViewLimitBean
public ExpressionBean getViewLimitBean()
- Specified by:
getViewLimitBean
in interfaceViewFilterElementPanelBean
- Returns:
- The View Limit
ExpressionBean
-
getVFExpressionEditMode
public int getVFExpressionEditMode()
Description copied from interface:ViewFilterElementPanelBean
Returns the current view filter expression edit mode of the bean, fromEnumExpressionEditMode
. This represents the current state of the bean.- Specified by:
getVFExpressionEditMode
in interfaceViewFilterElementPanelBean
- Returns:
- The current expression edit mode of the bean, from
EnumExpressionEditMode
.
-
getVLExpressionEditMode
public int getVLExpressionEditMode()
Description copied from interface:ViewFilterElementPanelBean
Returns the current view limit expression edit mode of the bean, fromEnumExpressionEditMode
. This represents the current state of the bean.- Specified by:
getVLExpressionEditMode
in interfaceViewFilterElementPanelBean
- Returns:
- The current view limit expression edit mode of the bean, from
EnumExpressionEditMode
.
-
isModified
public boolean isModified()
Description copied from interface:ViewFilterElementPanelBean
Returns whether this filter is modified from the filter object that it synchronizes with. For example, if the filter has changed from the base filter on the WebReportInstance object exposed on a parent Report Bean. Calling synchronize or undo will re-baseline, setting isModified back to false.- Specified by:
isModified
in interfaceViewFilterElementPanelBean
- Returns:
- Whether the current expression has been modified.
-
isAddingNewCondition
public boolean isAddingNewCondition()
Description copied from interface:ViewFilterElementPanelBean
Whether we are adding a new condition to the view filter.
This information is used to move the subexpression to the View Limits if it is a metric qualification.- Specified by:
isAddingNewCondition
in interfaceViewFilterElementPanelBean
- Returns:
- Whether we are adding a new condition to the view filter.
-
setIsAddingNewCondition
public void setIsAddingNewCondition(boolean isAddingNewCondition)
Description copied from interface:ViewFilterElementPanelBean
Whether we are adding a new condition to the view filter.
This information is used to move the subexpression to the View Limits if it is a metric qualification.- Specified by:
setIsAddingNewCondition
in interfaceViewFilterElementPanelBean
- Parameters:
isAddingNewCondition
- Whether we are adding a new condition to the view filter.
-
doFlatState
protected void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Description copied from class:AbstractViewBeanParserBean
Speciefies which bean's properties are persisted.- 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.
-
setActiveViewKey
public void setActiveViewKey(java.lang.String activeViewKey)
Description copied from class:AbstractViewBeanParserBean
Set the active view key. It's used for initializing current bean from a view Bean.- Specified by:
setActiveViewKey
in interfaceViewBeanParserBean
- Parameters:
activeViewKey
- The specific element to set as active.- Since:
- MicroStrategy Web 9.0.1
-
initExpressionBean
protected void initExpressionBean()
- Since:
- MicroStrategy Web 9.0.1
-
setChanged
public void setChanged(boolean value)
Description copied from class:AbstractWebComponent
Sets the changed state of the component- Specified by:
setChanged
in interfaceWebComponent
- Overrides:
setChanged
in classAbstractWebComponent
- Parameters:
value
- a boolean value indicating whether the component is changed.- Since:
- MicroStrategy Web 9.0.1
-
isEditor
public boolean isEditor()
Description copied from class:AbstractPersistableFrameElement
Indicates whether a ReportFrameElement most be considered editor. Editors are treated specially by the ReportFrame: only one editor can be shown at any time.- Specified by:
isEditor
in interfaceFrameElement
- Overrides:
isEditor
in classAbstractPersistableFrameElement
- Returns:
- false, editors needs to override this method.
- Since:
- MicroStrategy Web 9.0.1
-
getAutoApply
public boolean getAutoApply()
Description copied from interface:FilterElementBean
Returns whether auto-apply is enabled. If this is true, then any changes to the expression should be applied immediately. This value is tied to a preference.- Specified by:
getAutoApply
in interfaceFilterElementBean
- Returns:
- The current auto-apply setting.
-
setAutoApply
public void setAutoApply(boolean autoApply)
Description copied from interface:FilterElementBean
Sets the auto-apply setting. This will affect the auto-apply preference for the user.- Specified by:
setAutoApply
in interfaceFilterElementBean
- Parameters:
autoApply
- The new value for the auto-apply flag.
-
getExpressionBean
public ExpressionBean getExpressionBean()
Description copied from interface:FilterElementBean
This is a shortcut method that returns theExpressionBean
that this FilterElement refers to.- Specified by:
getExpressionBean
in interfaceFilterElementBean
- Returns:
- The
ExpressionBean
linked with the FilterElement.
-
getUseIFrame
public boolean getUseIFrame()
Description copied from class:AbstractPersistableFrameElement
Indicates whether a ReportFrameElement uses IFrames in its output- Specified by:
getUseIFrame
in interfaceFrameElement
- Overrides:
getUseIFrame
in classAbstractPersistableFrameElement
- Returns:
- true if it uses IFrames
-
isViewFilter
public boolean isViewFilter()
Description copied from interface:FilterElementBean
Returns whether this FilterElement is used for a ViewFilter or a ReportFilter. If this is true, then it is a ViewFilter else it is a ReportFilter.- Specified by:
isViewFilter
in interfaceFilterElementBean
- Returns:
- The current FilterElement mode (View/Report).
- Since:
- MicroStrategy Web 8.0.1
-
setIsViewFilter
public void setIsViewFilter(boolean view)
Description copied from interface:FilterElementBean
Sets the current View setting for this FilterElement. If this is true, then it is a ViewFilter else it is a ReportFilter.- Specified by:
setIsViewFilter
in interfaceFilterElementBean
- Parameters:
view
- The current View setting for this FilterElement.- Since:
- MicroStrategy Web 8.0.1
-
getFilterType
public int getFilterType()
- Specified by:
getFilterType
in interfaceFilterElementBean
- Returns:
- int value with the filter type being used.
Values come from the
EnumExpressionBeanType
enumeration - Since:
- MicroStrategy Web 8.0.2
-
setFilterType
public void setFilterType(int value)
Description copied from interface:FilterElementBean
Set the filter type to use- Specified by:
setFilterType
in interfaceFilterElementBean
- Parameters:
value
- int with the filter type value to use. Values come from theEnumExpressionBeanType
enumeration- Since:
- MicroStrategy Web 8.0.2
-
getPromptEditKey
protected int getPromptEditKey()
-
setPromptEditKey
protected void setPromptEditKey(int key)
-
initBean
public void initBean()
Description copied from interface:WebComponent
Initialize the component after it's created and its properties initialized- Specified by:
initBean
in interfaceWebComponent
- Overrides:
initBean
in classAbstractWebComponent
-
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. IfAbstractAppComponent.isOpen()
, this method will first perform aAbstractAppComponent.doCollectData()
, then proceeds to callAbstractAppComponent.collectData()
on all child componentsAbstractWebComponent.getChild(int)
.- Specified by:
collectData
in interfaceWebComponent
- Overrides:
collectData
in classAbstractAppComponent
- Throws:
WebBeanException
- thrown if there is any exception
-
getXMLStatus
public int getXMLStatus()
Description copied from class:AbstractAppComponent
Returns theEnumRequestStatus
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 interfaceWebComponent
- Overrides:
getXMLStatus
in classAbstractAppComponent
- Returns:
- an
EnumRequestStatus
enumeration value for the component.
-
getTargetBean
public WebComponent getTargetBean()
Description copied from class:AbstractAppComponent
Get the target bean associated with this instance- Specified by:
getTargetBean
in interfaceFrameElement
- Specified by:
getTargetBean
in interfaceWebComponent
- Overrides:
getTargetBean
in classAbstractAppComponent
- Returns:
WebComponent
instance associated with this bean. By default if the base bean property has been defined, the target bean to return is the corresponding instance associated with the name and path specified. If nothing has been specified then it will return the firstEnumWebTransformableType.WEB_BEAN_REPORT
,EnumWebTransformableType.WEB_BEAN_DOCUMENT
orEnumWebTransformableType.WEB_BEAN_RW
instance found.
-
-