nc.ird.cantharella.data.dao.impl

Class HibernateTemplateDao

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

nc.ird.cantharella.data.dao.impl.HibernateTemplateDao

All Implemented Interfaces:

GenericDao, org.springframework.beans.factory.InitializingBean

@Repository
public class HibernateTemplateDao
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements GenericDao

Generic DAO implementation for Hibernate

Author:

Mickael Tricot, Adrien Cheype

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
HibernateTemplateDao() Logger
HibernateTemplateDao(org.hibernate.SessionFactory sessionFactory) Constructor

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

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateTemplateDao

public HibernateTemplateDao()

Logger

HibernateTemplateDao

public HibernateTemplateDao(org.hibernate.SessionFactory sessionFactory)

Constructor

Parameters:

sessionFactory - Session factory

Method Detail

count

public long count(org.hibernate.criterion.DetachedCriteria criteria)

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

Specified by:

count in interface GenericDao

Parameters:

criteria - The criteria

Returns:

The number

count

public <M extends AbstractModel> long count(Class<M> modelClass)

Count the number of rows

Specified by:

count in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

Returns:

Number of rows

count

public long count(String hqlQuery,
         Object... parameters)

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

Specified by:

count in interface GenericDao

Parameters:

hqlQuery - The HQL query string

parameters - Parameters (in replacement of ?)

Returns:

The number

create

public <M extends AbstractModel> void create(M model)

Create a model

Specified by:

create in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

createOrUpdate

public <M extends AbstractModel> void createOrUpdate(M model)

Create or update a model

Specified by:

createOrUpdate in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

delete

public <M extends AbstractModel> void delete(Class<M> modelClass,
                                    Serializable id)

Delete a model

Specified by:

delete in interface GenericDao

Type Parameters:

M - model type

Parameters:

modelClass - Model class (not null)

id - Model ID (not null)

delete

public <M extends AbstractModel> void delete(M model)

Delete a model

Specified by:

delete in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

list

public List<?> list(org.hibernate.criterion.DetachedCriteria criteria)

List entities given by the search criteria

Specified by:

list in interface GenericDao

Parameters:

criteria - The criteria

Returns:

List of results

list

public List<?> list(String hqlQuery,
           Object... parameters)

List entities given by the hql query

Specified by:

list in interface GenericDao

Parameters:

hqlQuery - The HQL query string

parameters - Parameters (in replacement of ?)

Returns:

List of results

execute

public int execute(String sqlQuery,
          Object... parameters)

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

Specified by:

execute in interface GenericDao

Parameters:

sqlQuery - SQL query

parameters - Parameters (in replacement of ?)

Returns:

Number of rows affected

exists

public <M extends AbstractModel> boolean exists(Class<M> modelClass,
                                       Serializable id)

Test model existence

Specified by:

exists in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

id - ID (not null)

Returns:

Existence

exists

public <M extends AbstractModel> boolean exists(Class<M> modelClass,
                                       String property,
                                       Serializable value)

Test model existence

Specified by:

exists in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class

property - Property name

value - Property value

Returns:

Existence

exists

public boolean exists(org.hibernate.criterion.DetachedCriteria criteria)

Test existence of a criteria

Specified by:

exists in interface GenericDao

Parameters:

criteria - The criteria

Returns:

True if exists, otherwise false

readList

public <M extends AbstractModel> List<M> readList(Class<M> modelClass)

Read models

Specified by:

readList in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

Returns:

Models

readList

public <M extends AbstractModel> List<M> readList(Class<M> modelClass,
                                         String... sortColumns)

Read models

Specified by:

readList in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

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

Returns:

Models

readList

public <M extends AbstractModel> List<M> readList(Class<M> modelClass,
                                         int firstResult,
                                         int maxResults)

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

Specified by:

readList in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

firstResult - First result (not negative)

maxResults - Max results (not negative)

Returns:

Models

readList

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

Specified by:

readList in interface GenericDao

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

read

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

Read a model

Specified by:

read in interface GenericDao

Type Parameters:

M - Model type

Parameters:

modelClass - Model class (not null)

id - Model ID (not null)

Returns:

Model (null if not found)

read

public <M extends AbstractModel> M read(Class<M> modelClass,
                               String uniqueProperty,
                               Serializable value)

Read and fetch a model

Specified by:

read in interface GenericDao

Type Parameters:

M - Model class

Parameters:

modelClass - Model class

uniqueProperty - Unique property name

value - Unique property value

Returns:

Model

refresh

public <M extends AbstractModel> void refresh(M model)

Refresh a model object

Specified by:

refresh in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model object

update

public <M extends AbstractModel> void update(M model)

Update a model

Specified by:

update in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

evict

public <M extends AbstractModel> void evict(M model)

Evict a model. Remove from the hibernate session.

Specified by:

evict in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

contains

public <M extends AbstractModel> boolean contains(M model)

Check if the given model is in the hibernate session.

Specified by:

contains in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)

Returns:

If the given model is in the hibernate session

merge

public <M extends AbstractModel> void merge(M model)

Merge a model from the hibernate session.

Specified by:

merge in interface GenericDao

Type Parameters:

M - Model type

Parameters:

model - Model (not null)