com.sas.actionprovider.support.graphics
Class HttpGraphSupport

com.sas.actionprovider.support.graphics.HttpGraphSupport

All Implemented Interfaces:

GraphAreaInterface

public class HttpGraphSupport

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

Field Summary

static java.lang.String	ANALYSIS_LABEL_ACTION
static java.lang.String	CATEGORIZATION_LABEL_ACTION The actionType key used to define the categorization label actions.
static java.lang.String	RB_KEY
static java.lang.String	RESIZE_GRAPH_ACTION The actionType key used to define the graph resize actions.
static java.lang.String	ZOOM_IN_GRAPH_ACTION
static java.lang.String	ZOOM_OUT_GRAPH_ACTION

Fields inherited from class com.sas.actionprovider.support.graphics.BaseGraphSupport

ASCENDING_SORT_ACTION, DESCENDING_SORT_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.graphics.GraphAreaInterface

ANALYSIS_LABEL_AREA, CATEGORIZATION_LABEL_AREA, CATEGORIZATION_VALUE_AREA, DATA_VALUE_AREA

Constructor Summary

HttpGraphSupport(java.lang.Class actionClass)
Constructor

Method Summary

protected void	createDefaultActions() Initializes the actionClass property and creates the default actions that this class supports.
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	getAreaScopeAttributeMap(ActionSupportFilter filter) Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area.
protected java.lang.Object	getCustomAttributeValue(java.lang.String attributeName, ActionSupportFilter filter) Returns a value for a specific custom attribute.
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 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.graphics.BaseGraphSupport

initialize

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

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

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

See Also:

Constant Field Values

CATEGORIZATION_LABEL_ACTION

public static final java.lang.String CATEGORIZATION_LABEL_ACTION

The actionType key used to define the categorization label actions.

See Also:

Constant Field Values

ANALYSIS_LABEL_ACTION

public static final java.lang.String ANALYSIS_LABEL_ACTION

See Also:

Constant Field Values

RESIZE_GRAPH_ACTION

public static final java.lang.String RESIZE_GRAPH_ACTION

The actionType key used to define the graph resize actions.

See Also:

Constant Field Values

ZOOM_IN_GRAPH_ACTION

public static final java.lang.String ZOOM_IN_GRAPH_ACTION

See Also:

Constant Field Values

ZOOM_OUT_GRAPH_ACTION

public static final java.lang.String ZOOM_OUT_GRAPH_ACTION

See Also:

Constant Field Values

Constructor Detail

HttpGraphSupport

public HttpGraphSupport(java.lang.Class actionClass)

Constructor

Parameters:

actionClass - The class used to instantiate new actions.

Method Detail

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.

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 BaseGraphSupport

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

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

getCustomAttributeValue

protected java.lang.Object getCustomAttributeValue(java.lang.String attributeName,
                                                   ActionSupportFilter filter)

Description copied from class: BaseActionProviderSupport

Returns a value for a specific custom attribute.

If a support class can derive custom attribute values, then it should override this method.

Otherwise, this method returns null.

Overrides:

getCustomAttributeValue in class BaseActionProviderSupport

Parameters:

attributeName - The name of the custom attribute

filter - The object that encapsulates all the specific query information.

Returns:

a value for a specific custom attribute.