GenericDao (Eureka! Clinical Standard APIs 2.0 API)

java.lang.Object
- org.eurekaclinical.standardapis.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>

Direct Known Subclasses:

AbstractJpaGroupDao, AbstractJpaRoleDao, AbstractJpaUserDao, AbstractJpaUserTemplateDao, HistoricalGenericDao
```
public class GenericDao<T,PK>
extends Object
implements Dao<T,PK>
```
Generic implementation of the Dao interface. It is a wrapper around the EntityManager interface.

Author:

hrathod

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GenericDao(Class<T> inEntityClass, javax.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 an entity in the database.
`List<T>`	`getAll()` Gets all of this DAO's entities.
`protected DatabaseSupport`	`getDatabaseSupport()`
`protected Class<T>`	`getEntityClass()`
`protected javax.persistence.EntityManager`	`getEntityManager()` Returns an entity manager that can be used to interact with the data source.
`protected List<T>`	`getListAsc(javax.persistence.metamodel.SingularAttribute<T,?> attribute)` Gets all of this DAO's entities ordered by the provided attribute in ascending order.
`protected <Y> List<T>`	`getListByAttribute(QueryPathProvider<T,Y> provider, Y value)` Executes a query for all entities whose path value is the same as the given target value.
`protected <Y> List<T>`	`getListByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute, Y value)` Gets the entities that have the target value of the specified attribute.
`protected <Y> List<T>`	`getListByAttributeIn(QueryPathProvider<T,Y> provider, List<Y> values)` Executes a query for all entities whose path value is any of the target values.
`protected <Y> List<T>`	`getListByAttributeIn(javax.persistence.metamodel.SingularAttribute<T,Y> attribute, List<Y> values)` Gets the entities that have any of the target values of the specified attribute.
`protected <Y> T`	`getUniqueByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute, Y value)` Gets the entity that has the target value of the specified attribute.
`protected <Y> T`	`getUniqueByAttribute(String attributeName, Y value)` Gets the entity that has the target value of the specified attribute.
`T`	`refresh(T entity)` Synchronizes the given entity with what is currently in the database.
`T`	`remove(T entity)` Deletes an entity from the database.
`T`	`retrieve(PK uniqueId)` Selects an entity from the database.
`T`	`update(T entity)` Updates an entity in the database.

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,
                     javax.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)
```
    Creates an entity in the database. It calls EntityManager.persist(java.lang.Object) and throws the same exceptions.
    
    Specified by:
    
    create in interface Dao<T,PK>
    
    Parameters:
    
    entity - the entity to create.
    
    Returns:
    
    the created entity with any primary key field populated.
  - retrieve
```
public final T retrieve(PK uniqueId)
```
    Selects an entity from the database. It calls EntityManager.find(java.lang.Class, java.lang.Object) and throws the same exceptions.
    
    Specified by:
    
    retrieve in interface Dao<T,PK>
    
    Parameters:
    
    uniqueId - the primary key of the entity to select.
    
    Returns:
    
    the entity, or null if none has the specified primary key.
  - update
```
public T update(T entity)
```
    Updates an entity in the database. It calls EntityManager.merge(java.lang.Object) and throws the same exceptions.
    
    Specified by:
    
    update in interface Dao<T,PK>
    
    Parameters:
    
    entity - the updates to the entity.
    
    Returns:
    
    the updated entity.
  - remove
```
public T remove(T entity)
```
    Deletes an entity from the database. It calls EntityManager.remove(java.lang.Object) and throws the same exceptions.
    
    Specified by:
    
    remove in interface Dao<T,PK>
    
    Parameters:
    
    entity - the entity to delete.
    
    Returns:
    
    the deleted entity.
  - refresh
```
public T refresh(T entity)
```
    Synchronizes the given entity with what is currently in the database.
    
    Specified by:
    
    refresh in interface Dao<T,PK>
    
    Parameters:
    
    entity - the entity to refresh.
    
    Returns:
    
    the refreshed entity.
  - getAll
```
public List<T> getAll()
```
    Gets all of this DAO's entities.
    
    Specified by:
    
    getAll in interface Dao<T,PK>
    
    Returns:
    
    a list of entities. Guaranteed not null.
  - getListAsc
```
protected List<T> getListAsc(javax.persistence.metamodel.SingularAttribute<T,?> attribute)
```
    Gets all of this DAO's entities ordered by the provided attribute in ascending order.
    
    Parameters:
    
    attribute - the attribute to order by.
    
    Returns:
    
    an ordered list of entities. Guaranteed not null.
  - getUniqueByAttribute
```
protected <Y> T getUniqueByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute,
                                     Y value)
```
    Gets the entity that has the target value of the specified attribute.
    
    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:
    
    the matching entity, or null if there is none.
  - getUniqueByAttribute
```
protected <Y> T getUniqueByAttribute(String attributeName,
                                     Y value)
```
    Gets the entity that has the target value of the specified attribute.
    
    Type Parameters:
    
    Y - the type of the attribute and target value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the target value of the given attribute.
    
    Returns:
    
    the matching entity, or null if there is none.
  - getListByAttribute
```
protected <Y> List<T> getListByAttribute(javax.persistence.metamodel.SingularAttribute<T,Y> attribute,
                                         Y value)
```
    Gets the entities that have the target value of the specified attribute.
    
    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:
    
    the matching entities. Guaranteed not null.
  - getListByAttribute
```
protected <Y> List<T> getListByAttribute(QueryPathProvider<T,Y> provider,
                                         Y value)
```
    Executes a query for all 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.
  - getListByAttributeIn
```
protected <Y> List<T> getListByAttributeIn(javax.persistence.metamodel.SingularAttribute<T,Y> attribute,
                                           List<Y> values)
```
    Gets the entities that have any of the target values of the specified attribute.
    
    Type Parameters:
    
    Y - the type of the attribute and target value.
    
    Parameters:
    
    attribute - the attribute of the entity to compare.
    
    values - the target values of the given attribute.
    
    Returns:
    
    the matching entities. Guaranteed not null.
  - getListByAttributeIn
```
protected <Y> List<T> getListByAttributeIn(QueryPathProvider<T,Y> provider,
                                           List<Y> values)
```
    Executes a query for all entities whose path value is any of the target values. 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 values 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.
    
    values - the target values of the given attribute.
    
    Returns:
    
    A list of entities that match the given criteria.
  - getEntityManager
```
protected javax.persistence.EntityManager getEntityManager()
```
    Returns an entity manager that can be used to interact with the data source.
    
    Returns:
    
    the entity manager.
  - getDatabaseSupport
```
protected DatabaseSupport getDatabaseSupport()
```
  - getEntityClass
```
protected Class<T> getEntityClass()
```

Class GenericDao<T,PK>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenericDao

Method Detail

create

retrieve

update

remove

refresh

getAll

getListAsc

getUniqueByAttribute

getUniqueByAttribute

getListByAttribute

getListByAttribute

getListByAttributeIn

getListByAttributeIn

getEntityManager

getDatabaseSupport

getEntityClass