nc.ird.cantharella.data.dao

Interface GenericDao

All Known Implementing Classes:

HibernateTemplateDao

public interface GenericDao

Generic DAO (works for all models)

Author:

Mickael Tricot, Adrien Cheype

Method Summary

Methods

Modifier and Type	Method and Description
<M extends AbstractModel> boolean	contains(M model) Check if the given model is in the hibernate session.
<M extends AbstractModel> long	count(Class<M> modelClass) Count the number of rows
long	count(org.hibernate.criterion.DetachedCriteria criteria) Count the number of result given by the search criteria.
long	count(String hqlQuery, Object... parameters) Count the number of result given by the hql search.
<M extends AbstractModel> void	create(M model) Create a model
<M extends AbstractModel> void	createOrUpdate(M model) Create or update a model
<M extends AbstractModel> void	delete(Class<M> modelClass, Serializable id) Delete a model
<M extends AbstractModel> void	delete(M model) Delete a model
<M extends AbstractModel> void	evict(M model) Evict a model.
int	execute(String sqlQuery, Object... parameters) Execute SQL query.
<M extends AbstractModel> boolean	exists(Class<M> modelClass, Serializable id) Test model existence
<M extends AbstractModel> boolean	exists(Class<M> modelClass, String property, Serializable value) Test model existence
boolean	exists(org.hibernate.criterion.DetachedCriteria criteria) Test existence of a criteria
List<?>	list(org.hibernate.criterion.DetachedCriteria criteria) List entities given by the search criteria
List<?>	list(String hqlQuery, Object... parameters) List entities given by the hql query
<M extends AbstractModel> M	merge(M model) Merge a model from the hibernate session.
<M extends AbstractModel> M	read(Class<M> modelClass, Serializable id) Read a model
<M extends AbstractModel> M	read(Class<M> modelClass, String uniqueProperty, Serializable value) Read and fetch a model
<M extends AbstractModel> List<M>	readList(Class<M> modelClass) Read models
<M extends AbstractModel> List<M>	readList(Class<M> modelClass, int firstResult, int maxResults) Read models according to the order of @Id or @EmbeddedId column
<M extends AbstractModel> List<M>	readList(Class<M> modelClass, int firstResult, int maxResults, String... sortColumns) Read models according to the order of @Id or @EmbeddedId column
<M extends AbstractModel> List<M>	readList(Class<M> modelClass, String... sortColumns) Read models
<M extends AbstractModel> void	refresh(M model) Refresh a model object
<M extends AbstractModel> void	update(M model) Update a model

Method Detail

count

@Transactional(readOnly=true)
<M extends AbstractModel> long count(Class<M> modelClass)

Count the number of rows

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

Returns:

Number of rows

count

@Transactional(readOnly=true)
long count(org.hibernate.criterion.DetachedCriteria criteria)

Count the number of result given by the search criteria. The criteria must contain the count projection.

Parameters:

criteria - The criteria

Returns:

The number

count

@Transactional(readOnly=true)
long count(String hqlQuery,
                       Object... parameters)

Count the number of result given by the hql search. The hql query must contain the count operator.

Parameters:

hqlQuery - The HQL query string

parameters - Parameters (in replacement of ?)

Returns:

The number

create

@Transactional
<M extends AbstractModel> void create(M model)
            throws DataConstraintException

Create a model

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Throws:

DataConstraintException - When there is a problem of data integrity

createOrUpdate

@Transactional
<M extends AbstractModel> void createOrUpdate(M model)
                    throws DataConstraintException

Create or update a model

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Throws:

DataConstraintException - When there is a problem of data integrity

delete

@Transactional
<M extends AbstractModel> void delete(Class<M> modelClass,
                                                  Serializable id)
            throws DataConstraintException,
                   DataNotFoundException

Delete a model

Type Parameters:

M - model type

Parameters:

modelClass - Model class (not null)

id - Model ID (not null)

Throws:

DataNotFoundException - Model not found

DataConstraintException - Model linked to other objects

delete

@Transactional
<M extends AbstractModel> void delete(M model)
            throws DataNotFoundException,
                   DataConstraintException

Delete a model

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Throws:

DataNotFoundException - Model not found

DataConstraintException - Model linked to other objects

list

@Transactional(readOnly=true)
List<?> list(org.hibernate.criterion.DetachedCriteria criteria)

List entities given by the search criteria

Parameters:

criteria - The criteria

Returns:

List of results

list

@Transactional(readOnly=true)
List<?> list(String hqlQuery,
                         Object... parameters)

List entities given by the hql query

Parameters:

hqlQuery - The HQL query string

parameters - Parameters (in replacement of ?)

Returns:

List of results

execute

@Transactional
int execute(String sqlQuery,
                        Object... parameters)
            throws DataConstraintException

Execute SQL query. This method is not recommanded because it shortcuts the Hibernate process. Do not use it if it is not really necessary.

Parameters:

sqlQuery - SQL query

parameters - Parameters (in replacement of ?)

Returns:

Number of rows affected

Throws:

DataConstraintException - In case of data integrity exceptions

exists

@Transactional(readOnly=true)
<M extends AbstractModel> boolean exists(Class<M> modelClass,
                                                     Serializable id)

Test model existence

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

id - ID (not null)

Returns:

Existence

exists

@Transactional(readOnly=true)
<M extends AbstractModel> boolean exists(Class<M> modelClass,
                                                     String property,
                                                     Serializable value)

Test model existence

Type Parameters:

M - Model type

Parameters:

modelClass - Model class

property - Property name

value - Property value

Returns:

Existence

exists

@Transactional(readOnly=true)
boolean exists(org.hibernate.criterion.DetachedCriteria criteria)

Test existence of a criteria

Parameters:

criteria - The criteria

Returns:

True if exists, otherwise false

readList

@Transactional(readOnly=true)
<M extends AbstractModel> List<M> readList(Class<M> modelClass)

Read models

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

Returns:

Models

readList

@Transactional(readOnly=true)
<M extends AbstractModel> List<M> readList(Class<M> modelClass,
                                                       String... sortColumns)

Read models

Type Parameters:

M - Model type

Parameters:

sortColumns - column names for the models sort (with the order)

modelClass - Model class (not null)

Returns:

Models

readList

@Transactional(readOnly=true)
<M extends AbstractModel> List<M> readList(Class<M> modelClass,
                                                       int firstResult,
                                                       int maxResults,
                                                       String... sortColumns)

Read models according to the order of @Id or @EmbeddedId column

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

firstResult - First result (not negative)

maxResults - Max results (not negative)

sortColumns - column names for the models sort (with the order)

Returns:

Models

readList

@Transactional(readOnly=true)
<M extends AbstractModel> List<M> readList(Class<M> modelClass,
                                                       int firstResult,
                                                       int maxResults)

Read models according to the order of @Id or @EmbeddedId column

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

firstResult - First result (not negative)

maxResults - Max results (not negative)

Returns:

Models

read

<M extends AbstractModel> M read(Class<M> modelClass,
                               Serializable id)
                             throws DataNotFoundException

Read a model

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

id - Model ID (not null)

Returns:

Model (null if not found)

Throws:

DataNotFoundException - Model not found

read

@Transactional(readOnly=true)
<M extends AbstractModel> M read(Class<M> modelClass,
                                             String uniqueProperty,
                                             Serializable value)
                             throws DataNotFoundException

Read and fetch a model

Type Parameters:

M - Model class

Parameters:

modelClass - Model class

uniqueProperty - Unique property name

value - Unique property value

Returns:

Model

Throws:

DataNotFoundException - Model not found

refresh

@Transactional(readOnly=true)
<M extends AbstractModel> void refresh(M model)

Refresh a model object

Type Parameters:

M - Model type

Parameters:

model - Model object

update

@Transactional
<M extends AbstractModel> void update(M model)
            throws DataNotFoundException,
                   DataConstraintException

Update a model

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Throws:

DataNotFoundException - Model not found

DataConstraintException - Model already exists

evict

@Transactional
<M extends AbstractModel> void evict(M model)

Evict a model. Remove from the hibernate session.

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

contains

@Transactional(readOnly=true)
<M extends AbstractModel> boolean contains(M model)

Check if the given model is in the hibernate session.

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Returns:

If the given model is in the hibernate session

merge

@Transactional
<M extends AbstractModel> M merge(M model)

Merge a model from the hibernate session.

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Returns:

merged object