com.client.core.datatables.service

Interface DataTablesService<T,ID>

Type Parameters:

T - The entity that backs each row in datatables

ID - The unique identifier of the entity T

All Known Implementing Classes:

AbstractDataTablesService

public interface DataTablesService<T,ID>

Method Summary

Modifier and Type	Method and Description
T	add(T transientObject) Adds an object of type T
ID	addAndReturnID(T transientObject) Adds an object of type T
void	additionalColumnConfiguration(ColumnConfiguration columnConfiguration, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Method to handle custom column configurations, such as adding field maps or hiding columns based on user type etc.
java.lang.Integer	adjustColumnPositionDueToInvisibleColumns(ColumnConfiguration columnConfiguration, java.lang.Integer columnPosition) Adjusts the column position to account for hidden column missmatch between datatables columns and datatables-editable columns.
T	convertColumnsToEntity(ColumnConfiguration rowConfig, T oldEntity) Takes a ColumnConfiguration and updates the passed in entity with the new values.
ColumnConfiguration	convertEntityToColumns(T entity) Takes a T entity and converts it to a ColumnConfiguration; a ColumnConfiguration contains a number of Columns.
java.lang.String	editEntity(ID id, java.lang.Integer columnPosition, java.lang.Object value, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Updates an existing entity of type T, using its primary key, the column position in the datatables of the field being updated and the updated value.
T	find(ID id) Get a T record using it's id
java.util.List<T>	findAll(java.util.List<T> tableRows, boolean useCache) Retrieves all the data in the table.
ApplicationSettings	getAppSettings()
java.util.List<T>	getData(java.util.List<T> tableRows, boolean useCache, javax.servlet.http.HttpServletRequest request) Retrieves the data.
DtoFieldChangeFactory	getDtoFieldChangeFactory()
GenericDao<T,ID>	getGenericDao()
org.apache.log4j.Logger	getLog()
java.lang.String	getMessageUsingKey(java.lang.String key) Gets a message from a resource bundle.
java.lang.String	getQueryUsingKey(java.lang.String key) Get a query from the passed in QueryHelper
org.springframework.validation.Validator	getValidator()
java.lang.String	handleEntityFormEdit(T entity, ID entityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles the edit of an entity using the form instead of inline editing.
java.lang.String	prepareValidationErrorMessage(org.springframework.validation.BindingResult bindingResult, T entity) Prepares a validation error message using Spring's BindingResult from an entity validation.
org.json.JSONObject	processRequestForDataTables(javax.servlet.http.HttpServletRequest request) Entry point for getting, filtering, sorting, handle pagination and constructing JSONObject; the JSONObject is then written to the response.
java.util.List<T>	query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters) Method for custom query.
void	remove(T persistentObject) Deletes entity T from table.
void	removeUsingID(ID id) Deletes an entity using its primary key
T	update(T transientObject) Updates an object of type T
ID	updateAndReturnID(T transientObject) Updates an object of type T
java.lang.String	validateEntity(T entity) Validates an entity

Method Detail

convertEntityToColumns

ColumnConfiguration convertEntityToColumns(T entity)

Takes a T entity and converts it to a ColumnConfiguration; a ColumnConfiguration contains a number of Columns. All columns do not have to be represented by values in the entity, for example a column with a button for custom logic. Example implementation: See com.client.core.service.datatables.example.ExampleDataTablesService

Parameters:

entity -

Returns:

the ColumnConfiguration that the entity was mapped to

convertColumnsToEntity

T convertColumnsToEntity(ColumnConfiguration rowConfig,
                         T oldEntity)

Takes a ColumnConfiguration and updates the passed in entity with the new values. Columns in convertEntityToColumns and convertColumnsToEntity have to correspond.

Parameters:

rowConfig -

oldEntity - the entity that will be updated

Returns:

the T entity

processRequestForDataTables

org.json.JSONObject processRequestForDataTables(javax.servlet.http.HttpServletRequest request)

Entry point for getting, filtering, sorting, handle pagination and constructing JSONObject; the JSONObject is then written to the response.

Parameters:

request -

response -

Throws:

java.io.IOException

getData

java.util.List<T> getData(java.util.List<T> tableRows,
                          boolean useCache,
                          javax.servlet.http.HttpServletRequest request)

Retrieves the data. Gets a List of all entities in table

Parameters:

tableRows - will be null if List is not in session

useCache - If true data will be cached

request - the HttpServletRequest containing all the information from the request. This can be used when overriding this method to retrieve query params etc.

Returns:

the List

findAll

java.util.List<T> findAll(java.util.List<T> tableRows,
                          boolean useCache)

Retrieves all the data in the table. Gets a List of all entities in table

Parameters:

tableRows - will be null if List is not in session

useCache - If true data will be cached

Returns:

the List

update

T update(T transientObject)

Updates an object of type T

Parameters:

transientObject - The object to be added/updated

Returns:

the object just added/updated

updateAndReturnID

ID updateAndReturnID(T transientObject)

Updates an object of type T

Parameters:

transientObject - The object to be added/updated

Returns:

the ID of the object just added/updated

add

T add(T transientObject)

Adds an object of type T

Parameters:

transientObject - The object to be added/updated

Returns:

the object just added/updated

addAndReturnID

ID addAndReturnID(T transientObject)

Adds an object of type T

Parameters:

transientObject - The object to be added/updated

Returns:

the ID of the object just added/updated

find

T find(ID id)
throws javax.persistence.EntityNotFoundException

Get a T record using it's id

Parameters:

id - The unique identifier of the entity T (in most cases the primary key of the entity)

Returns:

the entity of type T

Throws:

javax.persistence.EntityNotFoundException - when no entity with (primary key) ID exists

query

java.util.List<T> query(java.lang.String queryString,
                        java.util.Map<java.lang.String,java.lang.Object> queryParameters)

Method for custom query.

Parameters:

queryString - the query String with named parameters: Select a FROM TableName a WHERE a.field = :namedParam

queryParameters - the named parameters corresponding to the :namedParam in the queryString. The key of the map need correspond to namedParam while the value is the actual value used in the query.

Returns:

a List of possible value, and empty List if no values found

remove

void remove(T persistentObject)
     throws javax.persistence.EntityNotFoundException

Deletes entity T from table.

Parameters:

T - Entity to delete

Throws:

java.lang.IllegalArgumentException - if the instance is not an entity or is a detached entity

javax.persistence.EntityNotFoundException

editEntity

java.lang.String editEntity(ID id,
                            java.lang.Integer columnPosition,
                            java.lang.Object value,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            org.springframework.ui.Model model)

Updates an existing entity of type T, using its primary key, the column position in the datatables of the field being updated and the updated value. Also validates the entity and returns potential validation errors.

Parameters:

id - the unique identifier of the entity T

columnPosition - the column position in the datatables that matches the field being updated

value - the new value of the field * @param request

response -

model -

Returns:

potential validation errors

handleEntityFormEdit

java.lang.String handleEntityFormEdit(T entity,
                                      ID entityID,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

This method handles the edit of an entity using the form instead of inline editing. Implementations will need to make sure that only the form values are updated on the saved entity. This is done by fetching the persisted entity and updating the fields on the form. This is useful for bullhorn entities exposed in the datatables where all fields on the entity will not be present on the form.

Parameters:

entity - used when all fields on the entity are present on the form

entityID - the id of the entity to update

request - the request containing all parameters

response -

Returns:

The id of updated entity if success, if validations failed then validation messages, if error then error message.

removeUsingID

void removeUsingID(ID id)
            throws javax.persistence.EntityNotFoundException

Deletes an entity using its primary key

Parameters:

id - unique identifier

Throws:

javax.persistence.EntityNotFoundException - if no enity exists with the specified unique identifier

validateEntity

java.lang.String validateEntity(T entity)

Validates an entity

Parameters:

entity - the entity to validate

Returns:

A string containing each validation error separated by
for displaying on the jsp

prepareValidationErrorMessage

java.lang.String prepareValidationErrorMessage(org.springframework.validation.BindingResult bindingResult,
                                               T entity)

Prepares a validation error message using Spring's BindingResult from an entity validation.

Parameters:

bindingResult - the validation result from an entity

entity - the entity that was just validated, used to find the labels of particular fields to create prettier error messages.

Returns:

A string containing each validation error separated by
for displaying on the jsp

adjustColumnPositionDueToInvisibleColumns

java.lang.Integer adjustColumnPositionDueToInvisibleColumns(ColumnConfiguration columnConfiguration,
                                                            java.lang.Integer columnPosition)

Adjusts the column position to account for hidden column missmatch between datatables columns and datatables-editable columns.

Parameters:

columnConfiguration -

columnPosition - the current column to check

Returns:

the new columns position

additionalColumnConfiguration

void additionalColumnConfiguration(ColumnConfiguration columnConfiguration,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   org.springframework.ui.Model model)

Method to handle custom column configurations, such as adding field maps or hiding columns based on user type etc. Modify the passed in ColumnConfiguration in order to change the column configuration. This method will only be called once on table load.

Parameters:

columnConfiguration - The ColumnConfiguration from this.convertEntityToColumns

request - the HttpServletRequest

response - the HttpServletResponse

model - the Model

getGenericDao

GenericDao<T,ID> getGenericDao()

getAppSettings

ApplicationSettings getAppSettings()

getValidator

org.springframework.validation.Validator getValidator()

getDtoFieldChangeFactory

DtoFieldChangeFactory getDtoFieldChangeFactory()

getLog

org.apache.log4j.Logger getLog()

getMessageUsingKey

java.lang.String getMessageUsingKey(java.lang.String key)

Gets a message from a resource bundle.

Parameters:

key - The key of the message

Returns:

The message

getQueryUsingKey

java.lang.String getQueryUsingKey(java.lang.String key)

Get a query from the passed in QueryHelper

Parameters:

key -

Returns: