org.debux.webmotion.jpa

Class GenericDAO

java.lang.Object

org.debux.webmotion.jpa.GenericDAO

public class GenericDAO
extends Object

The class is a generic DAO. It is used to CRUD operations on specific class. The DAO use JPA specification. In oder to create a generic DAO on entity, you must extends @see IdentifiableEntity.

Author:

julien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericDAO.Parameters Helper to create dynamic parameter for the GenericDAO.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.beanutils.BeanUtilsBean	beanUtil Utility on bean
protected org.apache.commons.beanutils.ConvertUtilsBean	convertUtils Utility to convert value
protected Class<? extends IdentifiableEntity>	entityClass Current entity class do crud
protected javax.persistence.EntityManager	manager Current entity manager
protected org.apache.commons.beanutils.PropertyUtilsBean	propertyUtils Utility on property

Constructor Summary

Constructors

Constructor and Description
GenericDAO(javax.persistence.EntityManager manager, Class<? extends IdentifiableEntity> entityClass) Constructor with direct entity class.
GenericDAO(javax.persistence.EntityManager manager, String entityName) Constructor with entity class as string.

Method Summary

Methods

Modifier and Type	Method and Description
IdentifiableEntity	create(GenericDAO.Parameters parameters) Create an entity with parameters.
boolean	delete(String id) Delete an entity, that is identified by this id.
int	exec(String name, GenericDAO.Parameters parameters) Execute a query named as write in entity.
protected IdentifiableEntity	extract(GenericDAO.Parameters parameters) Create a new entity with parameters.
protected IdentifiableEntity	extract(IdentifiableEntity entity, GenericDAO.Parameters parameters) Complete entity with parameters.
protected void	extract(javax.persistence.Query query, GenericDAO.Parameters parameters) Set parameter in the query.
IdentifiableEntity	find(String id) Find entity by the id.
List	query(String name, GenericDAO.Parameters parameters) Execute a query named as read in entity.
IdentifiableEntity	update(String id, GenericDAO.Parameters parameters) Update an entity with parameters, that is identified by this id.

Methods inherited from class java.lang.Object

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

Field Detail

beanUtil

protected org.apache.commons.beanutils.BeanUtilsBean beanUtil

Utility on bean

convertUtils

protected org.apache.commons.beanutils.ConvertUtilsBean convertUtils

Utility to convert value

propertyUtils

protected org.apache.commons.beanutils.PropertyUtilsBean propertyUtils

Utility on property

manager

protected javax.persistence.EntityManager manager

Current entity manager

entityClass

protected Class<? extends IdentifiableEntity> entityClass

Current entity class do crud

Constructor Detail

GenericDAO

public GenericDAO(javax.persistence.EntityManager manager,
          Class<? extends IdentifiableEntity> entityClass)

Constructor with direct entity class.

Parameters:

manager - entity manager

entityClass - entity class

GenericDAO

public GenericDAO(javax.persistence.EntityManager manager,
          String entityName)

Constructor with entity class as string.

Parameters:

manager - entity manager

entityName - entity class as string

Method Detail

create

public IdentifiableEntity create(GenericDAO.Parameters parameters)

Create an entity with parameters.

Parameters:

parameters - parameters

Returns:

entity created.

update

public IdentifiableEntity update(String id,
                        GenericDAO.Parameters parameters)

Update an entity with parameters, that is identified by this id.

Parameters:

id - identifier

parameters - parameters

Returns:

entity updated

delete

public boolean delete(String id)

Delete an entity, that is identified by this id.

Parameters:

id - identifier

Returns:

true if is deleted else false if the entity was not found.

find

public IdentifiableEntity find(String id)

Find entity by the id.

Parameters:

id - identifier

Returns:

query

public List query(String name,
         GenericDAO.Parameters parameters)

Execute a query named as read in entity.

Parameters:

name - query name

parameters - parameters

Returns:

outturn

exec

public int exec(String name,
       GenericDAO.Parameters parameters)

Execute a query named as write in entity.

Parameters:

name - query name

parameters - parameters

Returns:

the number of entities updated or deleted

extract

protected void extract(javax.persistence.Query query,
           GenericDAO.Parameters parameters)

Set parameter in the query.

Parameters:

query - query

parameters - parameters

extract

protected IdentifiableEntity extract(GenericDAO.Parameters parameters)

Create a new entity with parameters.

Parameters:

parameters - parameters

Returns:

entity with parameters

extract

protected IdentifiableEntity extract(IdentifiableEntity entity,
                         GenericDAO.Parameters parameters)

Complete entity with parameters. Try to convert parameter, if the type not match. To create an association on entity, you must pass only identifier.

Parameters:

entity - entity

parameters - parameters

Returns:

entity completed