com.sas.actionprovider.support.olaptableview
Class HttpOLAPDrillStateSupport

com.sas.actionprovider.support.olaptableview.HttpOLAPDrillStateSupport

All Implemented Interfaces:

DynamicActionCountInterface

public class HttpOLAPDrillStateSupport

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

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

HttpOLAPDrillStateSupport(java.lang.Class actionClass)
Constructor

Method Summary

protected BaseAction	defineActionAttributes(BaseAction action, java.lang.String actionType) Returns an action whose default dynamic attributes have been defined according to their actionType.
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 java.util.Map	initializeShortActionTypeMap() This method is called by the constructor and used to initiallize the actionTypeToShortActionTypeMap map.
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 and areaType or return null if actionType not recognized.
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

HttpOLAPDrillStateSupport

public HttpOLAPDrillStateSupport(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 and areaType 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 or null if the type is not recognized.

defineActionAttributes

protected BaseAction defineActionAttributes(BaseAction action,
                                            java.lang.String actionType)

Returns an action whose default dynamic attributes have been defined according to their actionType. The method also sets each attributes meta attributes ( e.g. visible ) accordingly.

Parameters:

action - The action object whose properties are to be defined.

actionType - the key associated with a defined action type.

Returns:

an action with all of its default attributes defined.

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.

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. If the Area is null or its 'type' is null then boolean true is returned because then there are no constraints specified and, therefore, any specification of the current area on the actionFilter must be valid. Otherwise, the method validates that the area 'type' and, if specified, area 'value' match the current area state represented by information on the actionFilter.

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)

initializeShortActionTypeMap

protected java.util.Map initializeShortActionTypeMap()

This method is called by the constructor and used to initiallize the actionTypeToShortActionTypeMap map. This map should contain the ActionType as the key and the new short name as the value. The short names are used to generate ids for HttpActions.

Overrides:

initializeShortActionTypeMap in class BaseActionProviderSupport