TopiaDAOImpl (ToPIA :: Persistence 3.0-alpha-3 API)

java.lang.Object
- org.nuiton.topia.persistence.TopiaDAOImpl<E>

Type Parameters:
E - le type de l'entite

All Implemented Interfaces:

Iterable<E>, TopiaDAO<E>
```
public class TopiaDAOImpl<E extends TopiaEntity>
extends Object
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: TopiaDAOImpl.java 2789 2013-08-05 08:22:58Z tchemit $

Author:

bpoussin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TopiaDAOImpl.FindAllIterator<E extends TopiaEntity,R>

Nested Classes
Modifier and Type	Class and Description
`static class`	`TopiaDAOImpl.FindAllIterator<E extends TopiaEntity,R>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected TopiaContext`	`context` Underlying context used by this dao to do actions on db.
`protected Class<E>`	`entityClass` Type of entity managed by this dao.
`protected TopiaFiresSupport`	`topiaFiresSupport`

Constructor Summary

Constructors
Constructor and Description

TopiaDAOImpl()

Constructors
Constructor and Description
`TopiaDAOImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTopiaEntityListener(TopiaEntityListener listener)`
`void`	`addTopiaEntityVetoable(TopiaEntityVetoable vetoable)`
`void`	`computeAndAddRecordsToPager(String hql, TopiaPagerBean pager, Object... propertyNamesAndValues)` Execute the count `hql` query and then synch the pager to this result (says fill the `PagerBean.records` field and then adapt the number of pages available and the current number page).
`long`	`count()` Count the number of existing entities.
`long`	`countByQuery(String hql, Object... propertyNamesAndValues)` Count the number of entities based on a the given HQL query.
`E`	`create(E entity)` Creates an entity not created without the DAO.
`E`	`create(Map<String,Object> properties)` Cette methode appelle fireVetoableCreate et fireOnCreated Si vous la surchargé, faites attention a appeler le super ou a appeler vous aussi ces deux methodes.
`E`	`create(Object... propertyNamesAndValues)` Creates a new instance of the entity managed by the DAO
`String`	`createSimpleQuery(String alias)` Create the simple HQL query for the entity managed by the dao.
`void`	`delete(E e)` Removes the given entity from the storage
`void`	`deleteAll(Iterable<E> entities)` Permet de supprimer des entités.
`boolean`	`existByProperties(String propertyName, Object propertyValue, Object... propertyNamesAndValues)` Check the existence of an entity with `propertyName` with `propertyValue`.
`boolean`	`existByTopiaId(String id)` Check the existence of an entity with technical `id`.
`boolean`	`existsByQuery(String hql, Object... propertyNamesAndValues)` Check the existence of an entity using the given HQL query.
`List<E>`	`findAll()` Finds all the entities managed by this DAO.
`List<E>`	`findAllByProperties(Map<String,Object> properties)` Finds all entities E matching all the `properties` values.
`List<E>`	`findAllByProperties(String propertyName, Object value, Object... propertyNamesAndValues)` Finds all entities E matching the given `propertyName`, `value` AND all other properties
`List<E>`	`findAllByProperty(String propertyName, Object value)` Finds all entities E which value for the given `propertyName` is `value`
`<R> List<R>`	`findAllByQuery(Class<R> type, String hql, Object... propertyNamesAndValues)` Gets all entities when executing the given select query for the given `type` which may not be a entity type (int, long, map,...).
`List<E>`	`findAllByQuery(String hql, Object... propertyNamesAndValues)` Finds all entities E when executing the given HQL query.
`<R> List<R>`	`findAllByQueryAndPager(Class<R> type, String hql, TopiaPagerBean pager, Object... propertyNamesAndValues)` Finds a page of entities R of the given select `hql` query using the `pager` to obtain the window of entities to return.
`List<E>`	`findAllByQueryAndPager(String hql, TopiaPagerBean pager, Object... propertyNamesAndValues)` Gets a page of entities E of the given select `hql` query using the `pager` to obtain the window of entities to return.
`<R> List<R>`	`findAllByQueryWithBound(Class<R> type, String hql, int startIndex, int endIndex, Object... propertyNamesAndValues)` Finds a page of entities R when executing the given select query for the dao entity type (will only return the window of `startIndex - endIndex` entities).
`List<E>`	`findAllByQueryWithBound(String hql, int startIndex, int endIndex, Object... propertyNamesAndValues)` Finds a page of entities E when executing the given select query for the dao entity type (will only return the window of `startIndex - endIndex` entities).
`List<E>`	`findAllContains(String propertyName, Object value)` Find all the entities E which given collection (propertyName) contains the given value
`List<String>`	`findAllIds()` Find all the ids for the E entity type
`<R> Iterable<R>`	`findAllLazyByQuery(Class<R> type, int batchSize, String hql, Object... propertyNamesAndValues)` Finds all entities R in lazy mode when executing the given select query for the given `type` which may not be a entity type (int, long, map,...).
`<R> Iterable<R>`	`findAllLazyByQuery(Class<R> type, String hql, Object... propertyNamesAndValues)` Finds all entities R in lazy mode when executing the given select query for the given `type` which may not be a entity type (int, long, map,...).
`Iterable<E>`	`findAllLazyByQuery(int batchSize, String hql, Object... propertyNamesAndValues)` Finds all entities E in lazy mode when executing the given select query for the dao entity type.
`Iterable<E>`	`findAllLazyByQuery(String hql, Object... propertyNamesAndValues)` Finds all entities E in lazy mode when executing the given select query for the dao entity type.
`Map<Class<? extends TopiaEntity>,List<? extends TopiaEntity>>`	`findAllUsages(E e)` Find all usages of the given `entity`.
`List<E>`	`findAllWithOrder(String... propertyNames)` Finds all entites E managed by this DAO.
`E`	`findByPrimaryKey(Map<String,Object> keys)` Find an entity using the natural ids.
`E`	`findByPrimaryKey(Object... k)` Find an entity using the natural ids.
`E`	`findByProperties(Map<String,Object> properties)` Find an entity matching `properties`.
`E`	`findByProperties(String propertyName, Object value, Object... propertyNamesAndValues)` Find an entity matching a succession of propertyName + value arguments.
`E`	`findByProperty(String propertyName, Object value)` Find an entity matching `value` for the given `propertyName`.
`<R> R`	`findByQuery(Class<R> type, String hql, Object... params)` Executes and returns the result (entity R) of the given HQL query string.
`E`	`findByQuery(String hql, Object... propertyNamesAndValues)` Executes and returns the result (entity E) of the given HQL query string.
`E`	`findByTopiaId(String id)` Find an entity corresponding to the `id`.
`E`	`findContains(String propertyName, Object value)` Find the first entity which given collection (propertyName) contains the given value
`<U extends TopiaEntity> List<U>`	`findUsages(Class<U> type, E e)` Find usages of the given `entity` in the entities of the given `type`.
`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.
`TopiaContextImplementor`	`getContext()` Returns the context used by this DAO.
`Class<E>`	`getEntityClass()` Return the class of the entity managed by this DAO.
`protected Serializable`	`getId(E e)` Retourne l'id de l'entity
`protected Serializable`	`getId(Map map)` Retourne l'id de l'entity representer comme une map
`List<Permission>`	`getRequestPermission(String topiaId, int actions)` Retourne les permissions a verifier pour l'acces a l'entite pour le service Taas.
`protected org.hibernate.Session`	`getSession()` Renvoie la Session contenue dans le contexte
`TopiaContext`	`getTopiaContext()` Returns the context used by this DAO.
`TopiaEntityEnum`	`getTopiaEntityEnum()` Get the entityEnum of the type of entity managed by this DAO.
`protected TopiaFiresSupport`	`getTopiaFiresSupport()`
`void`	`init(TopiaContext context, Class<E> entityClass, TopiaFiresSupport topiaFiresSupport)` When AbstractTopiaContext create the TopiaDAOHibernate, it must call this method just after.
`Iterator<E>`	`iterator()`
`E`	`newInstance()` Create a new instance of managed entity not persisted.
`void`	`removeTopiaEntityListener(TopiaEntityListener listener)`
`void`	`removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)`
`void`	`setBatchSize(int batchSize)` Set a new default batch size.
`E`	`update(E e)` Update an entity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - entityClass
```
protected Class<E extends TopiaEntity> entityClass
```
    Type of entity managed by this dao.
    
    Since:
    
    ever
  - context
```
protected TopiaContext context
```
    Underlying context used by this dao to do actions on db.
    
    Since:
    
    ever
  - topiaFiresSupport
```
protected TopiaFiresSupport topiaFiresSupport
```
- Constructor Detail
  - TopiaDAOImpl
```
public TopiaDAOImpl()
```
- Method Detail
  - getTopiaEntityEnum
```
public 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 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
  - 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.
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E extends TopiaEntity>
  - getId
```
protected Serializable getId(E e)
                      throws TopiaException
```
    Retourne l'id de l'entity
    
    Parameters:
    e - l'entity
    
    Returns:
    l'id de l'entity ou null si pas trouvé
    
    Throws:
    
    TopiaException - Si une erreur survient durant la recherche
  - getId
```
protected Serializable getId(Map map)
                      throws TopiaException
```
    Retourne l'id de l'entity representer comme une map
    
    Parameters:
    map - l'entity en representation map
    
    Returns:
    l'id de l'entity ou null si pas trouvé
    
    Throws:
    
    TopiaException - Si une erreur survient durant la recherche
  - init
```
public void init(TopiaContext context,
        Class<E> entityClass,
        TopiaFiresSupport topiaFiresSupport)
          throws TopiaException
```
    When AbstractTopiaContext create the TopiaDAOHibernate, it must call this method just after.
    
    Parameters:
    entityClass -
    
    Throws:
    
    TopiaException
  - getContext
```
public TopiaContextImplementor getContext()
```
    Description copied from interface: TopiaDAO
    
    Returns the context used by this DAO.
    
    Specified by:
    
    getContext in interface TopiaDAO<E extends TopiaEntity>
    
    Returns:
    Returns the context.
  - getTopiaContext
```
public TopiaContext getTopiaContext()
```
    Description copied from interface: TopiaDAO
    
    Returns the context used by this DAO.
    
    Specified by:
    
    getTopiaContext in interface TopiaDAO<E extends TopiaEntity>
    
    Returns:
    Returns the context.
  - getTopiaFiresSupport
```
protected TopiaFiresSupport getTopiaFiresSupport()
```
  - createSimpleQuery
```
public String createSimpleQuery(String alias)
```
    Description copied from interface: TopiaDAO
    Create the simple HQL query for the entity managed by the dao.
    A optional alias can be passed:
```
FROM MyEntityImpl myAlias
```
    Specified by:
    
    createSimpleQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    alias - optional alias to use in query
    
    Returns:
    the hql query
  - newInstance
```
public E newInstance()
                                  throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Create a new instance of managed entity not persisted.
    
    Specified by:
    
    newInstance in interface TopiaDAO<E extends TopiaEntity>
    
    Returns:
    new entity instance
    
    Throws:
    
    TopiaException - if any pb while creating the entity
  - findUsages
```
public <U extends TopiaEntity> List<U> findUsages(Class<U> type,
                                         E e)
                                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find usages of the given entity in the entities of the given type.
    
    Specified by:
    
    findUsages in interface TopiaDAO<E extends TopiaEntity>
    
    Type Parameters:
    U - type of entity to search
    Parameters:
    type - the type of entity to search
    e - the entity on which search is done
    
    Returns:
    the list of entities R which uses the given entity
    
    Throws:
    
    TopiaException - if any problem while getting data
  - findAllUsages
```
public Map<Class<? extends TopiaEntity>,List<? extends TopiaEntity>> findAllUsages(E e)
                                                                            throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find all usages of the given entity.
    
    Specified by:
    
    findAllUsages in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    e - 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).
    
    Throws:
    
    TopiaException - if any pb while getting data
  - getRequestPermission
```
public List<Permission> getRequestPermission(String topiaId,
                                    int actions)
                                      throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Retourne les permissions a verifier pour l'acces a l'entite pour le service Taas.
    
    Specified by:
    
    getRequestPermission in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    topiaId - topiaId d'une entite
    actions - encoded actions
    
    Returns:
    la liste des permissions
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - 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)
                             throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Creates an entity not created without the DAO. Generally used when DAO is layered after a service layer where the TopiaDAO.create(Object...) would be to onerous.
    
    Specified by:
    
    create in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    entity - the instance to persist
    
    Returns:
    the persisted entity (with its topiaId valued)
    
    Throws:
    
    TopiaException - if any problem while creating data
  - create
```
public E create(Object... propertyNamesAndValues)
                             throws TopiaException
```
    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:
    propertyNamesAndValues - the list of properties that the created entity will have. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the newly created entity
    
    Throws:
    
    TopiaException - if any problem during instantiation
    See Also:
    TopiaDAO.create(Map)
  - create
```
public E create(Map<String,Object> properties)
                             throws TopiaException
```
    Cette methode appelle fireVetoableCreate et fireOnCreated Si vous la surchargé, faites attention a appeler le super ou a appeler vous aussi ces deux methodes.
    
    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
    
    Throws:
    
    TopiaException - if any problem during instantiation
  - update
```
public E update(E e)
                             throws TopiaException
```
    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:
    e - the entity to create or update
    
    Returns:
    the given entity
    
    Throws:
    
    TopiaException - if any problem while updating datas
  - delete
```
public void delete(E e)
            throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Removes the given entity from the storage
    
    Specified by:
    
    delete in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    e - the entity to remove
    
    Throws:
    
    TopiaException - if any problem while deleting datas
  - deleteAll
```
public void deleteAll(Iterable<E> entities)
               throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Permet de supprimer des entités.
    
    Specified by:
    
    deleteAll in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    entities - les entités à supprimer
    
    Throws:
    
    TopiaException - if any pb while deleting datas
  - findByTopiaId
```
public E findByTopiaId(String id)
                                    throws TopiaException
```
    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>
    
    Parameters:
    id - topiaId of the entity to found
    
    Returns:
    the entity found or null if not
    
    Throws:
    
    TopiaException - for Topia errors on query
  - findByProperty
```
public E findByProperty(String propertyName,
               Object value)
                                     throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find an entity matching value for the given propertyName.
    
    Specified by:
    
    findByProperty in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - property name to filter
    value - value of the property to match
    
    Returns:
    the first entity matching the request
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findByProperties
```
public E findByProperties(String propertyName,
                 Object value,
                 Object... propertyNamesAndValues)
                                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find an entity matching a succession of propertyName + value arguments.
    
    Specified by:
    
    findByProperties in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - the first property name to filter
    value - the first value of the property to match
    propertyNamesAndValues - other property names and values. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the first entity matching the request
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findByProperties
```
public E findByProperties(Map<String,Object> properties)
                                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find an entity matching properties.
    
    Specified by:
    
    findByProperties in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    properties - the properties key + value to match
    
    Returns:
    the first entity matching the request
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAll
```
public List<E> findAll()
                                    throws TopiaException
```
    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
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllIds
```
public List<String> findAllIds()
                        throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find all the ids for the E entity type
    
    Specified by:
    
    findAllIds in interface TopiaDAO<E extends TopiaEntity>
    
    Returns:
    the full list of ids
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByProperty
```
public List<E> findAllByProperty(String propertyName,
                        Object value)
                                              throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities E which value for the given propertyName is value
    
    Specified by:
    
    findAllByProperty in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - property name to use
    value - value to expect
    
    Returns:
    the list of entities E having the given value
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByProperties
```
public List<E> findAllByProperties(String propertyName,
                          Object value,
                          Object... propertyNamesAndValues)
                                                throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities E matching the given propertyName, value AND all other properties
    
    Specified by:
    
    findAllByProperties in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - property name to use
    value - value to expect
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the list of entities E having the given value
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByProperties
```
public List<E> findAllByProperties(Map<String,Object> properties)
                                                throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities E matching all the properties values.
    
    Specified by:
    
    findAllByProperties in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    properties - properties to match
    
    Returns:
    the list of entities E having the given values
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllWithOrder
```
public List<E> findAllWithOrder(String... propertyNames)
                                             throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entites E managed by this DAO. The returned list will be ordered according to the given propertyNames.
    You can add on each property ASC or DESC to force the result order (by default is ASC).
    
    Specified by:
    
    findAllWithOrder in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyNames - property names of order to apply
    
    Returns:
    all entities E of the dao entity type with given order
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findContains
```
public E findContains(String propertyName,
             Object value)
                                   throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find the first entity which given collection (propertyName) contains the given value
    
    Specified by:
    
    findContains in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - the name of the property (must be a collection)
    value - the value to use for find
    
    Returns:
    the entity E found or null
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllContains
```
public List<E> findAllContains(String propertyName,
                      Object value)
                                            throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find all the entities E which given collection (propertyName) contains the given value
    
    Specified by:
    
    findAllContains in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - the name of the property (must be a collection)
    value - the value to use for find
    
    Returns:
    all the entities E found
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - existByTopiaId
```
public boolean existByTopiaId(String id)
                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Check the existence of an entity with technical id.
    
    Specified by:
    
    existByTopiaId in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    id - unique id of the entity to test existence.
    
    Returns:
    true if entity exists, false otherwise
    
    Throws:
    
    TopiaException - for any error
  - existByProperties
```
public boolean existByProperties(String propertyName,
                        Object propertyValue,
                        Object... propertyNamesAndValues)
                          throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Check the existence of an entity with propertyName with propertyValue. others properties can be added to test existence.
    
    Specified by:
    
    existByProperties in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    propertyName - the first property name to test existence
    propertyValue - the first property value to test existence
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    true if entity exists, false otherwise
    
    Throws:
    
    TopiaException - for Topia errors
  - count
```
public long count()
           throws TopiaException
```
    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
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findByPrimaryKey
```
public E findByPrimaryKey(Map<String,Object> keys)
                                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find an entity using the natural ids. Each field of the natural id has to be present in the given Map.
    
    Specified by:
    
    findByPrimaryKey in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    keys - Map with the natural id property name as Map.key, and value as Map.value
    
    Returns:
    the entity E found or null
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findByPrimaryKey
```
public E findByPrimaryKey(Object... k)
                                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Find an entity using the natural ids. Each field of the natural id has to be present in the given Map.
    
    Specified by:
    
    findByPrimaryKey in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    k - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the entity E found or null
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - existsByQuery
```
public boolean existsByQuery(String hql,
                    Object... propertyNamesAndValues)
                      throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Check the existence of an entity using the given HQL query.
    
    Specified by:
    
    existsByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    true if entity exists, false otherwise
    
    Throws:
    
    TopiaException
  - countByQuery
```
public long countByQuery(String hql,
                Object... propertyNamesAndValues)
                  throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Count the number of entities based on a the given HQL query.
    
    Specified by:
    
    countByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query to use
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    number of entities filtered by the query
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findByQuery
```
public E findByQuery(String hql,
            Object... propertyNamesAndValues)
                                  throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Executes and returns the result (entity E) of the given HQL query string.
    
    Specified by:
    
    findByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the entity E found or null
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findByQuery
```
public <R> R findByQuery(Class<R> type,
                String hql,
                Object... params)
              throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Executes and returns the result (entity R) of the given HQL query string.
    
    Specified by:
    
    findByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    type - the expected result type
    hql - the HQL query
    params - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the entity R found or null
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByQuery
```
public List<E> findAllByQuery(String hql,
                     Object... propertyNamesAndValues)
                                           throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities E when executing the given HQL query.
    
    Specified by:
    
    findAllByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    the list of entities E found by the query and parameters
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByQuery
```
public <R> List<R> findAllByQuery(Class<R> type,
                         String hql,
                         Object... propertyNamesAndValues)
                       throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Gets all entities when executing the given select query for the given type which may not be a entity type (int, long, map,...).
    
    Specified by:
    
    findAllByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    type - the expected result type
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites of the query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllLazyByQuery
```
public Iterable<E> findAllLazyByQuery(String hql,
                             Object... propertyNamesAndValues)
                                                   throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities E in lazy mode when executing the given select query for the dao entity type.
    Important note: // TODO AThimel 20/07/13 Write the important note...
    
    Specified by:
    
    findAllLazyByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites E of the query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllLazyByQuery
```
public <R> Iterable<R> findAllLazyByQuery(Class<R> type,
                                 String hql,
                                 Object... propertyNamesAndValues)
                               throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities R in lazy mode when executing the given select query for the given type which may not be a entity type (int, long, map,...).
    Important note: // TODO AThimel 20/07/13 Write the important note...
    
    Specified by:
    
    findAllLazyByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    type - the expected result type
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites R of the query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllLazyByQuery
```
public Iterable<E> findAllLazyByQuery(int batchSize,
                             String hql,
                             Object... propertyNamesAndValues)
                                                   throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities E in lazy mode when executing the given select query for the dao entity type.
    Important note: // TODO AThimel 20/07/13 Write the important note...
    
    Specified by:
    
    findAllLazyByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    batchSize - batch size
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites E of the query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllLazyByQuery
```
public <R> Iterable<R> findAllLazyByQuery(Class<R> type,
                                 int batchSize,
                                 String hql,
                                 Object... propertyNamesAndValues)
                               throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds all entities R in lazy mode when executing the given select query for the given type which may not be a entity type (int, long, map,...).
    Important note: // TODO AThimel 20/07/13 Write the important note...
    
    Specified by:
    
    findAllLazyByQuery in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    type - the expected result type
    batchSize - batch size
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites R of the query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByQueryWithBound
```
public <R> List<R> findAllByQueryWithBound(Class<R> type,
                                  String hql,
                                  int startIndex,
                                  int endIndex,
                                  Object... propertyNamesAndValues)
                                throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds a page of entities R when executing the given select query for the dao entity type (will only return the window of startIndex - endIndex entities). // TODO AThimel 20/07/13 Reformulate(?) the "window thing"
    
    Specified by:
    
    findAllByQueryWithBound in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    type - the expected result type
    hql - the HQL query
    startIndex - first index of entity to return
    endIndex - last index of entity to return
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites R of the paginated query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByQueryWithBound
```
public List<E> findAllByQueryWithBound(String hql,
                              int startIndex,
                              int endIndex,
                              Object... propertyNamesAndValues)
                                                    throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds a page of entities E when executing the given select query for the dao entity type (will only return the window of startIndex - endIndex entities). // TODO AThimel 20/07/13 Reformulate(?) the "window thing"
    
    Specified by:
    
    findAllByQueryWithBound in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query
    startIndex - first index of entity to return
    endIndex - last index of entity to return
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entites E of the paginated query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
  - findAllByQueryAndPager
```
public <R> List<R> findAllByQueryAndPager(Class<R> type,
                                 String hql,
                                 TopiaPagerBean pager,
                                 Object... propertyNamesAndValues)
                               throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Finds a page of entities R of the given select hql query using the pager to obtain the window of entities to return.
    
    Specified by:
    
    findAllByQueryAndPager in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    type - the expected result type
    hql - the HQL query
    pager - pager to obtain the correct window of data
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entities R of the paginated query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
    See Also:
    TopiaPagerBean
  - findAllByQueryAndPager
```
public List<E> findAllByQueryAndPager(String hql,
                             TopiaPagerBean pager,
                             Object... propertyNamesAndValues)
                                                   throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Gets a page of entities E of the given select hql query using the pager to obtain the window of entities to return.
    
    Specified by:
    
    findAllByQueryAndPager in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query
    pager - pager to obtain the correct window of data
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    entities E of the paginated query result
    
    Throws:
    
    TopiaException - if any pb while getting datas
    See Also:
    TopiaPagerBean
  - computeAndAddRecordsToPager
```
public void computeAndAddRecordsToPager(String hql,
                               TopiaPagerBean pager,
                               Object... propertyNamesAndValues)
                                 throws TopiaException
```
    Description copied from interface: TopiaDAO
    
    Execute the count hql query and then synch the pager to this result (says fill the PagerBean.records field and then adapt the number of pages available and the current number page).
    
    Specified by:
    
    computeAndAddRecordsToPager in interface TopiaDAO<E extends TopiaEntity>
    
    Parameters:
    hql - the HQL query to use
    pager - pager to obtain the correct window of data
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Throws:
    
    TopiaException - if any pb while getting datas
    See Also:
    TopiaPagerBean
  - getSession
```
protected org.hibernate.Session getSession()
                                    throws TopiaException
```
    Renvoie la Session contenue dans le contexte
    
    Returns:
    hibernate session
    
    Throws:
    
    TopiaException - if any pb
  - getClassMetadata
```
protected org.hibernate.metadata.ClassMetadata getClassMetadata()
                                                         throws TopiaException
```
    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

Class TopiaDAOImpl<E extends TopiaEntity>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

entityClass

context

topiaFiresSupport

Constructor Detail

TopiaDAOImpl

Method Detail

getTopiaEntityEnum

getEntityClass

getBatchSize

setBatchSize

iterator

getId

getId

init

getContext

getTopiaContext

getTopiaFiresSupport

createSimpleQuery

newInstance

findUsages

findAllUsages

getRequestPermission

addTopiaEntityListener

addTopiaEntityVetoable

removeTopiaEntityListener

removeTopiaEntityVetoable

create

create

create

update

delete

deleteAll

findByTopiaId

findByProperty

findByProperties

findByProperties

findAll

findAllIds

findAllByProperty

findAllByProperties

findAllByProperties

findAllWithOrder

findContains

findAllContains

existByTopiaId

existByProperties

count

findByPrimaryKey

findByPrimaryKey

existsByQuery

countByQuery

findByQuery

findByQuery

findAllByQuery

findAllByQuery

findAllLazyByQuery

findAllLazyByQuery

findAllLazyByQuery

findAllLazyByQuery

findAllByQueryWithBound

findAllByQueryWithBound

findAllByQueryAndPager

findAllByQueryAndPager

computeAndAddRecordsToPager

getSession

getClassMetadata