org.nuiton.topia.persistence

Class AbstractTopiaDao<E extends TopiaEntity>

java.lang.Object

org.nuiton.topia.persistence.LegacyTopiaDao<E>

org.nuiton.topia.persistence.AbstractTopiaDao<E>

Type Parameters:

E - le type de l'entite

All Implemented Interfaces:

Iterable<E>, TopiaDao<E>, TopiaDAO<E>

public abstract class AbstractTopiaDao<E extends TopiaEntity>
extends LegacyTopiaDao<E>
implements TopiaDao<E>

Cette classe permet d'avoir un ensemble de méthode implantée de façon standard et plus spécifiquement pour Hibernate.

Certains accès à Hibernate sont tout de même fait ici, car on a pris le choix de se baser entièrement sur hibernate pour la persistence, et il est ainsi possible d'accèder au meta information hibernate sur les classes lorque l'on en a besoin.

Version:

$Id: AbstractTopiaDao.java 2864 2013-11-04 15:36:32Z bleny $

Author:

bpoussin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTopiaDao.FindAllIterator<E extends TopiaEntity,R>
static class	AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E extends TopiaEntity>
static class	AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batchSize Default batch size used to iterate on data.
protected TopiaDaoSupplier	topiaDaoSupplier
protected TopiaFiresSupport	topiaFiresSupport
protected TopiaHibernateSupport	topiaHibernateSupport
protected TopiaIdFactory	topiaIdFactory
protected TopiaJpaSupport	topiaJpaSupport
protected TopiaListenableSupport	topiaListenableSupport
protected TopiaSqlSupport	topiaSqlSupport

Constructor Summary

Constructors

Constructor and Description
AbstractTopiaDao()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTopiaEntityListener(TopiaEntityListener listener)
void	addTopiaEntityVetoable(TopiaEntityVetoable vetoable)
long	count() Count the number of existing entities.
protected long	count(String hql, Map<String,Object> hqlParameters)
E	create()
E	create(E entity) Creates an entity not created without the DAO using any of the others create methods.
E	create(Map<String,Object> properties) Creates a new instance of the entity managed by the DAO
E	create(String propertyName, Object propertyValue, Object... otherPropertyNamesAndValues)
Iterable<E>	createAll(Iterable<E> entities)
void	delete(E entity) Deletes the given entity from the storage
void	deleteAll(Iterable<E> entities) Deletes all given entities from the storage
protected boolean	exists(String hql, Map<String,Object> hqlParameters)
List<E>	findAll() Finds all the entities managed by this DAO.
protected List<E>	findAll(String hql, Map<String,Object> hqlParameters)
protected <R> List<R>	findAll(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected <R> List<R>	findAll(String hql, Map<String,Object> hqlParameters, Class<R> type, int startIndex, int endIndex)
protected <R> List<R>	findAll(String hql, Map<String,Object> hqlParameters, Class<R> type, TopiaPagerBean pager)
protected List<E>	findAll(String hql, Map<String,Object> hqlParameters, int startIndex, int endIndex)
protected List<E>	findAll(String hql, Map<String,Object> hqlParameters, TopiaPagerBean pager)
List<String>	findAllIds() Find all the ids for the entities managed by this DAO.
Iterable<E>	findAllLazy()
protected Iterable<E>	findAllLazy(String hql, Map<String,Object> hqlParameters)
protected <R> Iterable<R>	findAllLazy(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected E	findAny(String hql, Map<String,Object> hqlParameters)
protected <R> R	findAny(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected E	findAnyOrNull(String hql, Map<String,Object> hqlParameters)
protected <R> R	findAnyOrNull(String hql, Map<String,Object> hqlParameters, Class<R> type)
E	findByTopiaId(String id) Find an entity corresponding to the id.
protected E	findFirst(String hql, Map<String,Object> hqlParameters)
protected <R> R	findFirst(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected E	findFirstOrNull(String hql, Map<String,Object> hqlParameters)
protected <R> R	findFirstOrNull(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected E	findUnique(String hql, Map<String,Object> hqlParameters)
protected <R> R	findUnique(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected E	findUniqueOrNull(String hql, Map<String,Object> hqlParameters)
protected <R> R	findUniqueOrNull(String hql, Map<String,Object> hqlParameters, Class<R> type)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forContains(String propertyName, Object propertyValue)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forEquals(String propertyName, Object propertyValue)
protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E>	forHql(String hql)
protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E>	forHql(String hql, Map<String,Object> hqlParameters)
protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E>	forHql(String hql, String parameterName, Object parameterValue, Object... otherParameterNamesAndValues)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forIn(String propertyName, Iterable<Object> propertyValues)
AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E>	forProperties(Map<String,Object> properties)
AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E>	forProperties(String propertyName, Object propertyValue, Object... otherPropertyNamesAndValues)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forTopiaIdEquals(String topiaId)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forTopiaIdIn(Iterable<String> topiaIds)
int	getBatchSize() Obtains the batch size used to load data.
protected org.hibernate.metadata.ClassMetadata	getClassMetadata() package locale method because this is hibernate specific method and we don't want expose it.
abstract Class<E>	getEntityClass() Return the class of the entity managed by this DAO.
protected HqlAndParametersBuilder<E>	getHqlForNoConstraint()
protected HqlAndParametersBuilder<E>	getHqlForProperties(Map<String,Object> properties)
protected HqlAndParametersBuilder<E>	getHqlForProperties(String propertyName, Object propertyValue, Object... otherPropertyNamesAndValues)
abstract TopiaEntityEnum	getTopiaEntityEnum() Get the entityEnum of the type of entity managed by this DAO.
TopiaFiresSupport	getTopiaFiresSupport()
void	init(TopiaHibernateSupport topiaHibernateSupport, TopiaJpaSupport topiaJpaSupport, TopiaSqlSupport topiaSqlSupport, TopiaListenableSupport topiaListenableSupport, TopiaIdFactory topiaIdFactory, TopiaFiresSupport topiaFiresSupport, TopiaDaoSupplier topiaDaoSupplier) When AbstractTopiaContext create the TopiaDAOHibernate, it must call this method just after.
Iterator<E>	iterator()
protected String	newFromClause(String alias)
protected HqlAndParametersBuilder<E>	newHqlAndParametersBuilder()
E	newInstance() Create a new instance of managed entity not persisted.
AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E>	newQueryBuilder()
void	removeTopiaEntityListener(TopiaEntityListener listener)
void	removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)
void	setBatchSize(int batchSize) Set a new default batch size.
protected com.google.common.base.Optional<E>	tryFindAny(String hql, Map<String,Object> hqlParameters)
protected <R> com.google.common.base.Optional<R>	tryFindAny(String hql, Map<String,Object> hqlParameters, Class<R> type)
com.google.common.base.Optional<E>	tryFindByTopiaId(String topiaId) Tries to find the entity with the given topiaId.
protected com.google.common.base.Optional<E>	tryFindFirst(String hql, Map<String,Object> hqlParameters)
protected <R> com.google.common.base.Optional<R>	tryFindFirst(String hql, Map<String,Object> hqlParameters, Class<R> type)
protected com.google.common.base.Optional<E>	tryFindUnique(String hql, Map<String,Object> hqlParameters)
protected <R> com.google.common.base.Optional<R>	tryFindUnique(String hql, Map<String,Object> hqlParameters, Class<R> type)
E	update(E entity) Update an entity.
Iterable<E>	updateAll(Iterable<E> entities)

Methods inherited from class org.nuiton.topia.persistence.LegacyTopiaDao

computeAndAddRecordsToPager, countByQuery, create, createSimpleQuery, createSimpleQuery, existByProperties, existByTopiaId, existsByQuery, find, findAll, findAllByProperties, findAllByProperties, findAllByProperty, findAllByQuery, findAllByQuery, findAllByQueryAndPager, findAllByQueryAndPager, findAllByQueryWithBound, findAllByQueryWithBound, findAllContains, findAllLazyByQuery, findAllLazyByQuery, findAllLazyByQuery, findAllLazyByQuery, findAllWithOrder, findByPrimaryKey, findByPrimaryKey, findByProperties, findByProperties, findByProperty, findByQuery, findByQuery, findContains, findUnique, getContext, getRequestPermission, getTopiaContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.topia.persistence.TopiaDao

findAllUsages, findUsages

Field Detail

batchSize

protected int batchSize

Default batch size used to iterate on data.

Since:

2.6.14

topiaHibernateSupport

protected TopiaHibernateSupport topiaHibernateSupport

topiaJpaSupport

protected TopiaJpaSupport topiaJpaSupport

topiaSqlSupport

protected TopiaSqlSupport topiaSqlSupport

topiaListenableSupport

protected TopiaListenableSupport topiaListenableSupport

topiaIdFactory

protected TopiaIdFactory topiaIdFactory

topiaFiresSupport

protected TopiaFiresSupport topiaFiresSupport

topiaDaoSupplier

protected TopiaDaoSupplier topiaDaoSupplier

Constructor Detail

AbstractTopiaDao

public AbstractTopiaDao()

Method Detail

getTopiaEntityEnum

public abstract TopiaEntityEnum getTopiaEntityEnum()

Description copied from interface: TopiaDAO

Get the entityEnum of the type of entity managed by this DAO.

Specified by:

getTopiaEntityEnum in interface TopiaDAO<E extends TopiaEntity>

Returns:

entity type enum managed by this DAO

getEntityClass

public abstract Class<E> getEntityClass()

Description copied from interface: TopiaDao

Return the class of the entity managed by this DAO.

Specified by:

getEntityClass in interface TopiaDao<E extends TopiaEntity>

Returns:

this DAO's managed entity's class

init

public void init(TopiaHibernateSupport topiaHibernateSupport,
        TopiaJpaSupport topiaJpaSupport,
        TopiaSqlSupport topiaSqlSupport,
        TopiaListenableSupport topiaListenableSupport,
        TopiaIdFactory topiaIdFactory,
        TopiaFiresSupport topiaFiresSupport,
        TopiaDaoSupplier topiaDaoSupplier)

When AbstractTopiaContext create the TopiaDAOHibernate, it must call this method just after.

getTopiaFiresSupport

public TopiaFiresSupport getTopiaFiresSupport()

getBatchSize

public int getBatchSize()

Description copied from interface: TopiaDao

Obtains the batch size used to load data.

Default value if 1000.

Specified by:

getBatchSize in interface TopiaDao<E extends TopiaEntity>

Returns:

the batch size.

setBatchSize

public void setBatchSize(int batchSize)

Description copied from interface: TopiaDao

Set a new default batch size.

Specified by:

setBatchSize in interface TopiaDao<E extends TopiaEntity>

Parameters:

batchSize - new batch size to use when iterating.

newFromClause

protected String newFromClause(String alias)

Specified by:

newFromClause in class LegacyTopiaDao<E extends TopiaEntity>

newInstance

public E newInstance()

Description copied from interface: TopiaDao

Create a new instance of managed entity not persisted.

Specified by:

newInstance in interface TopiaDao<E extends TopiaEntity>

addTopiaEntityListener

public void addTopiaEntityListener(TopiaEntityListener listener)

Specified by:

addTopiaEntityListener in interface TopiaDao<E extends TopiaEntity>

addTopiaEntityVetoable

public void addTopiaEntityVetoable(TopiaEntityVetoable vetoable)

Specified by:

addTopiaEntityVetoable in interface TopiaDao<E extends TopiaEntity>

removeTopiaEntityListener

public void removeTopiaEntityListener(TopiaEntityListener listener)

Specified by:

removeTopiaEntityListener in interface TopiaDao<E extends TopiaEntity>

removeTopiaEntityVetoable

public void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)

Specified by:

removeTopiaEntityVetoable in interface TopiaDao<E extends TopiaEntity>

create

public E create(E entity)

Description copied from interface: TopiaDao

Creates an entity not created without the DAO using any of the others create methods. The instance may have been created elsewhere.

Specified by:

create in interface TopiaDao<E extends TopiaEntity>

Parameters:

entity - the instance to persist

Returns:

the persisted entity (with its topiaId valued)

create

public E create(String propertyName,
       Object propertyValue,
       Object... otherPropertyNamesAndValues)

Specified by:

create in interface TopiaDao<E extends TopiaEntity>

create

public E create(Map<String,Object> properties)

Description copied from interface: TopiaDao

Creates a new instance of the entity managed by the DAO

Specified by:

create in interface TopiaDao<E extends TopiaEntity>

Parameters:

properties - the key-value list of properties that the created entity will have.

Returns:

the newly created entity

create

public E create()

Specified by:

create in interface TopiaDao<E extends TopiaEntity>

createAll

public Iterable<E> createAll(Iterable<E> entities)

Specified by:

createAll in interface TopiaDao<E extends TopiaEntity>

update

public E update(E entity)

Description copied from interface: TopiaDao

Update an entity. May be used for an entity coming from another context.

Specified by:

update in interface TopiaDao<E extends TopiaEntity>

Parameters:

entity - the entity to create or update

Returns:

the given entity

updateAll

public Iterable<E> updateAll(Iterable<E> entities)

Specified by:

updateAll in interface TopiaDao<E extends TopiaEntity>

delete

public void delete(E entity)

Description copied from interface: TopiaDao

Deletes the given entity from the storage

Specified by:

delete in interface TopiaDao<E extends TopiaEntity>

Parameters:

entity - the entity to remove

deleteAll

public void deleteAll(Iterable<E> entities)

Description copied from interface: TopiaDao

Deletes all given entities from the storage

Specified by:

deleteAll in interface TopiaDao<E extends TopiaEntity>

Parameters:

entities - entities to delete

newHqlAndParametersBuilder

protected HqlAndParametersBuilder<E> newHqlAndParametersBuilder()

getHqlForProperties

protected HqlAndParametersBuilder<E> getHqlForProperties(String propertyName,
                                             Object propertyValue,
                                             Object... otherPropertyNamesAndValues)

getHqlForNoConstraint

protected HqlAndParametersBuilder<E> getHqlForNoConstraint()

getHqlForProperties

protected HqlAndParametersBuilder<E> getHqlForProperties(Map<String,Object> properties)

forHql

protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E> forHql(String hql)

forHql

protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E> forHql(String hql,
                                                       Map<String,Object> hqlParameters)

Specified by:

forHql in class LegacyTopiaDao<E extends TopiaEntity>

forHql

protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E> forHql(String hql,
                                                       String parameterName,
                                                       Object parameterValue,
                                                       Object... otherParameterNamesAndValues)

forProperties

public AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E> forProperties(Map<String,Object> properties)

Specified by:

forProperties in interface TopiaDao<E extends TopiaEntity>

forProperties

public AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E> forProperties(String propertyName,
                                                                 Object propertyValue,
                                                                 Object... otherPropertyNamesAndValues)

Specified by:

forProperties in interface TopiaDao<E extends TopiaEntity>

newQueryBuilder

public AbstractTopiaDao.TopiaQueryBuilderAddCriteriaStep<E> newQueryBuilder()

Specified by:

newQueryBuilder in interface TopiaDao<E extends TopiaEntity>

forContains

public TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forContains(String propertyName,
                                                        Object propertyValue)

Specified by:

forContains in interface TopiaDao<E extends TopiaEntity>

forEquals

public TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forEquals(String propertyName,
                                                      Object propertyValue)

Specified by:

forEquals in interface TopiaDao<E extends TopiaEntity>

forIn

public TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forIn(String propertyName,
                                                  Iterable<Object> propertyValues)

Specified by:

forIn in interface TopiaDao<E extends TopiaEntity>

exists

protected boolean exists(String hql,
             Map<String,Object> hqlParameters)

Specified by:

exists in class LegacyTopiaDao<E extends TopiaEntity>

count

protected long count(String hql,
         Map<String,Object> hqlParameters)

findUnique

protected E findUnique(String hql,
           Map<String,Object> hqlParameters)

findUniqueOrNull

protected E findUniqueOrNull(String hql,
                 Map<String,Object> hqlParameters)

tryFindUnique

protected com.google.common.base.Optional<E> tryFindUnique(String hql,
                                               Map<String,Object> hqlParameters)

findFirst

protected E findFirst(String hql,
          Map<String,Object> hqlParameters)

findFirstOrNull

protected E findFirstOrNull(String hql,
                Map<String,Object> hqlParameters)

tryFindFirst

protected com.google.common.base.Optional<E> tryFindFirst(String hql,
                                              Map<String,Object> hqlParameters)

findAny

protected E findAny(String hql,
        Map<String,Object> hqlParameters)

findAnyOrNull

protected E findAnyOrNull(String hql,
              Map<String,Object> hqlParameters)

tryFindAny

protected com.google.common.base.Optional<E> tryFindAny(String hql,
                                            Map<String,Object> hqlParameters)

findUnique

protected <R> R findUnique(String hql,
               Map<String,Object> hqlParameters,
               Class<R> type)

Specified by:

findUnique in class LegacyTopiaDao<E extends TopiaEntity>

tryFindUnique

protected <R> com.google.common.base.Optional<R> tryFindUnique(String hql,
                                                   Map<String,Object> hqlParameters,
                                                   Class<R> type)

findUniqueOrNull

protected <R> R findUniqueOrNull(String hql,
                     Map<String,Object> hqlParameters,
                     Class<R> type)

findFirst

protected <R> R findFirst(String hql,
              Map<String,Object> hqlParameters,
              Class<R> type)

tryFindFirst

protected <R> com.google.common.base.Optional<R> tryFindFirst(String hql,
                                                  Map<String,Object> hqlParameters,
                                                  Class<R> type)

findFirstOrNull

protected <R> R findFirstOrNull(String hql,
                    Map<String,Object> hqlParameters,
                    Class<R> type)

findAny

protected <R> R findAny(String hql,
            Map<String,Object> hqlParameters,
            Class<R> type)

Specified by:

findAny in class LegacyTopiaDao<E extends TopiaEntity>

tryFindAny

protected <R> com.google.common.base.Optional<R> tryFindAny(String hql,
                                                Map<String,Object> hqlParameters,
                                                Class<R> type)

findAnyOrNull

protected <R> R findAnyOrNull(String hql,
                  Map<String,Object> hqlParameters,
                  Class<R> type)

Specified by:

findAnyOrNull in class LegacyTopiaDao<E extends TopiaEntity>

findAll

protected List<E> findAll(String hql,
              Map<String,Object> hqlParameters)

findAll

protected List<E> findAll(String hql,
              Map<String,Object> hqlParameters,
              int startIndex,
              int endIndex)

findAll

protected List<E> findAll(String hql,
              Map<String,Object> hqlParameters,
              TopiaPagerBean pager)

findAll

protected <R> List<R> findAll(String hql,
                  Map<String,Object> hqlParameters,
                  Class<R> type)

Specified by:

findAll in class LegacyTopiaDao<E extends TopiaEntity>

findAll

protected <R> List<R> findAll(String hql,
                  Map<String,Object> hqlParameters,
                  Class<R> type,
                  int startIndex,
                  int endIndex)

Specified by:

findAll in class LegacyTopiaDao<E extends TopiaEntity>

findAll

protected <R> List<R> findAll(String hql,
                  Map<String,Object> hqlParameters,
                  Class<R> type,
                  TopiaPagerBean pager)

findAllLazy

protected Iterable<E> findAllLazy(String hql,
                      Map<String,Object> hqlParameters)

Specified by:

findAllLazy in class LegacyTopiaDao<E extends TopiaEntity>

findAllLazy

protected <R> Iterable<R> findAllLazy(String hql,
                          Map<String,Object> hqlParameters,
                          Class<R> type)

Specified by:

findAllLazy in class LegacyTopiaDao<E extends TopiaEntity>

forTopiaIdEquals

public TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forTopiaIdEquals(String topiaId)

Specified by:

forTopiaIdEquals in interface TopiaDao<E extends TopiaEntity>

forTopiaIdIn

public TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forTopiaIdIn(Iterable<String> topiaIds)

Specified by:

forTopiaIdIn in interface TopiaDao<E extends TopiaEntity>

findByTopiaId

public E findByTopiaId(String id)

Description copied from interface: TopiaDAO

Find an entity corresponding to the id. If the id is null, nothing will be searched.

Specified by:

findByTopiaId in interface TopiaDao<E extends TopiaEntity>

Specified by:

findByTopiaId in interface TopiaDAO<E extends TopiaEntity>

Overrides:

findByTopiaId in class LegacyTopiaDao<E extends TopiaEntity>

Parameters:

id - topiaId of the entity to found

Returns:

the entity found or null if not

tryFindByTopiaId

public com.google.common.base.Optional<E> tryFindByTopiaId(String topiaId)

Description copied from interface: TopiaDao

Tries to find the entity with the given topiaId. If not found, the result.isPresent() will be false.

Specified by:

tryFindByTopiaId in interface TopiaDao<E extends TopiaEntity>

Parameters:

topiaId - the identifier of the entity to look for

Returns:

The entity found wrapped by an Optional

findAllIds

public List<String> findAllIds()

Description copied from interface: TopiaDao

Find all the ids for the entities managed by this DAO.

Specified by:

findAllIds in interface TopiaDao<E extends TopiaEntity>

Returns:

the ids of all the entities

findAll

public List<E> findAll()

Description copied from interface: TopiaDao

Finds all the entities managed by this DAO.

Specified by:

findAll in interface TopiaDao<E extends TopiaEntity>

Returns:

the full list of entities in no particular (non-determinisic) order

findAllLazy

public Iterable<E> findAllLazy()

Specified by:

findAllLazy in interface TopiaDao<E extends TopiaEntity>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends TopiaEntity>

count

public long count()

Description copied from interface: TopiaDao

Count the number of existing entities.

Specified by:

count in interface TopiaDao<E extends TopiaEntity>

Returns:

number of total entities

getClassMetadata

protected org.hibernate.metadata.ClassMetadata getClassMetadata()

package locale method because this is hibernate specific method and we don't want expose it.

Returns:

the meta-data of the entity

Throws:

TopiaException - if any pb