com.technia.tvc.structurebrowser.actions

Class TableBeanAction

java.lang.Object

com.technia.tvc.struts.action.Action

com.technia.tvc.core.actions.TVCAction

com.technia.tvc.core.actions.NewTxAction

com.technia.tvc.structurebrowser.actions.TableBeanAction

All Implemented Interfaces:

com.technia.tvc.structurebrowser.util.Constants

Direct Known Subclasses:

InstantiateBeanAction, ProcessTableBeanAction

public abstract class TableBeanAction
extends NewTxAction
implements com.technia.tvc.structurebrowser.util.Constants

Abstract implementation of an action class that performs actions on an instance of TableBean. This class takes care of basics such as looking up the TableBean instance in the users current session as well as loading appropriate view, table and filter into the TableBean.

Field Summary

Fields inherited from class com.technia.tvc.core.actions.TVCAction

CLIENT_TASK_ERROR, CLIENT_TASK_ERROR_KEY, CLIENT_TASK_NOTICE_KEY, CLIENT_TASK_WARNING_KEY, GLOBAL_ERROR_KEY, INFORMATION_ERROR

Fields inherited from class com.technia.tvc.struts.action.Action

servlet

Fields inherited from interface com.technia.tvc.structurebrowser.util.Constants

CHOOSABLE_FILTERS_REQUEST_KEY, CHOOSABLE_SYSTEM_TABLES_REQUEST_KEY, CHOOSABLE_VIEWS_REQUEST_KEY, CURRENT_FILTERS_REQUEST_KEY, CURRENT_SYSTEM_TABLE_REQUEST_KEY, CURRENT_VIEW_REQUEST_KEY, DISPLAY_MODE_CURRENT_VIEW_REQUEST_KEY, DISPLAYABLE_CHOOSABLE_FILTERS_REQUEST_KEY, DISPLAYABLE_CHOOSABLE_SYSTEM_TABLES_REQUEST_KEY, DISPLAYABLE_CHOOSABLE_VIEWS_REQUEST_KEY, DISPLAYABLE_CURRENT_FILTERS_REQUEST_KEY, DISPLAYABLE_CURRENT_SYSTEM_TABLE_REQUEST_KEY, DISPLAYABLE_CURRENT_VIEW_REQUEST_KEY, KEY_GENERATOR_SESSION_KEY, TABLE_BEAN_REQUEST_KEY, TABLE_NAME_REQUEST_KEY

Constructor Summary

Constructors

Constructor and Description
TableBeanAction(TxType type) Public constructor that defines the transaction type that should be used when performing actions related to a TableBean instance.

Method Summary

Modifier and Type	Method and Description
protected void	afterPerform(TableBean<?> table, javax.servlet.http.HttpServletRequest request) Optional method the can be implemented to perform certain logic AFTER the perform(TableBean, ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) method is invoked.
protected void	beforePerform(TableBean<?> table, javax.servlet.http.HttpServletRequest request) Optional method the can be implemented to perform certain logic BEFORE the perform(TableBean, ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) method is invoked.
protected void	copyEnv(javax.servlet.http.HttpServletRequest request, TableBean<?> oldTable, TableBean<?> newTable) Copy the environment from the original table but do not overwrite the existing variables.
Environment	createEnvironment(javax.servlet.http.HttpServletRequest request)
abstract TableBean<?>	createTable(javax.servlet.http.HttpServletRequest request) This method should be implemented in subclasses to create a new instance of a class implementing the TableBean interface.
void	discardEnv(TableBean<?> table) Discard the table's environment.
void	discardTable(javax.servlet.http.HttpServletRequest request, java.lang.String key) Remove the table from the current HTTP session.
protected void	ensureContextMenu(javax.servlet.http.HttpServletRequest req, TableBean<?> table) Ensures that the context menu is loaded.
protected void	ensureMenuBar(javax.servlet.http.HttpServletRequest req, TableBean<?> table)
com.technia.tvc.struts.action.ActionForward	execute(TxContext txc, com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will lookup the TableBean instance in the users current session and delegate to perform(TableBean,ActionMapping,ActionForm,HttpServletRequest, HttpServletResponse) to perform actual business logic on the table.
protected void	finishRequest(TableBean<?> table, javax.servlet.http.HttpServletRequest request)
static java.lang.String	generateKey(javax.servlet.http.HttpServletRequest request) Generate a new table key.
protected java.lang.String[]	getChoosableViewNamesParameter(javax.servlet.http.HttpServletRequest request) Returns the names of the choosable views that should be available to the TableBean.
Environment	getEnv(javax.servlet.http.HttpServletRequest request, TableBean<?> table) Returns the current environment, if the table doesn't have an environment a new will be created but not associated with the table.
protected java.lang.String	getGeneratedKey(javax.servlet.http.HttpServletRequest request)
protected java.lang.Object	getMonitor(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse resp)
protected java.lang.String	getObjectNameFromRequest(javax.servlet.http.HttpServletRequest request) Returns the name of the TableBean.
protected TableBean<?>	getOriginalTable(javax.servlet.http.HttpServletRequest request, TableBean<?> table)
protected PageConfig	getPageConfig(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns the PageConfig that should be used.
protected java.lang.String	getParameter(Environment env, javax.servlet.http.HttpServletRequest req, java.lang.String name) Returns the value of the parameter.
TableBean<?>	getTable(javax.servlet.http.HttpServletRequest request) Lookup the TableBean in the users current session.
TableBean<?>	getTable(javax.servlet.http.HttpServletRequest request, java.lang.String key) Retrieve table, from the given parameter
protected java.lang.String	getViewNameParameter(javax.servlet.http.HttpServletRequest request) Returns the name of the view that should be used by the TableBean.
static void	handleErrors(javax.servlet.http.HttpServletRequest request, com.technia.tvc.struts.action.ActionMessages errors, boolean showClientTasksAboveTable)
protected MenuBar	insertCategoryMenu(MenuBar menuBar, javax.servlet.http.HttpServletRequest req, TableBean<?> table, Environment env)
protected Menu	loadContextMenu(java.lang.String contextMenuName, Environment env) Load a context menu.
protected MenuBar	loadMenuBar(java.lang.String toolbarName, Environment env) Load a MenuBar.
abstract com.technia.tvc.struts.action.ActionForward	perform(TableBean<?> table, com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method should be overridden to perform business logic on the TableBean instance.
protected javax.servlet.http.HttpServletRequest	replaceRequest(javax.servlet.http.HttpServletRequest request) This method allows subclasses to replace the HttpServletRequest instance that will be used when processing the request.
void	saveEnv(javax.servlet.http.HttpServletRequest request, TableBean<?> table) Set the table's environment from the current request.
void	saveTable(javax.servlet.http.HttpServletRequest request, TableBean<?> table, java.lang.String key) Save the table in the current HTTP session using the specified key.
protected boolean	setSystemTableAndFilters(javax.servlet.http.HttpServletRequest request)
protected boolean	setView(javax.servlet.http.HttpServletRequest request)
protected void	storePageConfig(javax.servlet.http.HttpServletRequest request, TableBean<?> table, PageConfig pageConfig) Stores the page config on the tablebean and initiates the SelectionsManager.
static void	storeRequestAttributes(javax.servlet.http.HttpServletRequest request, TableBean<?> tableBean)
protected void	update(com.technia.tvc.core.gui.common.Reloadable item)
TableBean<?>	updateTable(javax.servlet.http.HttpServletRequest request, TableBean<?> table) Updates the table for the current request.

Methods inherited from class com.technia.tvc.core.actions.NewTxAction

executeImpl, getOriginContext, handleClientTasks, handleException, handleLogin, handleTransactionEndFailure, ignoreClientTasks

Methods inherited from class com.technia.tvc.core.actions.TVCAction

addError, addError, addErrors, addGlobalError, addGlobalError, addInformationError, asActionError, asActionErrors, copy, debugRequest, execute, findErrorForward, findForwardOrTargetPage, perform, perform, saveError, saveError, saveGlobalError, saveGlobalError, saveInformationError, setLocale

Methods inherited from class com.technia.tvc.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableBeanAction

public TableBeanAction(TxType type)

Public constructor that defines the transaction type that should be used when performing actions related to a TableBean instance.

Method Detail

generateKey

public static java.lang.String generateKey(javax.servlet.http.HttpServletRequest request)

Generate a new table key.

handleErrors

public static void handleErrors(javax.servlet.http.HttpServletRequest request,
                                com.technia.tvc.struts.action.ActionMessages errors,
                                boolean showClientTasksAboveTable)

storeRequestAttributes

public static void storeRequestAttributes(javax.servlet.http.HttpServletRequest request,
                                          TableBean<?> tableBean)
                                   throws TVCException

Throws:

TVCException

afterPerform

protected void afterPerform(TableBean<?> table,
                            javax.servlet.http.HttpServletRequest request)

Optional method the can be implemented to perform certain logic AFTER the perform(TableBean, ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) method is invoked.

beforePerform

protected void beforePerform(TableBean<?> table,
                             javax.servlet.http.HttpServletRequest request)

Optional method the can be implemented to perform certain logic BEFORE the perform(TableBean, ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) method is invoked.

copyEnv

protected void copyEnv(javax.servlet.http.HttpServletRequest request,
                       TableBean<?> oldTable,
                       TableBean<?> newTable)

Copy the environment from the original table but do not overwrite the existing variables.

Parameters:

request - The current request

oldTable - The old table to copy the env variables from

newTable - The new table to copy the env veriables to

Since:

2011.1.0

createEnvironment

public Environment createEnvironment(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The request object.

Returns:

Returns a new environment object.

Since:

6.1.2

createTable

public abstract TableBean<?> createTable(javax.servlet.http.HttpServletRequest request)
                                  throws TVCException

This method should be implemented in subclasses to create a new instance of a class implementing the TableBean interface. Note that some (or probably most) subclasses should NOT create new instances of TableBean as they are generic and therefore don't have a clue which implementation class is required for a certain request, in that case this method should return null.

Throws:

TVCException

discardEnv

public void discardEnv(TableBean<?> table)

Discard the table's environment.

discardTable

public void discardTable(javax.servlet.http.HttpServletRequest request,
                         java.lang.String key)

Remove the table from the current HTTP session.

ensureContextMenu

protected void ensureContextMenu(javax.servlet.http.HttpServletRequest req,
                                 TableBean<?> table)

Ensures that the context menu is loaded.

Parameters:

req - The current request

table - The current table

ensureMenuBar

protected void ensureMenuBar(javax.servlet.http.HttpServletRequest req,
                             TableBean<?> table)

insertCategoryMenu

protected MenuBar insertCategoryMenu(MenuBar menuBar,
                                     javax.servlet.http.HttpServletRequest req,
                                     TableBean<?> table,
                                     Environment env)

execute

public com.technia.tvc.struts.action.ActionForward execute(TxContext txc,
                                                           com.technia.tvc.struts.action.ActionMapping mapping,
                                                           com.technia.tvc.struts.action.ActionForm form,
                                                           javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)
                                                    throws java.lang.Exception

This method will lookup the TableBean instance in the users current session and delegate to perform(TableBean,ActionMapping,ActionForm,HttpServletRequest, HttpServletResponse) to perform actual business logic on the table.

Specified by:

execute in class NewTxAction

Parameters:

txc - The transaction context.

mapping - The action mappings.

form - The action form.

request - The HTTP request.

response - The HTTP response.

Returns:

The action forward to which the request will be forwarded.

Throws:

java.lang.Exception - If an error occurs.

finishRequest

protected void finishRequest(TableBean<?> table,
                             javax.servlet.http.HttpServletRequest request)
                      throws TVCException

Parameters:

table - The current table.

request - The current request.

Throws:

TVCException - If unable to finish the request processing, such as validating the table.

getChoosableViewNamesParameter

protected java.lang.String[] getChoosableViewNamesParameter(javax.servlet.http.HttpServletRequest request)

Returns the names of the choosable views that should be available to the TableBean.

getEnv

public Environment getEnv(javax.servlet.http.HttpServletRequest request,
                          TableBean<?> table)

Returns the current environment, if the table doesn't have an environment a new will be created but not associated with the table.

getGeneratedKey

protected java.lang.String getGeneratedKey(javax.servlet.http.HttpServletRequest request)

getMonitor

protected java.lang.Object getMonitor(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse resp)
                               throws TVCException

Overrides:

getMonitor in class NewTxAction

Parameters:

request - The current request.

resp - The current response.

Returns:

Returns the object whose monitor should be obtained when executing the execute method.

Throws:

TVCException - Throw this if unable to continue.

getObjectNameFromRequest

protected java.lang.String getObjectNameFromRequest(javax.servlet.http.HttpServletRequest request)

Returns the name of the TableBean.

getOriginalTable

protected TableBean<?> getOriginalTable(javax.servlet.http.HttpServletRequest request,
                                        TableBean<?> table)

getPageConfig

protected PageConfig getPageConfig(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws TVCException

Returns the PageConfig that should be used.

Parameters:

request - The request.

response - The response.

Returns:

Returns the PageConfig that was loaded.

Throws:

TVCException - If loading the PageConfig failed.

Since:

6.1.5

getParameter

protected java.lang.String getParameter(Environment env,
                                        javax.servlet.http.HttpServletRequest req,
                                        java.lang.String name)

Returns the value of the parameter. If a value of the parameter was found in the environment, that value will be returned. Otherwise the value in the request will be returned.

Parameters:

env - The environment.

req - The request.

name - The name of the parameter.

Returns:

The value.

Since:

5.1

getTable

public TableBean<?> getTable(javax.servlet.http.HttpServletRequest request,
                             java.lang.String key)
                      throws TVCException

Retrieve table, from the given parameter

Throws:

TVCException

getTable

public TableBean<?> getTable(javax.servlet.http.HttpServletRequest request)
                      throws TVCException

Lookup the TableBean in the users current session. If no table was found this method will delegate to createTable(HttpServletRequest) to create a new instance of the desired TableBean class.

Throws:

TVCException

getViewNameParameter

protected java.lang.String getViewNameParameter(javax.servlet.http.HttpServletRequest request)

Returns the name of the view that should be used by the TableBean.

loadContextMenu

protected Menu loadContextMenu(java.lang.String contextMenuName,
                               Environment env)

Load a context menu. If the name of the toolbar is not null, that menu will be loaded and returned.

Parameters:

contextMenuName - The name of the context menu.

env - The environment.

Returns:

The menu, or null.

Since:

6.3.0

loadMenuBar

protected MenuBar loadMenuBar(java.lang.String toolbarName,
                              Environment env)

Load a MenuBar. If the name of the toolbar is not null, that menu will be loaded and returned.

Parameters:

toolbarName - The name of the toolbar menu.

env - The environment.

Returns:

The menubar. If this method failed to load a menubar it will return null.

Since:

6.3.0

perform

public abstract com.technia.tvc.struts.action.ActionForward perform(TableBean<?> table,
                                                                    com.technia.tvc.struts.action.ActionMapping mapping,
                                                                    com.technia.tvc.struts.action.ActionForm form,
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response)
                                                             throws java.lang.Exception

This method should be overridden to perform business logic on the TableBean instance.

Throws:

java.lang.Exception

replaceRequest

protected javax.servlet.http.HttpServletRequest replaceRequest(javax.servlet.http.HttpServletRequest request)

This method allows subclasses to replace the HttpServletRequest instance that will be used when processing the request. Note that this method will be called after the loading of the PageConfig has taken place, i.e., you can not rely upon providing essential information to the getPageConfig(HttpServletRequest, HttpServletResponse) method with the replaced request instance.

Parameters:

request - The current request.

Returns:

Returns the request that will be used.

Since:

6.1.5

saveEnv

public void saveEnv(javax.servlet.http.HttpServletRequest request,
                    TableBean<?> table)

Set the table's environment from the current request.

saveTable

public void saveTable(javax.servlet.http.HttpServletRequest request,
                      TableBean<?> table,
                      java.lang.String key)

Save the table in the current HTTP session using the specified key.

setSystemTableAndFilters

protected boolean setSystemTableAndFilters(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The current request.

Returns:

Returns whether the system table and filters should be set on the TableBean when it is being updated. Default is false.

Since:

5.1.2

setView

protected boolean setView(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The current request.

Returns:

Returns whether the view and choosable views should be set on the TableBean when it is being updated. Default is false.

Since:

5.2.1

storePageConfig

protected void storePageConfig(javax.servlet.http.HttpServletRequest request,
                               TableBean<?> table,
                               PageConfig pageConfig)

Stores the page config on the tablebean and initiates the SelectionsManager.

Parameters:

request - The current request

table - The current tablebean

pageConfig - The page config (can be null if a page config isn't used).

Since:

2009.3.0

update

protected void update(com.technia.tvc.core.gui.common.Reloadable item)
               throws TVCException

Parameters:

item - The component to update if necessary.

Throws:

TVCException - If unable to update the component.

updateTable

public TableBean<?> updateTable(javax.servlet.http.HttpServletRequest request,
                                TableBean<?> table)
                         throws TVCException

Updates the table for the current request. If the table should be discarded this method should return null, this method could also return a different table to replace the argument.

This implementation will make sure the current table's view, system table and filters are valid.

Throws:

TVCException