public class

ViewFilterElementPanelBeanImpl

extends AbstractViewBeanParserBean
implements FilterElementBean ViewFilterElementPanelBean
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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Methods
void collectData()
Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean getAutoApply()
Returns whether auto-apply is enabled.
ExpressionBean getExpressionBean()
This is a shortcut method that returns the ExpressionBean that this FilterElement refers to.
int getFilterType()
WebComponent getTargetBean()
Get the target bean associated with this instance
boolean getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its output
int getVFExpressionEditMode()
Returns the current view filter expression edit mode of the bean, from EnumExpressionEditMode.
int getVLExpressionEditMode()
Returns the current view limit expression edit mode of the bean, from EnumExpressionEditMode.
ExpressionBean getViewFilterBean()
ExpressionBean getViewLimitBean()
int getXMLStatus()
Returns the EnumRequestStatus status of the component.
void initBean()
Initialize the component after it's created and its properties initialized
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.
void setActiveViewKey(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 component
void setFilterType(int value)
Set the filter type to use
void 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 Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Speciefies which bean's properties are persisted.
int getPromptEditKey()
void initExpressionBean()
WebEventHandler newDefaultEventHandler()
void setPromptEditKey(int key)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractViewBeanParserBean
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FilterElementBean
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.app.beans.ViewFilterElementPanelBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public void collectData ()

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 isOpen(), this method will first perform a doCollectData(), then proceeds to call collectData() on all child components getChild(int).

public boolean getAutoApply ()

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.

Returns
  • The current auto-apply setting.

public ExpressionBean getExpressionBean ()

This is a shortcut method that returns the ExpressionBean that this FilterElement refers to.

Returns

public int getFilterType ()

public WebComponent getTargetBean ()

Get the target bean associated with this instance

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 first WEB_BEAN_REPORT, WEB_BEAN_DOCUMENT or WEB_BEAN_RW instance found.

public boolean getUseIFrame ()

Indicates whether a ReportFrameElement uses IFrames in its output

Returns
  • true if it uses IFrames

public int getVFExpressionEditMode ()

Returns the current view filter expression edit mode of the bean, from EnumExpressionEditMode. This represents the current state of the bean.

Returns

public int getVLExpressionEditMode ()

Returns the current view limit expression edit mode of the bean, from EnumExpressionEditMode. This represents the current state of the bean.

Returns

public ExpressionBean getViewFilterBean ()

public ExpressionBean getViewLimitBean ()

public int getXMLStatus ()

Returns the EnumRequestStatus status of the component. The status determined by by the status of its children with the following precedence.

  • WebBeanRequestEndsInError
  • WebBeanRequestCanceled
  • WebBeanRequestProcessing
  • WebBeanRequestNotInitiated
  • WebBeanRequestWaitingForUserInput
  • WebBeanRequestSuccessful

  • Returns

    public void initBean ()

    Initialize the component after it's created and its properties initialized

    public boolean isAddingNewCondition ()

    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.

    Returns
    • Whether we are adding a new condition to the view filter.

    public boolean isEditable ()

    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.

    Returns
    • Whether the user should be able to edit the expression at the current time.

    public boolean isEditor ()

    Indicates whether a ReportFrameElement most be considered editor. Editors are treated specially by the ReportFrame: only one editor can be shown at any time.

    Returns
    • false, editors needs to override this method.

    public boolean isEnabled ()

    Indicates whether a ReportFrameElement is Enabled. Each bean checks its own features and other settings to determine whether it is enabled or not.

    Returns
    • true if the bean is enabled and ready to be rendered.

    public boolean isModified ()

    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.

    Returns
    • Whether the current expression has been modified.

    public boolean isViewFilter ()

    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.

    Returns
    • The current FilterElement mode (View/Report).

    public void setActiveViewKey (String activeViewKey)

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

    Parameters
    activeViewKey The specific element to set as active.

    public void setAutoApply (boolean autoApply)

    Sets the auto-apply setting. This will affect the auto-apply preference for the user.

    Parameters
    autoApply The new value for the auto-apply flag.

    public void setChanged (boolean value)

    Sets the changed state of the component

    Parameters
    value a boolean value indicating whether the component is changed.

    public void setFilterType (int value)

    Set the filter type to use

    Parameters
    value int with the filter type value to use. Values come from the EnumExpressionBeanType enumeration

    public void setIsAddingNewCondition (boolean isAddingNewCondition)

    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.

    Parameters
    isAddingNewCondition Whether we are adding a new condition to the view filter.

    public void setIsViewFilter (boolean view)

    Sets the current View setting for this FilterElement. If this is true, then it is a ViewFilter else it is a ReportFilter.

    Parameters
    view The current View setting for this FilterElement.

    Protected Methods

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

    Speciefies which bean's properties are persisted.

    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.

    protected int getPromptEditKey ()

    protected void initExpressionBean ()

    protected WebEventHandler newDefaultEventHandler ()

    protected void setPromptEditKey (int key)