GenericDao (Eureka Common 2.0-Alpha-24 API)

java.lang.Object
- edu.emory.cci.aiw.cvrg.eureka.common.dao.GenericDao<T,PK>

Type Parameters:

T - The type of the entity.

PK - The type of the unique identifier for the entity.

All Implemented Interfaces:

Dao<T,PK>
```
public class GenericDao<T,PK>
extends Object
implements Dao<T,PK>
```
Implements the Dao interface in a generic way.

Author:

hrathod

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`GenericDao.QueryPathProvider<E,P>` Provides an interface for the subclasses to easily perform queries without having to deal with a lot of boiler-plate code.
`static class`	`GenericDao.SqlComparator`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GenericDao(Class<T> inEntityClass, com.google.inject.Provider<javax.persistence.EntityManager> inManagerProvider)` Creates a generic DAO that handles the given type of entity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`create(T entity)` Creates (persists) the given entity in the data store.
`List<T>`	`getAll()` Retrieves a list of all the entities of the given type in the data store.
`protected javax.persistence.EntityManager`	`getEntityManager()` Returns an entity manager instance that can be used to interact with the data source.
`protected List<T>`	`getListAsc(javax.persistence.metamodel.SingularAttribute<T,?> attribute)`
`protected <Y> List<T>`	`getListByAttribute(GenericDao.QueryPathProvider<T,Y> provider, Y value)` Get a list of entities whose path value is the same as the given target value.
`protected <Y extends Number> List<T>`	`getListByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute, GenericDao.SqlComparator comparator, Y value)`
`protected <Y> List<T>`	`getListByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute, Y value)`
`protected <Y> T`	`getUniqueByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute, Y value)` Provides a convenient way for subclasses to implement simple queries that compare an attribute of the entity to a target value.
`T`	`refresh(T entity)` Refreshes the given entity instance with latest information from the data store.
`T`	`remove(T entity)` Removes the given entity from the data store.
`T`	`retrieve(PK uniqueId)` Retrieves the entity referred to by the unique identifier from the data store.
`T`	`update(T entity)` Updates the data store using the given entity.

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

- Constructor Detail
  - GenericDao
```
protected GenericDao(Class<T> inEntityClass,
                     com.google.inject.Provider<javax.persistence.EntityManager> inManagerProvider)
```
    Creates a generic DAO that handles the given type of entity. The entity manager provider is used to fetch entity managers to interact with the data store.
    
    Parameters:
    
    inEntityClass - The type of entities to handle.
    
    inManagerProvider - Provides entity managers on demand.
- Method Detail
  - create
```
public T create(T entity)
```
    Description copied from interface: Dao
    
    Creates (persists) the given entity in the data store.
    
    Specified by:
    
    create in interface Dao<T,PK>
    
    Parameters:
    
    entity - The entity to create (persist).
    
    Returns:
    
    The persisted entity. Useful for chained method calls, if needed.
  - retrieve
```
public T retrieve(PK uniqueId)
```
    Description copied from interface: Dao
    
    Retrieves the entity referred to by the unique identifier from the data store.
    
    Specified by:
    
    retrieve in interface Dao<T,PK>
    
    Parameters:
    
    uniqueId - The unique identifier for the entity to retrieve.
    
    Returns:
    
    The retrieved entity, or null if it can not be found.
  - update
```
public T update(T entity)
```
    Description copied from interface: Dao
    
    Updates the data store using the given entity.
    
    Specified by:
    
    update in interface Dao<T,PK>
    
    Parameters:
    
    entity - The entity to use for updates to the data store.
    
    Returns:
    
    The given entity. Useful for chained method calls, if needed.
  - remove
```
public T remove(T entity)
```
    Description copied from interface: Dao
    
    Removes the given entity from the data store.
    
    Specified by:
    
    remove in interface Dao<T,PK>
    
    Parameters:
    
    entity - The entity to remove from the data store.
    
    Returns:
    
    The removed entity.
  - refresh
```
public T refresh(T entity)
```
    Description copied from interface: Dao
    
    Refreshes the given entity instance with latest information from the data store.
    
    Specified by:
    
    refresh in interface Dao<T,PK>
    
    Parameters:
    
    entity - The entity to refresh from the data store.
    
    Returns:
    
    The refreshed entity.
  - getAll
```
public List<T> getAll()
```
    Description copied from interface: Dao
    
    Retrieves a list of all the entities of the given type in the data store.
    
    Specified by:
    
    getAll in interface Dao<T,PK>
    
    Returns:
    
    A list of all entities in the data store.
  - getListAsc
```
protected List<T> getListAsc(javax.persistence.metamodel.SingularAttribute<T,?> attribute)
```
  - getUniqueByAttribute
```
protected <Y> T getUniqueByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute,
                                     Y value)
```
    Provides a convenient way for subclasses to implement simple queries that compare an attribute of the entity to a target value.
    
    Type Parameters:
    
    Y - The type of the attribute and target value.
    
    Parameters:
    
    attribute - The attribute of the entity to compare.
    
    value - The target value of the given attribute.
    
    Returns:
    
    A single result that matches the given criteria.
  - getListByAttribute
```
protected <Y> List<T> getListByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute,
                                         Y value)
```
  - getListByAttribute
```
protected <Y extends Number> List<T> getListByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute,
                                                        GenericDao.SqlComparator comparator,
                                                        Y value)
```
  - getListByAttribute
```
protected <Y> List<T> getListByAttribute(GenericDao.QueryPathProvider<T,Y> provider,
                                         Y value)
```
    Get a list of entities whose path value is the same as the given target value. The path is provided by the QueryPathProvider, and is followed through to get the resulting value. That resulting value is compared to the given target value in the query.
    
    Type Parameters:
    
    Y - The type of the target value and resulting attribute/column value.
    
    Parameters:
    
    provider - Provides the path from the entity to the target attribute/column.
    
    value - The target value to compare with the resulting attribute value.
    
    Returns:
    
    A list of entities that match the given criteria.
  - getEntityManager
```
protected final javax.persistence.EntityManager getEntityManager()
```
    Returns an entity manager instance that can be used to interact with the data source.
    
    Returns:
    
    An instance of EntityManager.

Class GenericDao<T,PK>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenericDao

Method Detail

create

retrieve

update

remove

refresh

getAll

getListAsc

getUniqueByAttribute

getListByAttribute

getListByAttribute

getListByAttribute

getEntityManager