AbstractDataTablesService

java.lang.Object
- com.client.core.datatables.service.AbstractDataTablesService<T,ID>

Type Parameters:

T - entity that will be handled by the datatables, represents one entity of any type, such as JPA MongoDB etc.

ID - the unique identifier of entity T

All Implemented Interfaces:

DataTablesService<T,ID>
```
public abstract class AbstractDataTablesService<T,ID>
extends java.lang.Object
implements DataTablesService<T,ID>
```
Extend this class to get data tables editable functionality for free. Contains generic logic to handle datatables retrieving of data, editing data, entity validation, sorting of rows, filtering of rows. If custom functionality needs to be added, DO NOT edit this class, instead overwrite the relevant methods in your concrete class.

Constructor Summary

Constructors
Constructor and Description
`AbstractDataTablesService(GenericDao<T,ID> genericDao, ApplicationSettings appSettings, org.springframework.validation.Validator validator, org.springframework.context.MessageSource messageSource, QueryHelper queryHelper)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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.
`Column`	`column(java.lang.String fieldName, java.lang.String fieldLabel, java.lang.Object value, java.lang.Object displayValue, FieldType fieldType, Entity entity, Editable editable, Visible visible, Sortable sortable, Searchable searchable, Required required, ShowOnForm showOnForm, java.lang.String url)` Maps a column in the data tables.
`Column`	`column(java.lang.String fieldName, java.lang.String fieldLabel, java.lang.Object value, java.lang.Object displayValue, FieldType fieldType, Entity entity, Editable editable, Visible visible, Sortable sortable, Searchable searchable, Required required, ShowOnForm showOnForm, java.lang.String url, java.lang.String width)` Maps a column in the data tables, with additional width parameter.
`protected org.json.JSONObject`	`constructJsonObjectResponseFromTableRows(java.util.List<T> filterRows, JQueryDataTableParamModel param)`
`abstract T`	`convertColumnsToEntity(ColumnConfiguration rowConfig, T oldEntity)` Takes a ColumnConfiguration and updates the passed in entity with the new values.
`abstract 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.
`protected java.util.List<T>`	`filterRows(java.util.List<T> allTableRows, JQueryDataTableParamModel param)` Filters the rows based on parameters in JQueryDataTableParamModel
`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.
`protected java.util.List<T>`	`handlePagination(java.util.List<T> filterRows, JQueryDataTableParamModel param)`
`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
`protected void`	`sortRows(java.util.List<T> filterRows, JQueryDataTableParamModel param)`
`<E extends java.lang.Comparable<?>> E`	`toType(java.lang.Class<E> type, java.lang.Object value)` Converts the object passed in back to its original type E by casting.
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractDataTablesService
```
public AbstractDataTablesService(GenericDao<T,ID> genericDao,
                                 ApplicationSettings appSettings,
                                 org.springframework.validation.Validator validator,
                                 org.springframework.context.MessageSource messageSource,
                                 QueryHelper queryHelper)
```
- Method Detail
  - convertEntityToColumns
```
public abstract ColumnConfiguration convertEntityToColumns(T entity)
```
    Description copied from interface: DataTablesService
    
    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
    
    Specified by:
    
    convertEntityToColumns in interface DataTablesService<T,ID>
    
    Returns:
    
    the ColumnConfiguration that the entity was mapped to
  - convertColumnsToEntity
```
public abstract T convertColumnsToEntity(ColumnConfiguration rowConfig,
                                         T oldEntity)
```
    Description copied from interface: DataTablesService
    
    Takes a ColumnConfiguration and updates the passed in entity with the new values. Columns in convertEntityToColumns and convertColumnsToEntity have to correspond.
    
    Specified by:
    
    convertColumnsToEntity in interface DataTablesService<T,ID>
    
    oldEntity - the entity that will be updated
    
    Returns:
    
    the T entity
  - additionalColumnConfiguration
```
public void additionalColumnConfiguration(ColumnConfiguration columnConfiguration,
                                          javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response,
                                          org.springframework.ui.Model model)
```
    Description copied from interface: DataTablesService
    
    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.
    
    Specified by:
    
    additionalColumnConfiguration in interface DataTablesService<T,ID>
    
    Parameters:
    
    columnConfiguration - The ColumnConfiguration from this.convertEntityToColumns
    
    request - the HttpServletRequest
    
    response - the HttpServletResponse
    
    model - the Model
  - processRequestForDataTables
```
public org.json.JSONObject processRequestForDataTables(javax.servlet.http.HttpServletRequest request)
```
    Description copied from interface: DataTablesService
    
    Entry point for getting, filtering, sorting, handle pagination and constructing JSONObject; the JSONObject is then written to the response.
    
    Specified by:
    
    processRequestForDataTables in interface DataTablesService<T,ID>
  - getData
```
public java.util.List<T> getData(java.util.List<T> tableRows,
                                 boolean useCache,
                                 javax.servlet.http.HttpServletRequest request)
```
    Description copied from interface: DataTablesService
    
    Retrieves the data. Gets a List of all entities in table
    
    Specified by:
    
    getData in interface DataTablesService<T,ID>
    
    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
```
@Transactional(timeout=60)
public java.util.List<T> findAll(java.util.List<T> tableRows,
                                                             boolean useCache)
```
    Description copied from interface: DataTablesService
    
    Retrieves all the data in the table. Gets a List of all entities in table
    
    Specified by:
    
    findAll in interface DataTablesService<T,ID>
    
    Parameters:
    
    tableRows - will be null if List is not in session
    
    useCache - If true data will be cached
    
    Returns:
    
    the List
  - add
```
@Transactional(timeout=60)
public T add(T transientObject)
```
    Description copied from interface: DataTablesService
    
    Adds an object of type T
    
    Specified by:
    
    add in interface DataTablesService<T,ID>
    
    Parameters:
    
    transientObject - The object to be added/updated
    
    Returns:
    
    the object just added/updated
  - addAndReturnID
```
@Transactional(timeout=60)
public ID addAndReturnID(T transientObject)
```
    Description copied from interface: DataTablesService
    
    Adds an object of type T
    
    Specified by:
    
    addAndReturnID in interface DataTablesService<T,ID>
    
    Parameters:
    
    transientObject - The object to be added/updated
    
    Returns:
    
    the ID of the object just added/updated
  - update
```
@Transactional(timeout=60)
public T update(T transientObject)
```
    Description copied from interface: DataTablesService
    
    Updates an object of type T
    
    Specified by:
    
    update in interface DataTablesService<T,ID>
    
    Parameters:
    
    transientObject - The object to be added/updated
    
    Returns:
    
    the object just added/updated
  - updateAndReturnID
```
@Transactional(timeout=60)
public ID updateAndReturnID(T transientObject)
```
    Description copied from interface: DataTablesService
    
    Updates an object of type T
    
    Specified by:
    
    updateAndReturnID in interface DataTablesService<T,ID>
    
    Parameters:
    
    transientObject - The object to be added/updated
    
    Returns:
    
    the ID of the object just added/updated
  - find
```
@Transactional(timeout=60)
public T find(ID id)
                                   throws javax.persistence.EntityNotFoundException
```
    Description copied from interface: DataTablesService
    
    Get a T record using it's id
    
    Specified by:
    
    find in interface DataTablesService<T,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
  - remove
```
@Transactional(timeout=60)
public void remove(T persistentObject)
                                        throws javax.persistence.EntityNotFoundException
```
    Description copied from interface: DataTablesService
    
    Deletes entity T from table.
    
    Specified by:
    
    remove in interface DataTablesService<T,ID>
    
    Throws:
    
    javax.persistence.EntityNotFoundException
  - removeUsingID
```
@Transactional(timeout=60)
public void removeUsingID(ID id)
                                               throws javax.persistence.EntityNotFoundException
```
    Description copied from interface: DataTablesService
    
    Deletes an entity using its primary key
    
    Specified by:
    
    removeUsingID in interface DataTablesService<T,ID>
    
    Parameters:
    
    id - unique identifier
    
    Throws:
    
    javax.persistence.EntityNotFoundException - if no enity exists with the specified unique identifier
  - query
```
@Transactional(timeout=120,
               readOnly=true)
public java.util.List<T> query(java.lang.String queryString,
                                                                                           java.util.Map<java.lang.String,java.lang.Object> queryParameters)
```
    Description copied from interface: DataTablesService
    
    Method for custom query.
    
    Specified by:
    
    query in interface DataTablesService<T,ID>
    
    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
  - editEntity
```
@Transactional(timeout=60)
public 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)
```
    Description copied from interface: DataTablesService
    
    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.
    
    Specified by:
    
    editEntity in interface DataTablesService<T,ID>
    
    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
    
    Returns:
    
    potential validation errors
  - handleEntityFormEdit
```
@Transactional(timeout=60)
public java.lang.String handleEntityFormEdit(T entity,
                                                                         ID entityID,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         javax.servlet.http.HttpServletResponse response)
```
    Description copied from interface: DataTablesService
    
    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.
    
    Specified by:
    
    handleEntityFormEdit in interface DataTablesService<T,ID>
    
    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
    
    Returns:
    
    The id of updated entity if success, if validations failed then validation messages, if error then error message.
  - adjustColumnPositionDueToInvisibleColumns
```
public java.lang.Integer adjustColumnPositionDueToInvisibleColumns(ColumnConfiguration columnConfiguration,
                                                                   java.lang.Integer columnPosition)
```
    Description copied from interface: DataTablesService
    
    Adjusts the column position to account for hidden column missmatch between datatables columns and datatables-editable columns.
    
    Specified by:
    
    adjustColumnPositionDueToInvisibleColumns in interface DataTablesService<T,ID>
    
    columnPosition - the current column to check
    
    Returns:
    
    the new columns position
  - validateEntity
```
public java.lang.String validateEntity(T entity)
```
    Description copied from interface: DataTablesService
    
    Validates an entity
    
    Specified by:
    
    validateEntity in interface DataTablesService<T,ID>
    
    Parameters:
    
    entity - the entity to validate
    
    Returns:
    
    A string containing each validation error separated by
    for displaying on the jsp
  - prepareValidationErrorMessage
```
public java.lang.String prepareValidationErrorMessage(org.springframework.validation.BindingResult bindingResult,
                                                      T entity)
```
    Description copied from interface: DataTablesService
    
    Prepares a validation error message using Spring's BindingResult from an entity validation.
    
    Specified by:
    
    prepareValidationErrorMessage in interface DataTablesService<T,ID>
    
    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
  - column
```
public Column column(java.lang.String fieldName,
                     java.lang.String fieldLabel,
                     java.lang.Object value,
                     java.lang.Object displayValue,
                     FieldType fieldType,
                     Entity entity,
                     Editable editable,
                     Visible visible,
                     Sortable sortable,
                     Searchable searchable,
                     Required required,
                     ShowOnForm showOnForm,
                     java.lang.String url)
```
    Maps a column in the data tables.
    
    Parameters:
    
    fieldName - Has to be exact match to field on entity
    
    fieldLabel - The column label used in the data tables
    
    value - The actual value as it's own type
    
    displayValue - The display value. This can be the same as value any text
    
    fieldType - Specifies what type of field, such as ID, DATE,BUTTON etc. See FieldType enum for full list.
    
    entity - Defines if the column is part of the JPA entity
    
    editable - Defines if the column can be edited
    
    visible - Defines if the column is visable
    
    sortable - Defines if the column can be sorted
    
    searchable - Defines if the column will be part of the search
    
    showOnForm - Defines if the column will show up on the add new entity form
    
    url - Defines the url of a link. If the FieldType is a select then this url will be the url that provide the data for the select.
    
    Returns:
    
    The StandardColumn
  - column
```
public Column column(java.lang.String fieldName,
                     java.lang.String fieldLabel,
                     java.lang.Object value,
                     java.lang.Object displayValue,
                     FieldType fieldType,
                     Entity entity,
                     Editable editable,
                     Visible visible,
                     Sortable sortable,
                     Searchable searchable,
                     Required required,
                     ShowOnForm showOnForm,
                     java.lang.String url,
                     java.lang.String width)
```
    Maps a column in the data tables, with additional width parameter.
    
    Parameters:
    
    fieldName - Has to be exact match to field on entity
    
    fieldLabel - The column label used in the data tables
    
    value - The actual value as it's own type
    
    displayValue - The display value. This can be the same as value any text
    
    fieldType - Specifies what type of field, such as ID, DATE,BUTTON etc. See FieldType enum for full list.
    
    entity - Defines if the column is part of the JPA entity
    
    editable - Defines if the column can be edited
    
    visible - Defines if the column is visable
    
    sortable - Defines if the column can be sorted
    
    searchable - Defines if the column will be part of the search
    
    showOnForm - Defines if the column will show up on the add new entity form
    
    url - Defines the url of a link. If the FieldType is a select then this url will be the url that provide the data for the select.
    
    width - Defining the width of the column, this parameter may take any CSS value (3em, 20px etc). DataTables applies 'smart' widths to columns which have not been given a specific width through this interface ensuring that the table remains readable.
    
    Returns:
    
    The StandardColumn
  - filterRows
```
protected java.util.List<T> filterRows(java.util.List<T> allTableRows,
                                       JQueryDataTableParamModel param)
```
    Filters the rows based on parameters in JQueryDataTableParamModel
    
    Parameters:
    
    allTableRows -
    
    param -
    
    Returns:
  - sortRows
```
protected void sortRows(java.util.List<T> filterRows,
                        JQueryDataTableParamModel param)
```
  - handlePagination
```
protected java.util.List<T> handlePagination(java.util.List<T> filterRows,
                                             JQueryDataTableParamModel param)
```
  - constructJsonObjectResponseFromTableRows
```
protected org.json.JSONObject constructJsonObjectResponseFromTableRows(java.util.List<T> filterRows,
                                                                       JQueryDataTableParamModel param)
                                                                throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - getGenericDao
```
public GenericDao<T,ID> getGenericDao()
```
    Specified by:
    
    getGenericDao in interface DataTablesService<T,ID>
  - getAppSettings
```
public ApplicationSettings getAppSettings()
```
    Specified by:
    
    getAppSettings in interface DataTablesService<T,ID>
  - getValidator
```
public org.springframework.validation.Validator getValidator()
```
    Specified by:
    
    getValidator in interface DataTablesService<T,ID>
  - getDtoFieldChangeFactory
```
public DtoFieldChangeFactory getDtoFieldChangeFactory()
```
    Specified by:
    
    getDtoFieldChangeFactory in interface DataTablesService<T,ID>
  - getLog
```
public org.apache.log4j.Logger getLog()
```
    Specified by:
    
    getLog in interface DataTablesService<T,ID>
  - toType
```
public <E extends java.lang.Comparable<?>> E toType(java.lang.Class<E> type,
                                                    java.lang.Object value)
```
    Converts the object passed in back to its original type E by casting. Special handling (such as for joda DateTime) takes place here.
    
    Parameters:
    
    type - the type Class to convert the object to
    
    value - the Object to covert
    
    Returns:
    
    the converted value as a type of E
  - getMessageUsingKey
```
public java.lang.String getMessageUsingKey(java.lang.String key)
```
    Description copied from interface: DataTablesService
    
    Gets a message from a resource bundle.
    
    Specified by:
    
    getMessageUsingKey in interface DataTablesService<T,ID>
    
    Parameters:
    
    key - The key of the message
    
    Returns:
    
    The message
  - getQueryUsingKey
```
public java.lang.String getQueryUsingKey(java.lang.String key)
```
    Description copied from interface: DataTablesService
    
    Get a query from the passed in QueryHelper
    
    Specified by:
    
    getQueryUsingKey in interface DataTablesService<T,ID>
    
    Returns:

Class AbstractDataTablesService<T,ID>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractDataTablesService

Method Detail

convertEntityToColumns

convertColumnsToEntity

additionalColumnConfiguration

processRequestForDataTables

getData

findAll

add

addAndReturnID

update

updateAndReturnID

find

remove

removeUsingID

query

editEntity

handleEntityFormEdit

adjustColumnPositionDueToInvisibleColumns

validateEntity

prepareValidationErrorMessage

column

column

filterRows

sortRows

handlePagination

constructJsonObjectResponseFromTableRows

getGenericDao

getAppSettings

getValidator

getDtoFieldChangeFactory

getLog

toType

getMessageUsingKey

getQueryUsingKey