com.client.core.base.dao.impl

Class StandardJpaDao<T extends JpaEntity<ID>,ID>

java.lang.Object

com.client.core.base.dao.impl.StandardJpaDao<T,ID>

Type Parameters:

T - Type of entity

ID - Type of primary key of entity

All Implemented Interfaces:

GenericDao<T,ID>

public class StandardJpaDao<T extends JpaEntity<ID>,ID>
extends java.lang.Object
implements GenericDao<T,ID>

Jpa implementation of GenericDao

Constructor Summary

Constructors

Constructor and Description
StandardJpaDao(java.lang.Class<T> type)

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 limit, java.lang.Integer start) 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

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardJpaDao

public StandardJpaDao(java.lang.Class<T> type)

Method Detail

add

public void add(T transientObject)

Adds an object of type T.

Specified by:

add in interface GenericDao<T extends JpaEntity<ID>,ID>

Parameters:

transientObject - The object to be added

merge

public T merge(T transientObject)

Adds or updates an object of type T

Specified by:

merge in interface GenericDao<T extends JpaEntity<ID>,ID>

Parameters:

transientObject - The object to be added/updated

Returns:

the object just added/updated

mergeAndReturnID

public ID mergeAndReturnID(T transientObject)

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

Specified by:

mergeAndReturnID in interface GenericDao<T extends JpaEntity<ID>,ID>

Parameters:

transientObject - The object to be added/updated

Returns:

the ID of the object just added/updated

find

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

Get a T record using it's id

Specified by:

find in interface GenericDao<T extends JpaEntity<ID>,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

public java.util.List<T> findAll()

Gets a List of all entities in table

Specified by:

findAll in interface GenericDao<T extends JpaEntity<ID>,ID>

Returns:

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

remove

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

Deletes entity T from table.

Specified by:

remove in interface GenericDao<T extends JpaEntity<ID>,ID>

Parameters:

persistentObject - Entity to delete

Throws:

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

query

public 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.

Specified by:

query in interface GenericDao<T extends JpaEntity<ID>,ID>

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

public 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.

Specified by:

query in interface GenericDao<T extends JpaEntity<ID>,ID>

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

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

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.

Specified by:

query in interface GenericDao<T extends JpaEntity<ID>,ID>

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 index of the record which we want to be the first returned based on the sort in the queryString

start - 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

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

Handles batch insert or batch update.

Specified by:

batchMerge in interface GenericDao<T extends JpaEntity<ID>,ID>

Parameters:

listToMerge - the list of elements to merge

setEntityManager

public void setEntityManager(javax.persistence.EntityManager entityManager)

Added for testing

Specified by:

setEntityManager in interface GenericDao<T extends JpaEntity<ID>,ID>

Parameters:

entityManager - the entityManager to set