com.technia.tvc.structurebrowser.actions

Class InstantiateBeanAction

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

com.technia.tvc.structurebrowser.actions.InstantiateBeanAction

All Implemented Interfaces:

com.technia.tvc.structurebrowser.util.Constants

Direct Known Subclasses:

FlatTableBeanAction, StructureBeanAction

public abstract class InstantiateBeanAction
extends TableBeanAction

Base action class for all actions that will instantiate a new TableBean. Several methods can be overridden to customize the behavior.

See Also:

createTable(HttpServletRequest), createTableInstance(HttpServletRequest), afterCreate(HttpServletRequest, TableBean), getDefaultBeanClassName(), getRequiredBeanClassName(), getDefaultPageConfigName()

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
InstantiateBeanAction(TxType type) Constructor that allows you to specify the requested transaction type for all requests being processed.

Method Summary

Modifier and Type	Method and Description
protected void	afterCreate(javax.servlet.http.HttpServletRequest request, TableBean<?> table) This method is called after createTableInstance(HttpServletRequest) to initialize the table that just was created.
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.
protected EntryProcessor	createEntryProcessor(javax.servlet.http.HttpServletRequest request) Returns the EntryProcessor that has been configured for the current table/request.
protected SelectionBehavior	createSelectionBehavior(javax.servlet.http.HttpServletRequest request) Returns the SelectionBehavior that has been configured for the current table/request.
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.
protected TableFactory	createTableFactory(javax.servlet.http.HttpServletRequest request)
protected TableBean<?>	createTableInstance(javax.servlet.http.HttpServletRequest request) This method is called first inside createTable(HttpServletRequest) to create the actual TableBean instance.
protected com.technia.tvc.structurebrowser.util.TableLinkFactory	createTableLinkFactory(javax.servlet.http.HttpServletRequest request) Returns the TableLinkFactory that has been configured for the current table/request.
protected TableRenderer	createTableRenderer(javax.servlet.http.HttpServletRequest request) Returns the TableRenderer that has been configured for the current table/request.
protected ViewFactory	createViewFactory(javax.servlet.http.HttpServletRequest request) Returns the ViewFactory that has been configured for the current table/request.
protected void	finishRequest(TableBean<?> table, javax.servlet.http.HttpServletRequest request)
abstract boolean	getAlwaysInstantiate() Returns whether to always instantiate a TableBean when this action executes.
protected java.lang.Class<?>	getBeanClass(javax.servlet.http.HttpServletRequest request) Returns the TableBean class that should be instantiated.
protected java.lang.String	getBeanClassName(javax.servlet.http.HttpServletRequest request) Returns the TableBean class name.
protected boolean	getCopyEnv(javax.servlet.http.HttpServletRequest request, boolean defaultValue)
abstract java.lang.String	getDefaultBeanClassName() Returns the default TableBean class name that should be used unless another class name was explicitly defined in the request.
protected java.lang.String	getDefaultPageConfigName() Returns the default name of the PageConfig.
protected java.lang.String	getObjectNameFromRequest(javax.servlet.http.HttpServletRequest request) Returns the name of the TableBean.
protected PageConfig	getPageConfig(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns the PageConfig that should be used.
abstract java.lang.String	getRequiredBeanClassName() Returns the reqired TableBean class name.
protected boolean	isBeanInstantiated(javax.servlet.http.HttpServletRequest request) Returns true if a new TableBean was instantiated for this request.
protected void	setBeanInstantiated(javax.servlet.http.HttpServletRequest request, boolean instantiated) Sets whether a TableBean has been instantiated in this request.
protected boolean	setSystemTableAndFilters(javax.servlet.http.HttpServletRequest request)
protected boolean	setView(javax.servlet.http.HttpServletRequest request)
TableBean<?>	updateTable(javax.servlet.http.HttpServletRequest request, TableBean<?> table) Updates the table for the current request.

Methods inherited from class com.technia.tvc.structurebrowser.actions.TableBeanAction

afterPerform, beforePerform, createEnvironment, discardEnv, discardTable, ensureContextMenu, ensureMenuBar, execute, generateKey, getChoosableViewNamesParameter, getEnv, getGeneratedKey, getMonitor, getOriginalTable, getParameter, getTable, getTable, getViewNameParameter, handleErrors, insertCategoryMenu, loadContextMenu, loadMenuBar, perform, replaceRequest, saveEnv, saveTable, storePageConfig, storeRequestAttributes, update

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

InstantiateBeanAction

public InstantiateBeanAction(TxType type)

Constructor that allows you to specify the requested transaction type for all requests being processed.

Parameters:

type - The transaction type.

Method Detail

afterCreate

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

This method is called after createTableInstance(HttpServletRequest) to initialize the table that just was created.

Parameters:

request - The request.

table - The table that was created.

Throws:

TVCException - If a serious error occurs.

copyEnv

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

Description copied from class: TableBeanAction

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

Overrides:

copyEnv in class TableBeanAction

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

createEntryProcessor

protected EntryProcessor createEntryProcessor(javax.servlet.http.HttpServletRequest request)
                                       throws TVCException

Returns the EntryProcessor that has been configured for the current table/request.

Parameters:

request - The current request.

Returns:

Returns the EntryProcessor.

Throws:

TVCException - If a serious error occurs.

Since:

5.2.1

createSelectionBehavior

protected SelectionBehavior createSelectionBehavior(javax.servlet.http.HttpServletRequest request)
                                             throws TVCException

Returns the SelectionBehavior that has been configured for the current table/request.

Parameters:

request - The current request.

Returns:

Returns the SelectionBehavior.

Throws:

TVCException - If a serious error occurs.

Since:

5.2.1

createTable

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

Description copied from class: TableBeanAction

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.

Specified by:

createTable in class TableBeanAction

Throws:

TVCException

createTableFactory

protected TableFactory createTableFactory(javax.servlet.http.HttpServletRequest request)
                                   throws TVCException

Parameters:

request -

Returns:

The TableFactory.

Throws:

TVCException

Since:

2011.2.0

createTableInstance

protected TableBean<?> createTableInstance(javax.servlet.http.HttpServletRequest request)
                                    throws java.lang.Throwable

This method is called first inside createTable(HttpServletRequest) to create the actual TableBean instance.

Parameters:

request - The request.

Returns:

Returns the TableBean that was created.

Throws:

java.lang.Throwable - If unable to create a TableBean.

Since:

6.1.5

createTableLinkFactory

protected com.technia.tvc.structurebrowser.util.TableLinkFactory createTableLinkFactory(javax.servlet.http.HttpServletRequest request)
                                                                                 throws TVCException

Returns the TableLinkFactory that has been configured for the current table/request.

Parameters:

request - The current request.

Returns:

Returns the TableLinkFactory.

Throws:

TVCException - If a serious error occurs.

Since:

5.2.2

createTableRenderer

protected TableRenderer createTableRenderer(javax.servlet.http.HttpServletRequest request)
                                     throws TVCException

Returns the TableRenderer that has been configured for the current table/request.

Parameters:

request - The current request.

Returns:

Returns the TableRenderer.

Throws:

TVCException - If a serious error occurs.

Since:

6.1.0

createViewFactory

protected ViewFactory createViewFactory(javax.servlet.http.HttpServletRequest request)
                                 throws TVCException

Returns the ViewFactory that has been configured for the current table/request.

Parameters:

request - The current request.

Returns:

Returns the ViewFactory.

Throws:

TVCException - If a serious error occurs.

Since:

6.1.5

finishRequest

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

Overrides:

finishRequest in class TableBeanAction

Parameters:

table - The current table.

request - The current request.

Throws:

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

getAlwaysInstantiate

public abstract boolean getAlwaysInstantiate()

Returns whether to always instantiate a TableBean when this action executes. If not, any existing TableBean that was found will be reused.

Returns:

Returns whether to always instantiate.

getBeanClass

protected java.lang.Class<?> getBeanClass(javax.servlet.http.HttpServletRequest request)

Returns the TableBean class that should be instantiated.

Parameters:

request - The request.

Returns:

Returns the TableBean class that should be instantiated.

getBeanClassName

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

Returns the TableBean class name.

Parameters:

request - The current request being processed.

Returns:

Returns the TableBean class name.

getCopyEnv

protected boolean getCopyEnv(javax.servlet.http.HttpServletRequest request,
                             boolean defaultValue)

getDefaultBeanClassName

public abstract java.lang.String getDefaultBeanClassName()

Returns the default TableBean class name that should be used unless another class name was explicitly defined in the request.

Returns:

Returns the default TableBean class name.

getDefaultPageConfigName

protected java.lang.String getDefaultPageConfigName()

Returns the default name of the PageConfig. This name will be used unless a another name was explicitly configured.

Returns:

Returns the default name of the PageConfig.

Since:

6.1.5

getObjectNameFromRequest

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

Description copied from class: TableBeanAction

Returns the name of the TableBean.

Overrides:

getObjectNameFromRequest in class TableBeanAction

getPageConfig

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

Description copied from class: TableBeanAction

Returns the PageConfig that should be used.

Overrides:

getPageConfig in class TableBeanAction

Parameters:

request - The request.

response - The response.

Returns:

Returns the PageConfig that was loaded.

Throws:

TVCException - If loading the PageConfig failed.

getRequiredBeanClassName

public abstract java.lang.String getRequiredBeanClassName()

Returns the reqired TableBean class name. If a custom class name was explicitly defined in the request that class has to be assignable to the class returned by this method.

Returns:

Returns the required TableBean class name.

isBeanInstantiated

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

Returns true if a new TableBean was instantiated for this request.

Parameters:

request - The request.

Returns:

returns true if a new TableBean was instantiated.

setBeanInstantiated

protected void setBeanInstantiated(javax.servlet.http.HttpServletRequest request,
                                   boolean instantiated)

Sets whether a TableBean has been instantiated in this request.

Parameters:

request - The request.

instantiated - True if instantiated, false if not.

setSystemTableAndFilters

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

Overrides:

setSystemTableAndFilters in class TableBeanAction

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.

setView

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

Overrides:

setView in class TableBeanAction

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.

updateTable

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

Description copied from class: TableBeanAction

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.

Overrides:

updateTable in class TableBeanAction

Throws:

TVCException