com.client.core.datatables.model.configuration.table.impl

Class StandardTableConfiguration<T,ID>

java.lang.Object

com.client.core.datatables.model.configuration.table.impl.StandardTableConfiguration<T,ID>

Type Parameters:

T -

ID -

All Implemented Interfaces:

TableConfiguration<T,ID>

public class StandardTableConfiguration<T,ID>
extends java.lang.Object
implements TableConfiguration<T,ID>

Contains the configuration for one AbstractDataTablesController

Constructor Summary

Constructors

Constructor and Description
StandardTableConfiguration()

Method Summary

Modifier and Type	Method and Description
ApplicationSettings	getAppSettings() The ApplicationSettings used to provide date format among possible other things.
java.lang.String	getCustomUrl() Has to match the @RequestMapping on the controller extending AbstractDataTablesController.
DataTablesService<T,ID>	getDataTablesService() The DataTablesService that is used by the AbstractDataTablesController
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getDropDownFiller() Returns a map of all values used to populate drop down menus on view.
java.util.Map<java.lang.String,java.lang.String>	getDropDownValuesFor(java.lang.String key) Methods for handling drop down values, will return one of the maps from the dropDownFiller based on the name.
T	getEntity() Gets an instance of T.
java.lang.String	getEntityName() The pretty entity name, that will be used on the view
org.apache.log4j.Logger	getLog()
boolean	getRecordsCanBeAdded() Can records be added.
boolean	getRecordsCanBeDeleted() Can records be deleted.
java.lang.String	getTableName() Returns the id used for the table on the html page
java.lang.String	getViewName() The view name, most likely a jsp page that will be used for this DataTable.
void	setAppSettings(ApplicationSettings appSettings) Sets the ApplicationSettings used to provide date format among possible other things.
void	setCustomUrl(java.lang.String customUrl) Has to match the @RequestMapping on the controller extending AbstractDataTablesController.
void	setDataTablesService(DataTablesService<T,ID> dataTablesService) Sets the DataTablesService used by the AbstractDataTablesController for this DataTable.
void	setDropDownFiller(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dropDownFiller) Sets the drop down values map
void	setDropDownValuesFor(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> values) Adds one record to the dropDownFiller map
void	setEntity(T entity) Set this entity to be used in the DataTables
void	setEntityName(java.lang.String entityName) Set the entity name to use on the add form on the view.
void	setLog(org.apache.log4j.Logger log) Sets the Logger for the implementation
void	setRecordsCanBeAdded(boolean recordsCanBeAdded) Set to true if add entity functionality is needed.
void	setRecordsCanBeDeleted(boolean recordsCanBeDeleted) Set to true if delete entity functionality is needed.
void	setTableName(java.lang.String tableName) Sets the id used for the table on the html page, defaults to DefaultValues.DEFAULTDATATABLESNAME.
void	setViewName(java.lang.String viewName) The view name, most likely a jsp page that will be used for this DataTable.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardTableConfiguration

public StandardTableConfiguration()

Method Detail

getDataTablesService

public DataTablesService<T,ID> getDataTablesService()

Description copied from interface: TableConfiguration

The DataTablesService that is used by the AbstractDataTablesController

Specified by:

getDataTablesService in interface TableConfiguration<T,ID>

Returns:

Returns the DataTablesService used for this DataTable

setDataTablesService

public void setDataTablesService(DataTablesService<T,ID> dataTablesService)

Description copied from interface: TableConfiguration

Sets the DataTablesService used by the AbstractDataTablesController for this DataTable.

Specified by:

setDataTablesService in interface TableConfiguration<T,ID>

getTableName

public java.lang.String getTableName()

Description copied from interface: TableConfiguration

Returns the id used for the table on the html page

Specified by:

getTableName in interface TableConfiguration<T,ID>

Returns:

setTableName

public void setTableName(java.lang.String tableName)

Description copied from interface: TableConfiguration

Sets the id used for the table on the html page, defaults to DefaultValues.DEFAULTDATATABLESNAME. If multiple tables are used on the same page this needs to be a unique value so that the html id for the table is unique. If multiple tables exist on the same page the simpleDataTables.jsp will need to be copied and the expression on the JSP page will need to be updated.

Specified by:

setTableName in interface TableConfiguration<T,ID>

getLog

public org.apache.log4j.Logger getLog()

Specified by:

getLog in interface TableConfiguration<T,ID>

Returns:

the Logger for the implementation

setLog

public void setLog(org.apache.log4j.Logger log)

Description copied from interface: TableConfiguration

Sets the Logger for the implementation

Specified by:

setLog in interface TableConfiguration<T,ID>

getEntity

public T getEntity()

Description copied from interface: TableConfiguration

Gets an instance of T. This instance should have been set using the default constructor with all fields on the entity T blank.

Specified by:

getEntity in interface TableConfiguration<T,ID>

Returns:

entity T

setEntity

public void setEntity(T entity)

Description copied from interface: TableConfiguration

Set this entity to be used in the DataTables

Specified by:

setEntity in interface TableConfiguration<T,ID>

getViewName

public java.lang.String getViewName()

Description copied from interface: TableConfiguration

The view name, most likely a jsp page that will be used for this DataTable.

Specified by:

getViewName in interface TableConfiguration<T,ID>

Returns:

the name of the view.

setViewName

public void setViewName(java.lang.String viewName)

Description copied from interface: TableConfiguration

The view name, most likely a jsp page that will be used for this DataTable. Will be used by the AbstractDataTablesController to determine the view.

Specified by:

setViewName in interface TableConfiguration<T,ID>

Parameters:

viewName - the name of the view as a String

getCustomUrl

public java.lang.String getCustomUrl()

Description copied from interface: TableConfiguration

Has to match the @RequestMapping on the controller extending AbstractDataTablesController.

Specified by:

getCustomUrl in interface TableConfiguration<T,ID>

Returns:

setCustomUrl

public void setCustomUrl(java.lang.String customUrl)

Description copied from interface: TableConfiguration

Has to match the @RequestMapping on the controller extending AbstractDataTablesController. This will be the url where the DataTable is access: http://localhost:8080/{customUrl}/init. The customUrl is used on the viewName.jsp to set the urls for the datatables and datatables-editable setup. See WEB-INF/jsp/dataTables/simpleDataTables.jsp

Specified by:

setCustomUrl in interface TableConfiguration<T,ID>

getAppSettings

public ApplicationSettings getAppSettings()

Description copied from interface: TableConfiguration

The ApplicationSettings used to provide date format among possible other things.

Specified by:

getAppSettings in interface TableConfiguration<T,ID>

Returns:

setAppSettings

public void setAppSettings(ApplicationSettings appSettings)

Description copied from interface: TableConfiguration

Sets the ApplicationSettings used to provide date format among possible other things.

Specified by:

setAppSettings in interface TableConfiguration<T,ID>

getRecordsCanBeAdded

public boolean getRecordsCanBeAdded()

Description copied from interface: TableConfiguration

Can records be added. If true then the "Add" button will be added to view

Specified by:

getRecordsCanBeAdded in interface TableConfiguration<T,ID>

Returns:

setRecordsCanBeAdded

public void setRecordsCanBeAdded(boolean recordsCanBeAdded)

Description copied from interface: TableConfiguration

Set to true if add entity functionality is needed.

Specified by:

setRecordsCanBeAdded in interface TableConfiguration<T,ID>

getRecordsCanBeDeleted

public boolean getRecordsCanBeDeleted()

Description copied from interface: TableConfiguration

Can records be deleted. If true then the "Delete" button will be added to view

Specified by:

getRecordsCanBeDeleted in interface TableConfiguration<T,ID>

Returns:

setRecordsCanBeDeleted

public void setRecordsCanBeDeleted(boolean recordsCanBeDeleted)

Description copied from interface: TableConfiguration

Set to true if delete entity functionality is needed.

Specified by:

setRecordsCanBeDeleted in interface TableConfiguration<T,ID>

getEntityName

public java.lang.String getEntityName()

Description copied from interface: TableConfiguration

The pretty entity name, that will be used on the view

Specified by:

getEntityName in interface TableConfiguration<T,ID>

Returns:

setEntityName

public void setEntityName(java.lang.String entityName)

Description copied from interface: TableConfiguration

Set the entity name to use on the add form on the view.

Specified by:

setEntityName in interface TableConfiguration<T,ID>

getDropDownFiller

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getDropDownFiller()

Description copied from interface: TableConfiguration

Returns a map of all values used to populate drop down menus on view.

Specified by:

getDropDownFiller in interface TableConfiguration<T,ID>

Returns:

a map containing the name of the drop down menu field as key and a map containing all the values for a drop down menu as the value.

setDropDownFiller

public void setDropDownFiller(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dropDownFiller)

Description copied from interface: TableConfiguration

Sets the drop down values map

Specified by:

setDropDownFiller in interface TableConfiguration<T,ID>

getDropDownValuesFor

public java.util.Map<java.lang.String,java.lang.String> getDropDownValuesFor(java.lang.String key)

Description copied from interface: TableConfiguration

Methods for handling drop down values, will return one of the maps from the dropDownFiller based on the name.

Specified by:

getDropDownValuesFor in interface TableConfiguration<T,ID>

Parameters:

key - the key used in the dropDownFiller map

Returns:

setDropDownValuesFor

public void setDropDownValuesFor(java.lang.String key,
                                 java.util.Map<java.lang.String,java.lang.String> values)

Description copied from interface: TableConfiguration

Adds one record to the dropDownFiller map

Specified by:

setDropDownValuesFor in interface TableConfiguration<T,ID>

Parameters:

key - of the record to add to the dropDownFiller

values - a map containing "id":"value" to display in a drop down menu on the jsp page