com.client.core.base.dao

Interface GenericDao<T,ID>

Type Parameters:

T - the entity type

ID - the primary key of entity

All Known Implementing Classes:

BullhornDao, StandardJpaDao

public interface GenericDao<T,ID>

Generic data-access-object. Provides database access for a given entity type, represented by a domain class, typically a POJO

Method Summary

Modifier and Type	Method and Description
void	add(T transientObject) Adds an object of type T.
void	batchMerge(java.util.List<T> listToMerge) Handles batch insert or batch update.
T	find(ID id) Get a T record using it's id
java.util.List<T>	findAll() Gets a List of all entities in table
T	merge(T transientObject) Adds or updates an object of type T
ID	mergeAndReturnID(T transientObject) Adds or updates an object of type T and returns the ID
java.util.List<T>	query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters) Query using the passed in query, with named parameters contained in the queryParameters.
java.util.List<T>	query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters, java.lang.Integer limit) Query using the passed in query, with named parameters contained in the queryParameters.
java.util.List<T>	query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters, java.lang.Integer start, java.lang.Integer limit) Query using the passed in query, with named parameters contained in the queryParameters.
void	remove(T persistentObject) Deletes entity T from table.
void	setEntityManager(javax.persistence.EntityManager entityManager) Added for testing

Method Detail

add

void add(T transientObject)

Adds an object of type T.

Parameters:

transientObject - The object to be added

merge

T merge(T transientObject)

Adds or updates an object of type T

Parameters:

transientObject - The object to be added/updated

Returns:

the object just added/updated

mergeAndReturnID

ID mergeAndReturnID(T transientObject)

Adds or updates an object of type T and returns the ID

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 primary key of the entity

Returns:

the entity of type T

Throws:

javax.persistence.EntityNotFoundException - when no entity with unique identifier ID exists

findAll

java.util.List<T> findAll()

Gets a List of all entities in table

Returns:

a List. If no entities exists an empty List will be returned.

remove

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

Deletes entity T from table.

Parameters:

persistentObject - Entity to delete

Throws:

javax.persistence.EntityNotFoundException - if the instance is not an entity or is a detached entity

query

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

Query using the passed in query, with named parameters contained in the queryParameters. If no queryParams needed pass in null for queryParams and have no named parameters in the query.

Example: queryString = "SELECT * FROM Person p WHERE p.name = :name"; queryParam = Map containing "name":"Mr Toad"

Do not concatenate the queryString with parameters before passing it in to this method! We should be using named parameters via the queryParamters to avoid SQL-injection attacks.

Parameters:

queryString - The query to execute, with named parameters if needed

queryParameters - The parameters that will be used for the query. If null then query executes without params.

Returns:

a List of entities matching the passed in query

query

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

Query using the passed in query, with named parameters contained in the queryParameters. If no queryParams needed pass in null for queryParams and have no named parameters in the query. Example: queryString = "SELECT * FROM Person p WHERE p.name = :name"; queryParam = Map containing "name":"Mr Toad"

Do not concatenate the queryString with parameters before passing it in to this method! We should be using named parameters via the queryParamters to avoid SQL-injection attacks.

Parameters:

queryString - The query to execute, with named parameters if needed

queryParameters - The parameters that will be used for the query. If null then query executes without params.

limit - the maximum number of elements to return

Returns:

a List of entities matching the passed in query, with maximum size equal to the passed in limit

query

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

Query using the passed in query, with named parameters contained in the queryParameters. If no queryParams needed pass in null for queryParams and have no named parameters in the query. Example: queryString = "SELECT * FROM Person p WHERE p.name = :name"; queryParam = Map containing "name":"Mr Toad"

Do not concatenate the queryString with parameters before passing it in to this method! We should be using named parameters via the queryParamters to avoid SQL-injection attacks.

Parameters:

queryString - The query to execute, with named parameters if needed

queryParameters - The parameters that will be used for the query. If null then query executes without params.

start - the index of the record which we want to be the first returned based on the sort in the queryString

limit - the maximum number of elements to return

Returns:

a List of entities matching the passed in query, with maximum size equal to the passed in limit. The first element will be the [start]th element in the overall result set

batchMerge

void batchMerge(java.util.List<T> listToMerge)

Handles batch insert or batch update.

Parameters:

listToMerge - the list of elements to merge

setEntityManager

void setEntityManager(javax.persistence.EntityManager entityManager)

Added for testing

Parameters:

entityManager - the entityManager to set