com.client.core.datatables.controller

Class AbstractDataTablesController<T,ID>

java.lang.Object

com.client.core.datatables.controller.AbstractDataTablesController<T,ID>

Type Parameters:

T - entity that will be handled by the datatables, represent one JPA entity.

ID - the unique identifier of entity T

All Implemented Interfaces:

DataTablesController<T,ID>

public abstract class AbstractDataTablesController<T,ID>
extends java.lang.Object
implements DataTablesController<T,ID>

Generic controller for all datatables handling. This class should be extended by your specific type T. DO NOT edit this class, rather extend and override the methods you need to customize.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON

Constructor Summary

Constructors

Constructor and Description
AbstractDataTablesController()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addRecord(T entity, org.springframework.validation.BindingResult validationResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Validates an entity and if validation passes adds that record.
void	configureTable(TableConfiguration<T,ID> tableConfig) Takes a StandardTableConfiguration and uses is to configure the controller.
java.lang.String	dashboardData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Helper method to populate the transaction dashboard.
java.lang.String	deleteRecord(ID id) Deletes the record with unique identifier (such as primary key) id
java.lang.String	editEntityUsingForm(T entity, ID entityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Requests from the edit form will hit this method.
java.lang.String	editRecord(ID id, java.lang.Integer columnPosition, java.lang.String value, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Handles editing of records using the primary key, column position and new value for that column.
protected java.lang.String	formatValueForDisplay(ID id, java.lang.String value) Method for subclasses to implement if needed, to format the returned value.
ApplicationSettings	getAppSettings()
java.lang.String	getCustomUrl()
DataTablesService<T,ID>	getDataTablesService()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getDropDownFiller()
java.util.Map<java.lang.String,java.lang.String>	getDropDownValuesFor(java.lang.String key) Methods for handling drop down values
T	getEntity()
protected java.lang.String	getJsonFormattedDropDownValues(java.util.Map<java.lang.String,java.lang.String> values) Gets a value from the dropDownFiller map using the key passed in, the return will be used to populate the drop down menu when editing a value in the data tables that is of drop down type.
protected java.lang.String	getJsonFormattedDropDownValues(java.lang.String key)
org.apache.log4j.Logger	getLog()
TableConfiguration<T,ID>	getTableConfig()
java.lang.Class<T>	getType()
java.lang.String	getViewName()
java.lang.String	init(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Initializes the data table, this is the starting point when the page is hit.
void	initBinder(org.springframework.web.bind.WebDataBinder binder, java.util.Locale locale) Annotation that identifies methods which initialize the WebDataBinder which will be used for populating command and form object arguments of annotated handler methods.
void	initEntityValidatorBinder(org.springframework.web.bind.WebDataBinder binder, java.util.Locale locale) Register a validator for validation of entity using @Valid in the controller method
void	populateFormWithNewEntity(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model model) Adds a new instance of T to the model to be used when adding a new entity T
java.lang.String	prepareFormForEditEntity(ID entityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Validates an entity and if validation passes adds that record.
void	setDropDownFiller(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dropDownFiller)
void	setDropDownValuesFor(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> values) Adds one record to the dropDownFiller map
java.lang.String	updateRecord(T entity, org.springframework.validation.BindingResult validationResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Validates an entity and if validation passes adds that record.
protected void	validate(ID id, java.lang.Integer columnPosition, java.lang.String value) Method for adding any validations for specific or special fields.

Methods inherited from class java.lang.Object

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

Field Detail

JSON

public static final java.lang.String JSON

See Also:

Constant Field Values

Constructor Detail

AbstractDataTablesController

public AbstractDataTablesController()

Method Detail

configureTable

public void configureTable(TableConfiguration<T,ID> tableConfig)

Takes a StandardTableConfiguration and uses is to configure the controller.

Specified by:

configureTable in interface DataTablesController<T,ID>

Parameters:

tableConfig -

getDropDownValuesFor

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

Methods for handling drop down values

Parameters:

key -

Returns:

getTableConfig

public TableConfiguration<T,ID> getTableConfig()

getDropDownFiller

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

setDropDownFiller

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

setDropDownValuesFor

public 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

getJsonFormattedDropDownValues

protected java.lang.String getJsonFormattedDropDownValues(java.util.Map<java.lang.String,java.lang.String> values)

Gets a value from the dropDownFiller map using the key passed in, the return will be used to populate the drop down menu when editing a value in the data tables that is of drop down type.

Parameters:

key -

Returns:

getJsonFormattedDropDownValues

protected java.lang.String getJsonFormattedDropDownValues(java.lang.String key)

populateFormWithNewEntity

@ModelAttribute
public void populateFormWithNewEntity(javax.servlet.http.HttpServletRequest request,
                                                       org.springframework.ui.Model model)
                                                throws java.lang.InstantiationException,
                                                       java.lang.IllegalAccessException

Adds a new instance of T to the model to be used when adding a new entity T

Specified by:

populateFormWithNewEntity in interface DataTablesController<T,ID>

Parameters:

model -

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

init

@RequestMapping(value="/init",
                method=GET)
public java.lang.String init(javax.servlet.http.HttpServletRequest request,
                                                                                          javax.servlet.http.HttpServletResponse response,
                                                                                          org.springframework.ui.Model model)

Initializes the data table, this is the starting point when the page is hit. Note that the standard implementation of the datatables framwork only works with one table per page. If multiple tables need to be displayed on the same page the init method will need to be overriden in order to add unique module attributes. In addition the simpleDataTables.jsp will need to be copied for each table and the property place holders updated to match the new model attributes.

Specified by:

init in interface DataTablesController<T,ID>

Parameters:

model -

Returns:

the view

dashboardData

@RequestMapping(value="/data",
                method=POST,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String dashboardData(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                javax.servlet.http.HttpServletResponse response)

Helper method to populate the transaction dashboard. Called by the datatables in the dashboardMain.jsp

Specified by:

dashboardData in interface DataTablesController<T,ID>

Parameters:

request -

response -

Throws:

java.io.IOException

editRecord

@RequestMapping(value="/edit",
                method=POST,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String editRecord(@RequestParam(value="id")
                                                                                                                                                                             ID id,
                                                                                                                                                                             @RequestParam(value="columnPosition")
                                                                                                                                                                             java.lang.Integer columnPosition,
                                                                                                                                                                             @RequestParam(value="value")
                                                                                                                                                                             java.lang.String value,
                                                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                             javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                             org.springframework.ui.Model model)

Handles editing of records using the primary key, column position and new value for that column.

Specified by:

editRecord in interface DataTablesController<T,ID>

Parameters:

id - the primary key of the record

columnPosition - the column position in the table

value - the new value

Returns:

the new value if successful edit, otherwise an error message

prepareFormForEditEntity

@RequestMapping(value="/prepareformedit",
                method=GET,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String prepareFormForEditEntity(@RequestParam(value="entityID")
                                                                                                                                                                                                     ID entityID,
                                                                                                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                     javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                     org.springframework.ui.Model model)

Validates an entity and if validation passes adds that record.

Specified by:

prepareFormForEditEntity in interface DataTablesController<T,ID>

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

editEntityUsingForm

@RequestMapping(value="/postformedit",
                method=POST,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String editEntityUsingForm(@ModelAttribute
                                                                                                                                                                                              T entity,
                                                                                                                                                                                              @RequestParam(value="entityID")
                                                                                                                                                                                              ID entityID,
                                                                                                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                              javax.servlet.http.HttpServletResponse response)

Requests from the edit form will hit this method. Validates an entity and if validation passes adds that record.

Specified by:

editEntityUsingForm in interface DataTablesController<T,ID>

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

validate

protected void validate(ID id,
                        java.lang.Integer columnPosition,
                        java.lang.String value)
                 throws javax.validation.ValidationException

Method for adding any validations for specific or special fields. Any child class that needs to add special validations can override this method and add it's own implementation.

Throws:

javax.validation.ValidationException

formatValueForDisplay

protected java.lang.String formatValueForDisplay(ID id,
                                                 java.lang.String value)

Method for subclasses to implement if needed, to format the returned value.

Parameters:

id - the id of the entity that was edited

value - the new value

Returns:

the formatted value.

deleteRecord

@RequestMapping(value="/delete",
                method=POST,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String deleteRecord(@RequestParam(value="id")
                                                                                                                                                                                 ID id)

Deletes the record with unique identifier (such as primary key) id

Specified by:

deleteRecord in interface DataTablesController<T,ID>

Parameters:

id - the unique identifier of the record

Returns:

a blank String if success, otherwise an error message.

addRecord

@RequestMapping(value="/add",
                method=POST,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String addRecord(@ModelAttribute(value="newEntity")
                                                                                                                                                                           T entity,
                                                                                                                                                                           org.springframework.validation.BindingResult validationResult,
                                                                                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                           javax.servlet.http.HttpServletResponse response)

Validates an entity and if validation passes adds that record.

Specified by:

addRecord in interface DataTablesController<T,ID>

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

updateRecord

@RequestMapping(value="/update",
                method=POST,
                produces="application/json;charset=UTF-8")
 @ResponseBody
public java.lang.String updateRecord(@ModelAttribute(value="newEntity")
                                                                                                                                                                                 T entity,
                                                                                                                                                                                 org.springframework.validation.BindingResult validationResult,
                                                                                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                 javax.servlet.http.HttpServletResponse response)

Validates an entity and if validation passes adds that record.

Specified by:

updateRecord in interface DataTablesController<T,ID>

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

initBinder

@InitBinder
public void initBinder(org.springframework.web.bind.WebDataBinder binder,
                                    java.util.Locale locale)

Annotation that identifies methods which initialize the WebDataBinder which will be used for populating command and form object arguments of annotated handler methods. Registers custom editors Handles the date format from the form, using the application date format from application settings.

Parameters:

binder -

locale -

initEntityValidatorBinder

@InitBinder(value="newEntity")
public void initEntityValidatorBinder(org.springframework.web.bind.WebDataBinder binder,
                                                                      java.util.Locale locale)

Register a validator for validation of entity using @Valid in the controller method

Parameters:

binder -

locale -

getDataTablesService

public DataTablesService<T,ID> getDataTablesService()

Specified by:

getDataTablesService in interface DataTablesController<T,ID>

getLog

public org.apache.log4j.Logger getLog()

Specified by:

getLog in interface DataTablesController<T,ID>

getEntity

public T getEntity()

Specified by:

getEntity in interface DataTablesController<T,ID>

getViewName

public java.lang.String getViewName()

Specified by:

getViewName in interface DataTablesController<T,ID>

getCustomUrl

public java.lang.String getCustomUrl()

Specified by:

getCustomUrl in interface DataTablesController<T,ID>

getAppSettings

public ApplicationSettings getAppSettings()

Specified by:

getAppSettings in interface DataTablesController<T,ID>

getType

public java.lang.Class<T> getType()

Specified by:

getType in interface DataTablesController<T,ID>