com.sas.actionprovider.support.tableview
Class HttpTableViewSupport

com.sas.actionprovider.support.tableview.HttpTableViewSupport

All Implemented Interfaces:

HttpRelationalActionTypeKeysInterface, RelationalActionTypeKeysInterface, TableViewAreaInterface

Direct Known Subclasses:

HttpRemoteFileSelectorTableViewSupport

public class HttpTableViewSupport
implements HttpRelationalActionTypeKeysInterface

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

Field Summary

Fields inherited from class com.sas.actionprovider.support.tableview.BaseTableViewSupport

RB_KEY

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.tableview.HttpRelationalActionTypeKeysInterface

CANCEL_ACTION, CLEAR_SORT_EDIT_ENABLED_ACTION, COLUMN_HEADER_ACTION, COMMIT_ACTION, COMMIT_DELETE_ACTION, DELETE_ACTION, INSERT_ACTION, MOVE_COLUMN_LEFT_EDIT_ENABLED_ACTION, MOVE_COLUMN_RIGHT_EDIT_ENABLED_ACTION, RESIZE_COLUMN_ACTION, SORT_COLUMN_ASCENDING_EDIT_ENABLED_ACTION, SORT_COLUMN_DESCENDING_EDIT_ENABLED_ACTION, UPDATE_ACTION

Fields inherited from interface com.sas.actionprovider.support.tableview.RelationalActionTypeKeysInterface

CALCULATED_ITEM_SELECTOR_ACTION, CLEAR_SORT_ACTION, EXCEPTION_HIGHLIGHTING_SELECTOR_ACTION, EXPORT_TO_ACTION, EXPORT_TO_EXCEL_ACTION, FILTER_SELECTOR_ACTION, FORMAT_SELECTOR_ACTION, MOVE_COLUMN_LEFT_ACTION, MOVE_COLUMN_RIGHT_ACTION, PERCENT_CALCULATIONS_SELECTOR_ACTION, QUERY_SELECTOR_ACTION, RANKING_SELECTOR_ACTION, SORT_COLUMN_ASCENDING_ACTION, SORT_COLUMN_DESCENDING_ACTION, SORT_SELECTOR_ACTION, TOTALS_SELECTOR_ACTION

Fields inherited from interface com.sas.actionprovider.support.tableview.TableViewAreaInterface

COLUMN_HEADER_AREA, DATA_CELL_AREA, EDIT_COLUMN_AREA, EDIT_ROW_AREA, ROW_HEADER_AREA, TITLE_AREA

Constructor Summary

HttpTableViewSupport(java.lang.Class actionClass)
Default Constructor

Method Summary

protected void	createDefaultActions() Initializes the actionClass property and creates the default actions that this class supports.
protected java.lang.Object	getActionScopeAttribute(java.lang.String actionType, java.lang.String attributeName, ActionSupportFilter filter, java.lang.Object currentValue) Returns a specific dynamic value for an attribute whose value varies according to the type of action being generated.
protected java.util.Map	getActionScopeAttributeMap(java.lang.String actionType, ActionSupportFilter filter) Returns mappings for a pre-defined set of Action Attribues 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.
protected ActionOrderList	getColumnHeaderOrderList()
protected ActionOrderList	getEditColumnOrderList()
protected ActionOrderList	getEditRowOrderList()
protected java.util.Map	initializeShortActionTypeMap() This method is called by the constructor and used to initiallize the actionTypeToShortActionTypeMap map.
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 void	registerColumnHeaderActions(java.lang.String areaType)
protected void	registerDynamicValueInfo() Registers, via addDynamicValueInfo method, the dynamic value information for different areas.
protected void	registerEditColumnActions(java.lang.String areaType)
protected void	registerEditRowActions(java.lang.String areaType)
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.tableview.BaseTableViewSupport

createAndRegisterAction, getCustomAttributeValue, initialize

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

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

Constructor Detail

HttpTableViewSupport

public HttpTableViewSupport(java.lang.Class actionClass)

Default Constructor

Parameters:

actionClass - The class used to instantiate new actions.

Method Detail

registerDynamicValueInfo

protected void registerDynamicValueInfo()

Registers, via addDynamicValueInfo method, the dynamic value information for different areas.

Overrides:

registerDynamicValueInfo in class BaseTableViewSupport

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 BaseTableViewSupport

registerColumnHeaderActions

protected void registerColumnHeaderActions(java.lang.String areaType)

getColumnHeaderOrderList

protected ActionOrderList getColumnHeaderOrderList()

registerEditColumnActions

protected void registerEditColumnActions(java.lang.String areaType)

getEditColumnOrderList

protected ActionOrderList getEditColumnOrderList()

registerEditRowActions

protected void registerEditRowActions(java.lang.String areaType)

getEditRowOrderList

protected ActionOrderList getEditRowOrderList()

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 - the key associated with a defined area.

actionType - the key associated with a defined action type.

Returns:

a new action of the specified type.

getActionScopeAttributeMap

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

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

Overrides:

getActionScopeAttributeMap in class BaseActionProviderSupport

Parameters:

actionType - the key associated with a defined action type

filter - Defines the specific area

Returns:

mappings for a pre-defined set of Action Attribues keys

getAreaScopeAttributeMap

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.

Specified by:

getAreaScopeAttributeMap in class BaseActionProviderSupport

Parameters:

filter - Defines the specific area

Returns:

mappings for a pre-defined set of Action Attribues keys

getActionScopeAttribute

protected java.lang.Object getActionScopeAttribute(java.lang.String actionType,
                                                   java.lang.String attributeName,
                                                   ActionSupportFilter filter,
                                                   java.lang.Object currentValue)

Description copied from class: BaseActionProviderSupport

Returns a specific dynamic value for an attribute whose value varies according to the type of action being generated.

Overrides:

getActionScopeAttribute in class BaseActionProviderSupport

Parameters:

actionType - The key that uniquely identifies this type of action.

attributeName - The name of the dynamic attribute.

filter - Defines the specific area.

currentValue - The current value of this attribute on the action

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.

In the DATA_CELL_AREA, the Area 'values' should be the name of a column header that matches the header of the column corresponding to the column index provided on the action filter.

Overrides:

validArea in class BaseTableViewSupport

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