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

Interface TableConfiguration<T,ID>

Type Parameters:

T - the entity, for example a JpaEntity

ID - the unique identifier of the entity, for the example the primary key of the JpaEntity

All Known Implementing Classes:

StandardTableConfiguration

public interface TableConfiguration<T,ID>

Contains the configuration for one DataTable

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.

Method Detail

getDataTablesService

DataTablesService<T,ID> getDataTablesService()

The DataTablesService that is used by the AbstractDataTablesController

Returns:

Returns the DataTablesService used for this DataTable

setDataTablesService

void setDataTablesService(DataTablesService<T,ID> dataTablesService)

Sets the DataTablesService used by the AbstractDataTablesController for this DataTable.

Parameters:

dataTablesService -

getTableName

java.lang.String getTableName()

Returns the id used for the table on the html page

Returns:

setTableName

void setTableName(java.lang.String tableName)

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.

getLog

org.apache.log4j.Logger getLog()

Returns:

the Logger for the implementation

setLog

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

Sets the Logger for the implementation

Parameters:

log -

getEntity

T getEntity()

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

Returns:

entity T

setEntity

void setEntity(T entity)

Set this entity to be used in the DataTables

Parameters:

entity -

getViewName

java.lang.String getViewName()

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

Returns:

the name of the view.

setViewName

void setViewName(java.lang.String viewName)

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.

Parameters:

viewName - the name of the view as a String

getCustomUrl

java.lang.String getCustomUrl()

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

Returns:

setCustomUrl

void setCustomUrl(java.lang.String customUrl)

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

Parameters:

customUrl -

getAppSettings

ApplicationSettings getAppSettings()

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

Returns:

setAppSettings

void setAppSettings(ApplicationSettings appSettings)

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

Parameters:

appSettings -

getRecordsCanBeAdded

boolean getRecordsCanBeAdded()

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

Returns:

setRecordsCanBeAdded

void setRecordsCanBeAdded(boolean recordsCanBeAdded)

Set to true if add entity functionality is needed.

Parameters:

recordsCanBeAdded -

getRecordsCanBeDeleted

boolean getRecordsCanBeDeleted()

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

Returns:

setRecordsCanBeDeleted

void setRecordsCanBeDeleted(boolean recordsCanBeDeleted)

Set to true if delete entity functionality is needed.

Parameters:

recordsCanBeDeleted -

getEntityName

java.lang.String getEntityName()

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

Returns:

setEntityName

void setEntityName(java.lang.String entityName)

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

Parameters:

entityName -

getDropDownFiller

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.

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

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

Sets the drop down values map

Parameters:

dropDownFiller -

getDropDownValuesFor

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.

Parameters:

key - the key used in the dropDownFiller map

Returns:

setDropDownValuesFor

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

Adds one record to the dropDownFiller map

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