public interface

FilterEditorBean

implements ReportFrameElement
com.microstrategy.web.app.beans.FilterEditorBean

This interface is deprecated.
Use FilterElementBean and ExpressionBean instead.

Class Overview

The FilterEditor Bean is representing the filter editor (including the filter details) for a report page. It's a subcomponent of ReportFrameBean. In design mode, the filter from working set (upper section) is editable, while the filter from report instance (lower section) is not editable. In execute mode, the filter from working set (upper section) is not editable, while the filter from report instance (lower section) is editable.

Summary

Constants
int DISPLAY_ADD_WIZARD display flag indicating the filter editor needs to display the add expression wizard
int DISPLAY_AQ_EDIT display flag indicating the filter editor needs to display the attribute qualification editing mode
int DISPLAY_UNIT_COMPARISON display flag indicating the filter editor needs to display the unit comparison box rather than the constant textbox
int L_ACTION_ADD_EXPRESSION action constant for adding a sub expression
int L_ACTION_ADD_EXPRESSION_WIZARD action constant for displaying the wizard for adding a sub expression
int L_ACTION_ADD_SHOPPING_CART_UNIT action constant for adding an item in a shopping cart
int L_ACTION_APPLY_ADD_EXPRESSION action constant for applying the changes of adding a sub expression
int L_ACTION_APPLY_EDIT_EXPRESSION action constant for applying the changes for a sub expression editing
int L_ACTION_APPLY_VIEWFILTER_CHANGES action constant for applying the whole changes of view filter.
int L_ACTION_CANCEL_ADD_EXPRESSION action constant for canceling the changes of adding a sub expression
int L_ACTION_CANCEL_ADD_EXPRESSION_WIZARD action constant for canceling the wizard for adding a sub expression
int L_ACTION_CANCEL_EDIT_EXPRESSION action constant for canceling the changes for a sub expression editing
int L_ACTION_CANCEL_EDIT_OPERATOR action constant for cancelling the operator editing
int L_ACTION_CANCEL_VIEWFILTER_CHANGES action constant for canceling the whole changes of view filter.
int L_ACTION_CLEAR_FILTER action constant for clear the whole filter
int L_ACTION_DELETE_EXPRESSION action constant for deleting a sub expression in the filter
int L_ACTION_EDIT_EXPRESSION action constant for editing a sub expression
int L_ACTION_EDIT_OPERATOR action constant for editing an operator
int L_ACTION_ELEMENT_SEARCH action constant for doing an element search
int L_ACTION_INCREFETCH_BEGIN action constant for going to the beginning of the incremental fetch
int L_ACTION_INVALID action constant for an invalid action
int L_ACTION_MATCH_CASE Constant value read when performing search on elements
int L_ACTION_REMOVE_SHOPPING_CART_UNIT action constant for removing an item in a shopping cart
int L_ACTION_SHIFTDOWN_EXPRESSION action constant for shifting down a sub expression
int L_ACTION_SHIFTLEFT_OPERATOR action constant for shifting left a sub expression
int L_ACTION_SHIFTRIGHT_OPERATOR action constant for shifting right a sub expression
int L_ACTION_SHIFTUP_EXPRESSION action constant for shifting up a sub expression
int L_ACTION_TOGGLE_AQ_MODE action constant for toggling the attribute qualification between selecting elements and qualification
int L_ACTION_TOGGLE_OPERATOR action constant for toggling an operator in the expression
int L_ACTION_TOGGLE_UNIT_COMPARISON action constant for toggling between unit comparison and constant comparison
int L_CREATE_EXP_ATT_ELEM_TYPE Indicates that new Filter expression to be created for an attribute will be always of Attribute element qualification type.
int L_CREATE_EXP_ATT_QUAL_TYPE Indicates that new Filter expression to be created for an attribute will be always of Attribute qualification type.
int L_CREATE_EXP_DEFAULT_TYPE Indicates to use default type when creating a new Attribute expression in Filter.
int METRIC_VALIDATION_DATE Indicates that date and numerical are valid values.
int METRIC_VALIDATION_NUMERICAL Indicates that only numerical values are taken when creating a Metric filter sub expression.
int METRIC_VALIDATION_TEXT Indicates that text, date and numerical are valid values.
int NODE_KEY_INVALID constant for invalid node key
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract boolean checkMetricValidation(int value)
Determines whether or not given metric type of validation is enabled.
abstract int getActiveAction()
returns the active action
abstract int getActiveLeftKey()
abstract int getActiveNodeKey()
get the currently active expression node key.
abstract int getActiveOperatorKey()
get the currently operator node key.
abstract int getActiveRightKey()
get the currently right node key
abstract int getCreateAttrExpressionType()
Indicates which type of Attribute Expression is defined when creating a new Filter sub expression.
abstract int getDisplayFlag()
abstract WebFilter getFilter()
return the filter object associated with this filter editor
abstract int getFilterType()
return the filter type, value is from EnumFilterTypes
abstract int getIncrementalBlockBegin()
getIncrementalBlockBegin, function for getting incremental block begin
abstract int getMetricValidationLevel()
Indicates the level of validation to be enforced when editing or adding a Metric sub expression.
abstract String getSeparator()
Return the seperator for filter display.
abstract String getTitle()
return the title for this filter editor.
abstract WebFilterEditorException getValidationInfo()
Returns the validation info as a WebFilterEditorException
abstract boolean isAbleToApply()
return whether the filter expression gets changed, used to indicate whether "apply" button in view filter (when auto-apply is FALSE) shall be DISABLED or not.
abstract boolean isAbleToCancel()
return whether the we can cancel the filter expression changes, used to indicate whether "cancel" button in view filter (when auto-apply is FALSE) shall be DISABLED or not.
abstract boolean isAttributeLocked(WebAttribute attribute)
Whether an attribute is locked or not.
abstract boolean isAutoApply()
return if auto apply is on or off.
abstract boolean isDHTML()
Returns if it's DHTML mode
abstract boolean isEditable()
return whether the filter is editable or not.
abstract boolean isThereAnyOpenCondition()
Checks whether or not there's an open subcondition.
abstract void persistExistingSubExpression()
Persists active subexpression before being edited.
abstract void refreshFilter()
reset the filter editor
abstract void restoreExistingSubExpression()
Restores active subexpression to original state.
abstract void setAbleToApply(boolean ableToApply)
set whether the filter expression is changed
abstract void setAbleToCancel(boolean ableToCancel)
set whether the filter expression change can be cancelled
abstract void setActiveAction(int activeAction)
Sets active action for the filter editor
abstract void setActiveLeftKey(int key)
Return the currently left node key.
abstract void setActiveNodeKey(int key)
Set the currently active expression node key.
abstract void setActiveOperatorKey(int key)
Return the currently operator node key.
abstract void setActiveRightKey(int key)
Return the currently right node key.
abstract void setAutoApply(boolean autoApply)
Set auto apply be on or off
abstract void setContextMenuName(String contextMenuName)
Specifies name for context Menu.
abstract void setCreateAttrExpressionType(int type)
Specifies which type of Attribute Expression is defined when creating a new Filter sub expression.
abstract void setDisplayFlag(int displayFlag)
Sets the filter editor display flags.
abstract void setEditable(boolean editable)
Set whether the filter is editable or not
abstract void setFilter(WebFilter filter)
Set the filter object associated with this filter editor
abstract void setFilterType(int filterType)
Set the filter type, value should be from EnumFilterTypes
abstract void setIncrementalBlockBegin(int blockBegin)
setIncrementalBlockBegin, function for setting incremental block begin
abstract void setIncrementalBlockCount(int count)
setIncrementalBlockCount, function for setting incremental block count
abstract void setMatchCase(boolean matchCase)
Sets the match case value
abstract void setMetricValidationLevel(int value)
Specifies level of validation to be enforced when editing or adding a Metric sub expression.
abstract void setPerformSearch(boolean performaSearch)
set whether it's performing a search
abstract void setSearchName(String searchName)
Sets the search field content
abstract void setSeparator(String separator)
Set the seperator for filter display.
abstract void setTitle(String title)
Set the title for this filter editor
abstract void setValidationInfo(WebFilterEditorException wfe)
Sets the ValidationInfo for the filter editor
abstract boolean validFilterExpression()
Checks whether or not filter expression has an uncompleted element list subexpression.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int DISPLAY_ADD_WIZARD

display flag indicating the filter editor needs to display the add expression wizard

Constant Value: 1 (0x00000001)

public static final int DISPLAY_AQ_EDIT

display flag indicating the filter editor needs to display the attribute qualification editing mode

Constant Value: 4 (0x00000004)

public static final int DISPLAY_UNIT_COMPARISON

display flag indicating the filter editor needs to display the unit comparison box rather than the constant textbox

Constant Value: 2 (0x00000002)

public static final int L_ACTION_ADD_EXPRESSION

action constant for adding a sub expression

Constant Value: 16 (0x00000010)

public static final int L_ACTION_ADD_EXPRESSION_WIZARD

action constant for displaying the wizard for adding a sub expression

Constant Value: 15 (0x0000000f)

public static final int L_ACTION_ADD_SHOPPING_CART_UNIT

action constant for adding an item in a shopping cart

Constant Value: 17 (0x00000011)

public static final int L_ACTION_APPLY_ADD_EXPRESSION

action constant for applying the changes of adding a sub expression

Constant Value: 19 (0x00000013)

public static final int L_ACTION_APPLY_EDIT_EXPRESSION

action constant for applying the changes for a sub expression editing

Constant Value: 12 (0x0000000c)

public static final int L_ACTION_APPLY_VIEWFILTER_CHANGES

action constant for applying the whole changes of view filter. it's fired when apply button is clicked when autoapply is OFF for view filter editor

Constant Value: 23 (0x00000017)

public static final int L_ACTION_CANCEL_ADD_EXPRESSION

action constant for canceling the changes of adding a sub expression

Constant Value: 21 (0x00000015)

public static final int L_ACTION_CANCEL_ADD_EXPRESSION_WIZARD

action constant for canceling the wizard for adding a sub expression

Constant Value: 26 (0x0000001a)

public static final int L_ACTION_CANCEL_EDIT_EXPRESSION

action constant for canceling the changes for a sub expression editing

Constant Value: 13 (0x0000000d)

public static final int L_ACTION_CANCEL_EDIT_OPERATOR

action constant for cancelling the operator editing

Constant Value: 10 (0x0000000a)

public static final int L_ACTION_CANCEL_VIEWFILTER_CHANGES

action constant for canceling the whole changes of view filter. it's fired when cancek button is clicked when autoapply is OFF for view filter editor

Constant Value: 24 (0x00000018)

public static final int L_ACTION_CLEAR_FILTER

action constant for clear the whole filter

Constant Value: 1 (0x00000001)

public static final int L_ACTION_DELETE_EXPRESSION

action constant for deleting a sub expression in the filter

Constant Value: 2 (0x00000002)

public static final int L_ACTION_EDIT_EXPRESSION

action constant for editing a sub expression

Constant Value: 9 (0x00000009)

public static final int L_ACTION_EDIT_OPERATOR

action constant for editing an operator

Constant Value: 8 (0x00000008)

public static final int L_ACTION_ELEMENT_SEARCH

action constant for doing an element search

Constant Value: 22 (0x00000016)

public static final int L_ACTION_INCREFETCH_BEGIN

action constant for going to the beginning of the incremental fetch

Constant Value: 20 (0x00000014)

public static final int L_ACTION_INVALID

action constant for an invalid action

Constant Value: -1 (0xffffffff)

public static final int L_ACTION_MATCH_CASE

Constant value read when performing search on elements

Constant Value: 25 (0x00000019)

public static final int L_ACTION_REMOVE_SHOPPING_CART_UNIT

action constant for removing an item in a shopping cart

Constant Value: 18 (0x00000012)

public static final int L_ACTION_SHIFTDOWN_EXPRESSION

action constant for shifting down a sub expression

Constant Value: 5 (0x00000005)

public static final int L_ACTION_SHIFTLEFT_OPERATOR

action constant for shifting left a sub expression

Constant Value: 6 (0x00000006)

public static final int L_ACTION_SHIFTRIGHT_OPERATOR

action constant for shifting right a sub expression

Constant Value: 7 (0x00000007)

public static final int L_ACTION_SHIFTUP_EXPRESSION

action constant for shifting up a sub expression

Constant Value: 4 (0x00000004)

public static final int L_ACTION_TOGGLE_AQ_MODE

action constant for toggling the attribute qualification between selecting elements and qualification

Constant Value: 14 (0x0000000e)

public static final int L_ACTION_TOGGLE_OPERATOR

action constant for toggling an operator in the expression

Constant Value: 3 (0x00000003)

public static final int L_ACTION_TOGGLE_UNIT_COMPARISON

action constant for toggling between unit comparison and constant comparison

Constant Value: 11 (0x0000000b)

public static final int L_CREATE_EXP_ATT_ELEM_TYPE

Indicates that new Filter expression to be created for an attribute will be always of Attribute element qualification type.
However, this mode will be ignored if given attribute is locked in both Filters: View and Report Filters. If this is the case, then an Attribute Qualification expression will be created.

Constant Value: 2 (0x00000002)

public static final int L_CREATE_EXP_ATT_QUAL_TYPE

Indicates that new Filter expression to be created for an attribute will be always of Attribute qualification type.

Constant Value: 1 (0x00000001)

public static final int L_CREATE_EXP_DEFAULT_TYPE

Indicates to use default type when creating a new Attribute expression in Filter.
Default mode defines that an Attribute Qualification expression will be created in Design mode (Report Filter).
In View mode (View Filter), defines that an Attribute Element qualification expression will be created only if given attribute isn't locked.
This is the default value for all Filter Editor.

Constant Value: 3 (0x00000003)

public static final int METRIC_VALIDATION_DATE

Indicates that date and numerical are valid values. (default value)

Constant Value: 2 (0x00000002)

public static final int METRIC_VALIDATION_NUMERICAL

Indicates that only numerical values are taken when creating a Metric filter sub expression.

Constant Value: 1 (0x00000001)

public static final int METRIC_VALIDATION_TEXT

Indicates that text, date and numerical are valid values.

Constant Value: 4 (0x00000004)

public static final int NODE_KEY_INVALID

constant for invalid node key

Constant Value: -1 (0xffffffff)

Public Methods

public abstract boolean checkMetricValidation (int value)

Determines whether or not given metric type of validation is enabled.

Parameters
value int value possible of following:
Returns
  • boolean true if enabled.

public abstract int getActiveAction ()

returns the active action

Returns
  • the active action

public abstract int getActiveLeftKey ()

Returns
  • the currently left node key. Operator node key by itself sometimes can't uniquely identify an operator to work on. For example: Year(ID) = 2000 AND Year(ID) = 2001 AND Year(ID) = 2002 The two "AND" node has the same node key, we need differentiate by left and right node keys

public abstract int getActiveNodeKey ()

get the currently active expression node key.

Returns
  • the currently active expression node key.

public abstract int getActiveOperatorKey ()

get the currently operator node key.

Returns
  • the currently operator node key.

public abstract int getActiveRightKey ()

get the currently right node key

Returns
  • the currently right node key

public abstract int getCreateAttrExpressionType ()

Indicates which type of Attribute Expression is defined when creating a new Filter sub expression.
This property will determine behavior to take when creating a new Attribute Filter expression. It'll indicate what type of expression to be created.
This will return an int value indicating any of the following constants:

  • L_CREATE_EXP_ATT_QUAL_TYPE = 1 (Default value in Report Filter)
  • L_CREATE_EXP_ATT_ELEM_TYPE = 2 (Default value in View Filter)

Returns
  • int attribute expression type.

public abstract int getDisplayFlag ()

Returns
  • the filter editor display flags. It is a binary sum of the constants with name beginning with DISPLAY_.

public abstract WebFilter getFilter ()

return the filter object associated with this filter editor

Returns
  • the filter object associated with this filter editor

public abstract int getFilterType ()

return the filter type, value is from EnumFilterTypes

Returns
  • the filter type

public abstract int getIncrementalBlockBegin ()

getIncrementalBlockBegin, function for getting incremental block begin

Returns
  • int index for block begin in shopping cart

public abstract int getMetricValidationLevel ()

Indicates the level of validation to be enforced when editing or adding a Metric sub expression.
It returns only following values denoted in FilterEditor interface:

Returns
  • the current validation level value for metric sub expressions

public abstract String getSeparator ()

Return the seperator for filter display. It's the characters displayed before each sub expression.

Returns
  • the seperator for filter display.

public abstract String getTitle ()

return the title for this filter editor. It's show on the interface as the title of the editor.

Returns
  • the title for this filter editor.

public abstract WebFilterEditorException getValidationInfo ()

Returns the validation info as a WebFilterEditorException

Returns
  • validation info

public abstract boolean isAbleToApply ()

return whether the filter expression gets changed, used to indicate whether "apply" button in view filter (when auto-apply is FALSE) shall be DISABLED or not. It's false at first time, then become true after any manipulation in filter editor that changes the filter's expression; and then it will be set to false again when "Apply" or "Cancel" is clicked

Returns
  • whether the filter expression gets changed

public abstract boolean isAbleToCancel ()

return whether the we can cancel the filter expression changes, used to indicate whether "cancel" button in view filter (when auto-apply is FALSE) shall be DISABLED or not. It's false at first time, then become true for any manipulation in filter editor; and then it will be set to false again when "Apply" or "Cancel" is clicked

Returns
  • whether the we can cancel the filter expression changes

public abstract boolean isAttributeLocked (WebAttribute attribute)

Whether an attribute is locked or not.

Parameters
attribute WebAttribute instance to be checked
Returns
  • boolean true if given attribute is locked.

public abstract boolean isAutoApply ()

return if auto apply is on or off.

Returns
  • if auto apply is on or off.

public abstract boolean isDHTML ()

Returns if it's DHTML mode

Returns
  • boolean

public abstract boolean isEditable ()

return whether the filter is editable or not. if editable, it's filter editor; if not, it's filter details.

Returns
  • whether the filter is editable or not.

public abstract boolean isThereAnyOpenCondition ()

Checks whether or not there's an open subcondition.
Either it could being added or modified.

Returns
  • boolean true if at least one opened condition is found.

public abstract void persistExistingSubExpression ()

Persists active subexpression before being edited.

public abstract void refreshFilter ()

reset the filter editor

public abstract void restoreExistingSubExpression ()

Restores active subexpression to original state.

public abstract void setAbleToApply (boolean ableToApply)

set whether the filter expression is changed

Parameters
ableToApply whether the filter expression is changed

public abstract void setAbleToCancel (boolean ableToCancel)

set whether the filter expression change can be cancelled

Parameters
ableToCancel whether the filter expression change can be cancelled

public abstract void setActiveAction (int activeAction)

Sets active action for the filter editor

Parameters
activeAction action id

public abstract void setActiveLeftKey (int key)

Return the currently left node key.

Parameters
key the active left node key for the filter editor

public abstract void setActiveNodeKey (int key)

Set the currently active expression node key.

Parameters
key the active expression node key for the filter editor

public abstract void setActiveOperatorKey (int key)

Return the currently operator node key.

Parameters
key the active operator node key for the filter editor

public abstract void setActiveRightKey (int key)

Return the currently right node key.

Parameters
key the active right node key for the filter editor

public abstract void setAutoApply (boolean autoApply)

Set auto apply be on or off

Parameters
autoApply whether auto apply is on or off

public abstract void setContextMenuName (String contextMenuName)

Specifies name for context Menu.

Parameters
contextMenuName string

public abstract void setCreateAttrExpressionType (int type)

Specifies which type of Attribute Expression is defined when creating a new Filter sub expression.
This value will determine behavior to take when creating a new Attribute Filter expression. It'll indicate what type of expression to be created.
This will ex[ect an int value indicating any of the following constants:

  • L_CREATE_EXP_ATT_QUAL_TYPE = 1 (Default value in Report Filter)
  • L_CREATE_EXP_ATT_ELEM_TYPE = 2 (Default value in View Filter)

Parameters
type int attribute expression type.

public abstract void setDisplayFlag (int displayFlag)

Sets the filter editor display flags. It is a combination of the constants with name beginning with DISPLAY_.

Parameters
displayFlag the display flag for the filter editor

public abstract void setEditable (boolean editable)

Set whether the filter is editable or not

Parameters
editable whether the filter is editable

public abstract void setFilter (WebFilter filter)

Set the filter object associated with this filter editor

Parameters
filter the filter object

public abstract void setFilterType (int filterType)

Set the filter type, value should be from EnumFilterTypes

Parameters
filterType the filter type

public abstract void setIncrementalBlockBegin (int blockBegin)

setIncrementalBlockBegin, function for setting incremental block begin

Parameters
blockBegin index for block begin in shopping cart

public abstract void setIncrementalBlockCount (int count)

setIncrementalBlockCount, function for setting incremental block count

Parameters
count size of block for shopping cart

public abstract void setMatchCase (boolean matchCase)

Sets the match case value

Parameters
matchCase the match case to set

public abstract void setMetricValidationLevel (int value)

Specifies level of validation to be enforced when editing or adding a Metric sub expression.
It takes only following values denoted in FilterEditor interface:

Parameters
value denotes an integer value which indicates level of validation.

public abstract void setPerformSearch (boolean performaSearch)

set whether it's performing a search

Parameters
performaSearch whether it's performing a search

public abstract void setSearchName (String searchName)

Sets the search field content

Parameters
searchName the search name to set

public abstract void setSeparator (String separator)

Set the seperator for filter display. It's the characters displayed before each sub expression.

Parameters
separator the seperator for filter display

public abstract void setTitle (String title)

Set the title for this filter editor

Parameters
title the editor title

public abstract void setValidationInfo (WebFilterEditorException wfe)

Sets the ValidationInfo for the filter editor

Parameters
wfe the validation info as a WebFilterEditorException instance

public abstract boolean validFilterExpression ()

Checks whether or not filter expression has an uncompleted element list subexpression.

Returns
  • true if expression is well formed.