org.nuiton.topia.persistence

Interface TopiaDao<E extends TopiaEntity>

All Superinterfaces:

Iterable<E>

All Known Implementing Classes:

AbstractTopiaDao

public interface TopiaDao<E extends TopiaEntity>
extends Iterable<E>

This contract represents the common operations any Dao should be able to provide as API.

Since:

3.0

Author:

bleny

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.
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
List<E>	findAll() Finds all the entities managed by this DAO.
List<String>	findAllIds() Find all the ids for the entities managed by this DAO.
Iterable<E>	findAllLazy()
Map<Class<? extends TopiaEntity>,List<? extends TopiaEntity>>	findAllUsages(E entity) Find all usages of the given entity.
E	findByTopiaId(String topiaId) Tries to find the entity with the given topiaId.
<R extends TopiaEntity> List<R>	findUsages(Class<R> type, E entity) Find usages of the given entity in the entities of the given type.
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forAll() Creates a QueryBuilder without restriction
TopiaQueryBuilderRunQueryStep<E>	forContains(String propertyName, Object propertyValue)
TopiaQueryBuilderRunQueryStep<E>	forEquals(String propertyName, Object propertyValue)
TopiaQueryBuilderRunQueryStep<E>	forIn(String propertyName, Collection<?> propertyValues)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forProperties(Map<String,Object> properties)
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>	forProperties(String propertyName, Object propertyValue, Object... otherPropertyNamesAndValues)
TopiaQueryBuilderRunQueryStep<E>	forTopiaIdEquals(String topiaId)
TopiaQueryBuilderRunQueryStep<E>	forTopiaIdIn(Collection<String> topiaIds)
List<TopiaEntity>	getAggregate(E entity)
int	getBatchSize() Obtains the batch size used to load data.
List<TopiaEntity>	getComposite(E entity)
Class<E>	getEntityClass() Return the class of the entity managed by this DAO.
E	newInstance() Create a new instance of managed entity not persisted.
TopiaPagerBean	newPager(int pageSize) Creates a new pager initialized for the first page of all data of the dao.
TopiaPagerBean	newPager(String hql, Map<String,Object> params, int pageSize) Creates a new pager initialized for the first page of data of the given query.
TopiaQueryBuilderAddCriteriaStep<E>	newQueryBuilder()
void	removeTopiaEntityListener(TopiaEntityListener listener)
void	removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)
void	setBatchSize(int batchSize) Set a new default batch size.
com.google.common.base.Optional<E>	tryFindByTopiaId(String topiaId) Tries to find the entity with the given topiaId.
E	update(E entity) Update an entity.
Iterable<E>	updateAll(Iterable<E> entities)

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getEntityClass

Class<E> getEntityClass()

Return the class of the entity managed by this DAO.

Returns:

this DAO's managed entity's class

getBatchSize

int getBatchSize()

Obtains the batch size used to load data.

Default value if 1000.

Returns:

the batch size.

Since:

2.6.14

setBatchSize

void setBatchSize(int batchSize)

Set a new default batch size.

Parameters:

batchSize - new batch size to use when iterating.

Since:

2.6.14

newInstance

E newInstance()

Create a new instance of managed entity not persisted.

Since:

2.3.1

newPager

TopiaPagerBean newPager(int pageSize)

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.

Parameters:

pageSize - size of a page

Returns:

the initialized pager.

Since:

3.0

newPager

TopiaPagerBean newPager(String hql,
                      Map<String,Object> params,
                      int pageSize)

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.

Parameters:

hql - query

params - params of the query

pageSize - size of a page

Returns:

the initialized pager.

Since:

3.0

create

E create(E entity)

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

Parameters:

entity - the instance to persist

Returns:

the persisted entity (with its topiaId valued)

Since:

2.3.1

create

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

Since:

3.0

create

E create(Map<String,Object> properties)

Creates a new instance of the entity managed by the DAO

Parameters:

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

Returns:

the newly created entity

Throws:

IllegalArgumentException - if some property type is not the expected one

create

E create()

Since:

3.0

update

E update(E entity)

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

Parameters:

entity - the entity to create or update

Returns:

the given entity

delete

void delete(E entity)

Deletes the given entity from the storage

Parameters:

entity - the entity to remove

deleteAll

void deleteAll(Iterable<E> entities)

Deletes all given entities from the storage

Parameters:

entities - entities to delete

Since:

3.0

findAll

List<E> findAll()

Finds all the entities managed by this DAO.

Returns:

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

findAllLazy

Iterable<E> findAllLazy()

Since:

3.0

createAll

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

Since:

3.0

updateAll

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

Since:

3.0

findAllIds

List<String> findAllIds()

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

Returns:

the ids of all the entities

count

long count()

Count the number of existing entities.

Returns:

number of total entities

Since:

2.3.4

forAll

TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forAll()

Creates a QueryBuilder without restriction

Since:

3.0

forProperties

TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forProperties(Map<String,Object> properties)

Since:

3.0

forProperties

TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forProperties(String propertyName,
                                                          Object propertyValue,
                                                          Object... otherPropertyNamesAndValues)

Since:

3.0

newQueryBuilder

TopiaQueryBuilderAddCriteriaStep<E> newQueryBuilder()

Since:

3.0

forContains

TopiaQueryBuilderRunQueryStep<E> forContains(String propertyName,
                                           Object propertyValue)

Since:

3.0

forEquals

TopiaQueryBuilderRunQueryStep<E> forEquals(String propertyName,
                                         Object propertyValue)

Since:

3.0

forIn

TopiaQueryBuilderRunQueryStep<E> forIn(String propertyName,
                                     Collection<?> propertyValues)

Since:

3.0

forTopiaIdEquals

TopiaQueryBuilderRunQueryStep<E> forTopiaIdEquals(String topiaId)

Since:

3.0

findByTopiaId

E findByTopiaId(String topiaId)
                                    throws TopiaNoResultException

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.

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 tryFindByTopiaId(String)

tryFindByTopiaId

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

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

Parameters:

topiaId - the identifier of the entity to look for

Returns:

The entity found wrapped by an Optional

Since:

3.0

forTopiaIdIn

TopiaQueryBuilderRunQueryStep<E> forTopiaIdIn(Collection<String> topiaIds)

Since:

3.0

addTopiaEntityListener

void addTopiaEntityListener(TopiaEntityListener listener)

addTopiaEntityVetoable

void addTopiaEntityVetoable(TopiaEntityVetoable vetoable)

removeTopiaEntityListener

void removeTopiaEntityListener(TopiaEntityListener listener)

removeTopiaEntityVetoable

void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)

findUsages

<R extends TopiaEntity> List<R> findUsages(Class<R> type,
                                         E entity)

Find usages of the given entity in the entities of the given type.

Type Parameters:

R - type of entity to search

Parameters:

type - the type of entity to search

entity - the entity on which search is done

Returns:

the list of entities R which uses the given entity

Since:

2.3.0

findAllUsages

Map<Class<? extends TopiaEntity>,List<? extends TopiaEntity>> findAllUsages(E entity)

Find all usages of the given entity.

Parameters:

entity - the entity

Returns:

the dictionnary of usages of the given entities (keys are entity usage container, values are the list of this type of entity to use the given entity).

Since:

2.3.0

getComposite

List<TopiaEntity> getComposite(E entity)

Parameters:

entity - the entity on which search is done

Returns:

all objects that must be deleted if this object is deleted

Since:

3.0

getAggregate

List<TopiaEntity> getAggregate(E entity)

Parameters:

entity - the entity on which search is done

Returns:

all objects that are aggregate with this instance, aggregate object are not removed automatically

Since:

3.0