com.sas.actionprovider.support.olaptableview
Class SwingOLAPDrillStateSupport

com.sas.actionprovider.support.olaptableview.SwingOLAPDrillStateSupport

All Implemented Interfaces:

DynamicActionCountInterface

public class SwingOLAPDrillStateSupport

In the context of the ActionProvider framework, this Support class assists in the registering and retrieval of actions for OLAP viewer components such as the OLAPTableView.

Since:

3.0

Field Summary

Fields inherited from class com.sas.actionprovider.support.olaptableview.BaseOLAPDrillStateSupport

DRILL_DOWN_MEMBER_ACTION, DRILL_STATE_AREA, DRILL_TO_LEVEL_ACTION

Fields inherited from class com.sas.actionprovider.support.BaseActionProviderSupport

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

Constructor Summary

SwingOLAPDrillStateSupport(java.lang.Class actionClass)
Constructor

Method Summary

protected java.util.Map	getActionScopeAttributeMap(java.lang.String actionType, ActionSupportFilter actionFilter) Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area and a specific actionType.
protected java.util.Map	getAreaScopeAttributeMap(ActionSupportFilter actionFilter) Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area.
protected boolean	isConverted()
BaseAction	newActionInstance(java.lang.String actionType) Return a newly instantiated default Action based on the specified actionType or return null if actionType not recognized.
BaseAction	newActionInstance(java.lang.String areaType, java.lang.String actionType) Return a newly instantiated default Action based on the specified actionType or return null if actionType not recognized.
protected BaseAction	setActionAttributes(BaseAction action, ActionSupportFilter actionFilter)
protected boolean	validArea(Area area, ActionSupportFilter filter) Validates that the given Area's 'type' and, if specified, its 'value' constraints are met by the information provided on the action filter.

Methods inherited from class com.sas.actionprovider.support.olaptableview.BaseOLAPDrillStateSupport

createDefaultActions, getActionCount, initialize, isNavigatable

Methods inherited from class com.sas.actionprovider.support.BaseActionProviderSupport

addDefaultAction, getAction, getActionId, getActionOrderList, getActionProvider, getActions, getActionScopeAttribute, getDefaultAction, getLocale, listActionTypes, listAreaTypes, listDefaultActions, reset, setAction, setActionOrderList, setActionProvider, setLocale

Constructor Detail

SwingOLAPDrillStateSupport

public SwingOLAPDrillStateSupport(java.lang.Class actionClass)

Constructor

Parameters:

actionClass - The class used to instantiate new actions.

Method Detail

newActionInstance

public BaseAction newActionInstance(java.lang.String actionType)

Return a newly instantiated default Action based on the specified actionType or return null if actionType not recognized.

Parameters:

actionType - the key associated with a defined action type.

Returns:

a new action of the specified type.

newActionInstance

public BaseAction newActionInstance(java.lang.String areaType,
                                    java.lang.String actionType)

Return a newly instantiated default Action based on the specified actionType or return null if actionType not recognized.

Specified by:

newActionInstance in class BaseActionProviderSupport

Parameters:

actionType - the key associated with a defined action type.

areaType - the key associated with a defined area type.

Returns:

a new action of the specified type.

getAreaScopeAttributeMap

protected java.util.Map getAreaScopeAttributeMap(ActionSupportFilter actionFilter)

Description copied from class: BaseActionProviderSupport

Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area.

Specified by:

getAreaScopeAttributeMap in class BaseActionProviderSupport

Parameters:

actionFilter - Defines the specific area.

Returns:

mappings for a pre-defined set of Action Attribues keys

getActionScopeAttributeMap

protected java.util.Map getActionScopeAttributeMap(java.lang.String actionType,
                                                   ActionSupportFilter actionFilter)

Description copied from class: BaseActionProviderSupport

Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area and a specific actionType.

Overrides:

getActionScopeAttributeMap in class BaseActionProviderSupport

actionFilter - Defines the specific area.

isConverted

protected boolean isConverted()

setActionAttributes

protected BaseAction setActionAttributes(BaseAction action,
                                         ActionSupportFilter actionFilter)

validArea

protected boolean validArea(Area area,
                            ActionSupportFilter filter)

Validates that the given Area's 'type' and, if specified, its 'value' constraints are met by the information provided on the action filter.

Specified by:

validArea in class BaseActionProviderSupport

Parameters:

area - The Area object that may or may not specify certain area 'values'.

actionFilter - the ActionSupportFilter that the component passed as an argument on the getActions() method.

Returns:

a boolean indicating whether the current area represented on the actionFilter matches any of the specified values on the Area object.

See Also:

BaseActionProviderSupport.setAction(com.sas.actionprovider.BaseAction, java.util.Collection, com.sas.actionprovider.Area), BaseActionProviderSupport.getActions(com.sas.actionprovider.ActionSupportFilter)