com.sas.actionprovider.support.olapgraphics
Class SwingOLAPGraphSupport

com.sas.actionprovider.support.olapgraphics.SwingOLAPGraphSupport

All Implemented Interfaces:

OLAPGraphAreaInterface

@SASScope(value="ALL")
public class SwingOLAPGraphSupport

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

Field Summary

Fields inherited from class com.sas.actionprovider.support.olapgraphics.BaseOLAPGraphSupport

ASCENDING_SORT_ACTION, COLLAPSE_ACTION, DESCENDING_SORT_ACTION, DRILL_DOWN_ACTION, DRILL_UP_ACTION, EXPAND_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

Fields inherited from interface com.sas.actionprovider.support.olapgraphics.OLAPGraphAreaInterface

ANALYSIS_LABEL_AREA, CATEGORIZATION_LABEL_AREA, CATEGORIZATION_VALUE_AREA, DATA_VALUE_AREA

Constructor Summary

SwingOLAPGraphSupport(java.lang.Class actionClass)
Constructor

Method Summary

protected void	createDefaultActions() Initializes the actionClass property and creates the default actions that this class supports.
protected java.util.Map	getActionScopeAttributeMap(java.lang.String actionType, ActionSupportFilter filter) 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 filter) Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area.
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) Sets the action's attributes properly according to its actionType and the information supplied by the viewer component on the 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.olapgraphics.BaseOLAPGraphSupport

initialize

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

SwingOLAPGraphSupport

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

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:

areaType -

actionType - the key associated with a defined action type.

Returns:

a new action of the specified type.

createDefaultActions

protected void createDefaultActions()

Initializes the actionClass property and creates the default actions that this class supports. This method is called by the action provider that instantiates this support class.

Overrides:

createDefaultActions in class BaseOLAPGraphSupport

getActionScopeAttributeMap

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

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

filter - Defines the specific area.

getAreaScopeAttributeMap

protected java.util.Map getAreaScopeAttributeMap(ActionSupportFilter filter)

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:

filter - Defines the specific area.

Returns:

mappings for a pre-defined set of Action Attribues keys

setActionAttributes

protected BaseAction setActionAttributes(BaseAction action,
                                         ActionSupportFilter actionFilter)

Sets the action's attributes properly according to its actionType and the information supplied by the viewer component on the actionFilter. The method is called for any action(s) returned by the getOverrideAction() and getCustomActions() method. It should also be called by the implementation of getActions() for every default action that needs to be returned. For DRILL_DOWN_ACTION, DRILL_UP_ACTION, EXPAND_ACTION, EXPAND_ALL, COLLAPSE_ACTION, and COLLAPSE_ALL the method sets the model and tupleElement action attributes. It requires the model and a tupleElement attribute on the actionFilter to set these attributes.

Parameters:

action - The action object whose attributes are to be set.

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

Returns:

the action whose attributes have been set.

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)