org.nuiton.topia.persistence.internal

Class AbstractTopiaDao<E extends TopiaEntity>

java.lang.Object

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

Type Parameters:

E - the managed entity type

All Implemented Interfaces:

Iterable<E>, TopiaDao<E>

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

This class has the common methods usable for each Dao managed by Topia. It is not JPA implementation dependent, it only relies on TopiaJpaSupport.

This class is directly extended by the GeneratedXyzTopiaDao which groups all the Xyz specific methods.

Instances are created bt the model's specific TopiaPersistenceContext, which implements the TopiaDaoSupplier contract.

Author:

bpoussin , Arnaud Thimel (Code Lutin), Tony CHEMIT

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTopiaDao.FindAllIterator<E extends TopiaEntity,O>
static class	AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E extends TopiaEntity>
static class	AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batchSize Default batch size used to iterate on data.
protected static com.google.common.base.Function<org.nuiton.util.pagination.PaginationOrder,String>	PAGINATION_ORDER_TO_HQL
protected TopiaDaoSupplier	topiaDaoSupplier
protected TopiaFiresSupport	topiaFiresSupport
protected TopiaHibernateSupport	topiaHibernateSupport
protected TopiaIdFactory	topiaIdFactory
protected TopiaJpaSupport	topiaJpaSupport
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)
protected <O> List<O>	find(String hql, int startIndex, int endIndex)
protected <O> List<O>	find(String hql, Map<String,Object> hqlParameters, int startIndex, int endIndex)
protected <O> List<O>	find(String hql, Map<String,Object> hqlParameters, org.nuiton.util.pagination.PaginationParameter page)
List<E>	findAll() Finds all the entities managed by this DAO.
protected <O> List<O>	findAll(String hql)
protected <O> List<O>	findAll(String hql, Map<String,Object> hqlParameters)
List<String>	findAllIds() Find all the ids for the entities managed by this DAO.
Iterable<E>	findAllLazy()
protected <O> Iterable<O>	findAllLazy(String hql)
protected <O> Iterable<O>	findAllLazy(String hql, int batchSize)
protected <O> Iterable<O>	findAllLazy(String hql, Map<String,Object> hqlParameters)
protected <O> Iterable<O>	findAllLazy(String hql, Map<String,Object> hqlParameters, int batchSize)
protected <O> O	findAny(String hql, Map<String,Object> hqlParameters)
protected <O> O	findAnyOrNull(String hql)
protected <O> O	findAnyOrNull(String hql, Map<String,Object> hqlParameters)
E	findByTopiaId(String topiaId) Deprecated.
protected <O> O	findFirst(String hql, Map<String,Object> hqlParameters)
protected <O> O	findFirstOrNull(String hql, Map<String,Object> hqlParameters)
protected <O> org.nuiton.util.pagination.PaginationResult<O>	findPage(String hql, Map<String,Object> hqlParameters, org.nuiton.util.pagination.PaginationParameter page)
protected <O> O	findUnique(String hql, Map<String,Object> hqlParameters)
protected <O> O	findUniqueOrNull(String hql, Map<String,Object> hqlParameters)
AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forAll() Creates a QueryBuilder without restriction
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forContains(String propertyName, Object propertyValue)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forEquals(String propertyName, Object propertyValue)
protected AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E>	forHql(String hql)
protected AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E>	forHql(String hql, Map<String,Object> hqlParameters)
protected AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E>	forHql(String hql, String parameterName, Object parameterValue, Object... otherParameterNamesAndValues)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forIn(String propertyName, Collection<?> propertyValues)
AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forProperties(Map<String,Object> properties)
AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forProperties(String propertyName, Object propertyValue, Object... otherPropertyNamesAndValues)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forTopiaIdEquals(String topiaId)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forTopiaIdIn(Collection<String> topiaIds)
int	getBatchSize() Obtains the batch size used to load data.
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()
TopiaFiresSupport	getTopiaFiresSupport()
protected boolean	hqlContainsCount(String hql)
protected boolean	hqlContainsOrderBy(String hql)
protected boolean	hqlStartsWithSelect(String hql)
void	init(TopiaJpaSupport topiaJpaSupport, TopiaHibernateSupport topiaHibernateSupport, TopiaSqlSupport topiaSqlSupport, TopiaIdFactory topiaIdFactory, TopiaFiresSupport topiaFiresSupport, TopiaDaoSupplier topiaDaoSupplier) When AbstractTopiaContext create the TopiaDAOHibernate, it must call this method just after.
org.nuiton.util.pagination.PaginationResult<E>	initPagination(int pageSize) Creates a new pager initialized for the first page of all data of the dao.
org.nuiton.util.pagination.PaginationResult<E>	initPagination(String hql, Map<String,Object> params, int pageSize) Creates a new pager initialized for the first page of data of the given query.
Iterator<E>	iterator()
protected String	newFromClause()
protected String	newFromClause(String alias)
protected HqlAndParametersBuilder<E>	newHqlAndParametersBuilder()
E	newInstance() Create a new instance of managed entity not persisted.
AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	newQueryBuilder()
void	removeTopiaEntityListener(TopiaEntityListener listener)
void	removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)
void	setBatchSize(int batchSize) Set a new default batch size.
protected <O> com.google.common.base.Optional<O>	tryFindAny(String hql, Map<String,Object> hqlParameters)
com.google.common.base.Optional<E>	tryFindByTopiaId(String topiaId) Deprecated.
protected <O> com.google.common.base.Optional<O>	tryFindFirst(String hql, Map<String,Object> hqlParameters)
protected <O> com.google.common.base.Optional<O>	tryFindUnique(String hql, Map<String,Object> hqlParameters)
E	update(E entity) Update an entity.
Iterable<E>	updateAll(Iterable<E> entities)

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, getAggregate, getComposite

Field Detail

PAGINATION_ORDER_TO_HQL

protected static final com.google.common.base.Function<org.nuiton.util.pagination.PaginationOrder,String> PAGINATION_ORDER_TO_HQL

batchSize

protected int batchSize

Default batch size used to iterate on data.

Since:

2.6.14

topiaJpaSupport

protected TopiaJpaSupport topiaJpaSupport

topiaHibernateSupport

protected TopiaHibernateSupport topiaHibernateSupport

topiaSqlSupport

protected TopiaSqlSupport topiaSqlSupport

topiaIdFactory

protected TopiaIdFactory topiaIdFactory

topiaFiresSupport

protected TopiaFiresSupport topiaFiresSupport

topiaDaoSupplier

protected TopiaDaoSupplier topiaDaoSupplier

Constructor Detail

AbstractTopiaDao

public AbstractTopiaDao()

Method Detail

getTopiaEntityEnum

public abstract TopiaEntityEnum getTopiaEntityEnum()

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(TopiaJpaSupport topiaJpaSupport,
        TopiaHibernateSupport topiaHibernateSupport,
        TopiaSqlSupport topiaSqlSupport,
        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()

newFromClause

protected String newFromClause(String alias)

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>

initPagination

public org.nuiton.util.pagination.PaginationResult<E> initPagination(int pageSize)

Description copied from interface: TopiaDao

Creates a new pager initialized for the first page of all data of the dao.

Note: This method will execute a count query to init the pager.

Specified by:

initPagination in interface TopiaDao<E extends TopiaEntity>

Parameters:

pageSize - size of a page

Returns:

the initialized pager.

initPagination

public org.nuiton.util.pagination.PaginationResult<E> initPagination(String hql,
                                                            Map<String,Object> params,
                                                            int pageSize)

Description copied from interface: TopiaDao

Creates a new pager initialized for the first page of data of the given query.

Note: This method will execute a count query to init the pager.

Specified by:

initPagination in interface TopiaDao<E extends TopiaEntity>

Parameters:

hql - query

params - params of the query

pageSize - size of a page

Returns:

the initialized pager.

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.InnerTopiaQueryBuilderRunQueryStep<E> forHql(String hql)

forHql

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

forHql

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

forAll

public AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forAll()

Description copied from interface: TopiaDao

Creates a QueryBuilder without restriction

Specified by:

forAll in interface TopiaDao<E extends TopiaEntity>

forProperties

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

Specified by:

forProperties in interface TopiaDao<E extends TopiaEntity>

forProperties

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

Specified by:

forProperties in interface TopiaDao<E extends TopiaEntity>

newQueryBuilder

public AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<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,
                                                  Collection<?> propertyValues)

Specified by:

forIn in interface TopiaDao<E extends TopiaEntity>

exists

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

count

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

findUnique

protected <O> O findUnique(String hql,
               Map<String,Object> hqlParameters)
                throws TopiaNoResultException,
                       TopiaNonUniqueResultException

Throws:

TopiaNoResultException

TopiaNonUniqueResultException

tryFindUnique

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

Throws:

TopiaNonUniqueResultException

findUniqueOrNull

protected <O> O findUniqueOrNull(String hql,
                     Map<String,Object> hqlParameters)
                      throws TopiaNonUniqueResultException

Throws:

TopiaNonUniqueResultException

findFirst

protected <O> O findFirst(String hql,
              Map<String,Object> hqlParameters)
               throws QueryMissingOrderException

Throws:

QueryMissingOrderException

tryFindFirst

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

Throws:

QueryMissingOrderException

findFirstOrNull

protected <O> O findFirstOrNull(String hql,
                    Map<String,Object> hqlParameters)
                     throws QueryMissingOrderException

Throws:

QueryMissingOrderException

findAny

protected <O> O findAny(String hql,
            Map<String,Object> hqlParameters)
             throws TopiaNoResultException

Throws:

TopiaNoResultException

tryFindAny

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

findAnyOrNull

protected <O> O findAnyOrNull(String hql)

findAnyOrNull

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

findAll

protected <O> List<O> findAll(String hql)

findAll

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

find

protected <O> List<O> find(String hql,
               int startIndex,
               int endIndex)

find

protected <O> List<O> find(String hql,
               Map<String,Object> hqlParameters,
               int startIndex,
               int endIndex)

find

protected <O> List<O> find(String hql,
               Map<String,Object> hqlParameters,
               org.nuiton.util.pagination.PaginationParameter page)

findPage

protected <O> org.nuiton.util.pagination.PaginationResult<O> findPage(String hql,
                                                          Map<String,Object> hqlParameters,
                                                          org.nuiton.util.pagination.PaginationParameter page)

findAllLazy

protected <O> Iterable<O> findAllLazy(String hql)

findAllLazy

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

findAllLazy

protected <O> Iterable<O> findAllLazy(String hql,
                          int batchSize)

findAllLazy

protected <O> Iterable<O> findAllLazy(String hql,
                          Map<String,Object> hqlParameters,
                          int batchSize)

forTopiaIdEquals

public TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forTopiaIdEquals(String topiaId)

Specified by:

forTopiaIdEquals in interface TopiaDao<E extends TopiaEntity>

forTopiaIdIn

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

Specified by:

forTopiaIdIn in interface TopiaDao<E extends TopiaEntity>

findByTopiaId

@Deprecated
public E findByTopiaId(String topiaId)
                                    throws TopiaNoResultException

Deprecated.

Description copied from interface: TopiaDao

Tries to find the entity with the given topiaId. If not found, an exception will be thrown.

IMPORTANT : The behavior of the method changes in ToPIA 3.0 because an exception is thrown if no entity found.

Specified by:

findByTopiaId in interface TopiaDao<E extends TopiaEntity>

Parameters:

topiaId - the identifier of the entity to look for

Returns:

The entity found

Throws:

TopiaNoResultException - if result is found, if you do not want an exception to be raised, use TopiaDao.tryFindByTopiaId(String)

tryFindByTopiaId

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

Deprecated.

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

hqlContainsOrderBy

protected boolean hqlContainsOrderBy(String hql)

hqlStartsWithSelect

protected boolean hqlStartsWithSelect(String hql)

hqlContainsCount

protected boolean hqlContainsCount(String hql)