*** This class is subject to change ***

com.sas.dataexplorer.actionprovider.strategies.dataexplorer
Class AppliedFiltersStrategy

java.lang.Object
  |
  +--com.sas.actionprovider.strategies.BaseActionStrategy
        |
        +--com.sas.dataexplorer.actionprovider.strategies.dataexplorer.BaseVDEStrategy
              |
              +--com.sas.dataexplorer.actionprovider.strategies.dataexplorer.AppliedFiltersStrategy

All Implemented Interfaces:

ActionStatusKeysInterface, ActionStrategyInterface

public class AppliedFiltersStrategy

extends BaseVDEStrategy

The AppliedFilterStrategy object's purpose is to surface the logic related to initializing the name and description of the applied filters action. In the ActionProviderFramework, the AppliedFiltersStrategy object relates to the AppliedFiltersCommand.

Fields inherited from class com.sas.dataexplorer.actionprovider.strategies.dataexplorer.BaseVDEStrategy

ATTR_TITLE, VDE

Fields inherited from class com.sas.actionprovider.strategies.BaseActionStrategy

TEMPLATE_DELIMITER

Fields inherited from interface com.sas.actionprovider.ActionStatusKeysInterface

AREA_DISABLED, DISABLED, ENABLED, IS_CURRENT_STATE_DISABLED, MODEL_MEMBER_DISABLED, MODEL_STATE_DISABLED, MODEL_TYPE_DISABLED, UNSUPPORTED, VIEWER_DISABLED

Constructor Summary

AppliedFiltersStrategy()
Default constructor.

AppliedFiltersStrategy(boolean swing, VisualDataExplorerActionUtil util)
Constructor for specifying type ( swing/http ) of strategy object.

Method Summary

String	getDescription(Locale locale) Gets the description of this strategy object.
String	getDisabledImageName() Gets the name of the image to display when the action is disabled.
String	getImageName() Gets the name of the image associated with this strategy object.
String	getName(Locale locale) Gets the name of this strategy object.
protected void	initialize() Initialize this strategy object.
protected void	initializeActionAttributes(BaseAction action, String areaType, Locale locale) Initializes the attributes for the instance of the action being initialized in the action provider support class.

Methods inherited from class com.sas.dataexplorer.actionprovider.strategies.dataexplorer.BaseVDEStrategy

setLocaleDependentDefaultAttributes

Methods inherited from class com.sas.actionprovider.strategies.BaseActionStrategy

addDynamicValueInfo, addDynamicValueInfo, getActionStatus, getCustomAttributeValue, getDynamicValue, getUtilObject, initializeAction, isSwing, setActionAttributes, setSwing, setUtilObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AppliedFiltersStrategy

public AppliedFiltersStrategy()

Default constructor. Calls the other constructor for specifying strategy type.

AppliedFiltersStrategy

public AppliedFiltersStrategy(boolean swing,
                              VisualDataExplorerActionUtil util)

Constructor for specifying type ( swing/http ) of strategy object.

Parameters:

swing - boolean indicating whether the strategy will be used in a swing environment. If false, the strategy is http type.

util - the VisualDataExplorerActionUtil class used by the strategy

Method Detail

initializeActionAttributes

protected void initializeActionAttributes(BaseAction action,
                                          String areaType,
                                          Locale locale)

Initializes the attributes for the instance of the action being initialized in the action provider support class.

Overrides:

initializeActionAttributes in class BaseVDEStrategy

Parameters:

action - the action

areaType - the area type of the action. There are three valid values for this parameter: VisualDataExplorerMenuBarAreaInterface.MENU_AREA, VisualDataExplorerMenuBarAreaInterface.TOOLBAR_AREA, and VisualDataExplorerMenuBarAreaInterface.RIGHT_AREA

locale - the locale

initialize

protected void initialize()

Initialize this strategy object.

Via the BaseActionStrategy.addDynamicValueInfo(java.lang.String, java.lang.String, java.lang.Object, java.lang.String)method, this method registers the information for dynamic values.

• com.sas.actionprovider.strategies.olap.SelectorDynamicValueKeys#MODEL
• com.sas.actionprovider.strategies.olap.SelectorDynamicValueKeys#TABLE

Overrides:

initialize in class BaseVDEStrategy

Following copied from class: com.sas.actionprovider.strategies.BaseActionStrategy

See Also:

#setReturnStatus

getName

public String getName(Locale locale)

Gets the name of this strategy object.

Overrides:

getName in class BaseVDEStrategy

Parameters:

locale - The locale

Returns:

the name of this strategy object

getDescription

public String getDescription(Locale locale)

Gets the description of this strategy object. The description is the text that is displayed on the dropdown menu for the VisualDataExplorer menu bar.

Overrides:

getDescription in class BaseVDEStrategy

Parameters:

locale - The locale

Returns:

the description of this strategy object

getImageName

public String getImageName()

Gets the name of the image associated with this strategy object. The image name is the name of the image that is displayed on the dropdown menu for the VisualDataExplorer menu bar.

Overrides:

getImageName in class BaseVDEStrategy

Returns:

null The image name is determined by VisualDataExplorerActionUtil.getAppliedFilterImageName(com.sas.actionprovider.ActionSupportFilter)

getDisabledImageName

public String getDisabledImageName()

Gets the name of the image to display when the action is disabled. The disabled image name is the name of the image that is displayed on the dropdown menu for the VisualDataExplorer menu bar when this action is disabled.

Overrides:

getDisabledImageName in class BaseVDEStrategy

Returns:

null This action will never be disabled. The image will always be blankImage or selectedMenuItem.gif.

*** This class is subject to change ***