org.nuiton.topia.persistence
Interface TopiaDAO<Entity extends TopiaEntity>

Type Parameters:

Entity -

All Known Implementing Classes:

TopiaDAOImpl

public interface TopiaDAO<Entity extends TopiaEntity>

Author:

poussin

Method Summary

void	addTopiaEntityListener(TopiaEntityListener listener)
void	addTopiaEntityVetoable(TopiaEntityVetoable vetoable)
void	commitTransaction() Appelé lorsque le context a eu un commit de fait.
Entity	create(java.util.Map<java.lang.String,java.lang.Object> properties) Construit une nouvelle instance de l'objet géré par ce DAO
Entity	create(java.lang.Object... properties) Construit une nouvelle instance de l'objet géré par ce DAO
void	delete(Entity e)
java.util.List<Entity>	findAll()
java.util.List<Entity>	findAllByProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
java.util.List<Entity>	findAllByProperties(java.lang.String propertyName, java.lang.Object value, java.lang.Object... others)
java.util.List<Entity>	findAllByProperty(java.lang.String propertyName, java.lang.Object value)
java.util.List<Entity>	findAllContainsProperties(java.util.Map<java.lang.String,java.util.Collection> properties) Cherche et renvoie la première entité trouvée dont les propriétés en clé de Map contiennent toutes les valeurs de la Collection.
java.util.List<Entity>	findAllContainsProperties(java.lang.String propertyName, java.util.Collection values, java.lang.Object... others) Cherche et renvoie toutes les entités trouvées dont la propriété propertyName contient values, ainsi de suite avec others.
java.util.List<java.lang.String>	findAllIds() Recuperation de tous les ids en base pour le type d'entite du dao.
java.util.List<Entity>	findAllWithOrder(java.lang.String... propertyNames)
Entity	findByPrimaryKey(java.util.Map<java.lang.String,java.lang.Object> keys) Recherche la classe en utilisant la cle naturelle, chaque champs de la cle naturelle est une entre de la map passe en argument.
Entity	findByPrimaryKey(java.lang.Object... k) Recherche la classe en utilisant la cle naturelle, si la cle naturelle est composé de plusieurs champs alors les arguments passés doivent être dans l'ordre de declaration dans le fichier de mapping
Entity	findByProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
Entity	findByProperties(java.lang.String propertyName, java.lang.Object value, java.lang.Object... others)
Entity	findByProperty(java.lang.String propertyName, java.lang.Object value)
Entity	findByTopiaId(java.lang.String k)
Entity	findContainsProperties(java.util.Map<java.lang.String,java.util.Collection> properties) Cherche et renvoie la première entité trouvée dont les propriétés en clé de Map contiennent toutes les valeurs de la Collection.
Entity	findContainsProperties(java.lang.String propertyName, java.util.Collection values, java.lang.Object... others) Cherche et renvoie la première entité trouvée dont la propriété propertyName contient values, ainsi de suite avec others.
TopiaContextImplementor	getContext()
java.lang.Class<Entity>	getEntityClass() Return class of entity managed by this DAO
java.util.List<java.security.Permission>	getRequestPermission(java.lang.String topiaId, int actions) Retourne les permissions a verifier pour l'acces a l'entite pour le service Taas.
void	init(TopiaContextImplementor context, java.lang.Class<Entity> entityClass) When TopiaContextImpl create the TopiaDAOHibernate, it must call this method just after.
void	removeTopiaEntityListener(TopiaEntityListener listener)
void	removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)
void	rollbackTransaction() Appelé lorsque le context a eu un rollback de fait.
int	size() TODO modifier l'implantation pour faire un simple count sur la base
Entity	update(Entity e) Permet d'ajouter ou de mettre a jour un objet.

Method Detail

init

void init(TopiaContextImplementor context,
          java.lang.Class<Entity> entityClass)
          throws TopiaException

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

Parameters:

context - context

entityClass - entity class

Throws:

TopiaException

getEntityClass

java.lang.Class<Entity> getEntityClass()

Return class of entity managed by this DAO

Returns:

entity managed by this DAO

getContext

TopiaContextImplementor getContext()

Returns:

Returns the context.

commitTransaction

void commitTransaction()
                       throws TopiaException

Appelé lorsque le context a eu un commit de fait. TODO il faudrait peut-etre plutot faire un commit a deux phase car plusieurs type de persistence peuvent etre melangé, et il serait bien que si l'une echoué les autres echoue aussi.

Throws:

TopiaException

rollbackTransaction

void rollbackTransaction()
                         throws TopiaException

Appelé lorsque le context a eu un rollback de fait.

Throws:

TopiaException

create

Entity create(java.lang.Object... properties)
                                  throws TopiaException

Construit une nouvelle instance de l'objet géré par ce DAO

Parameters:

properties - la liste des propriétés que doit avoir l'objet créé les arguments vont par paire (propertyName, value)

Returns:

un nouvel objet

Throws:

TopiaException - si un problème est rencontré durant l'instanciation

java.lang.IllegalArgumentException - Si le nombre on le type des arguments n'est pas bon ou que le type ou le nom d'une propriété est fausse

create

Entity create(java.util.Map<java.lang.String,java.lang.Object> properties)
                                  throws TopiaException

Construit une nouvelle instance de l'objet géré par ce DAO

Parameters:

properties - la liste des propriétés que doit avoir l'objet créé

Returns:

un nouvel objet

Throws:

TopiaException - si un problème est rencontré durant l'instanciation

java.lang.IllegalArgumentException - Si le nombre on le type des arguments n'est pas bon ou que le type ou le nom d'une propriété est fausse

update

Entity update(Entity e)
                                  throws TopiaException

Permet d'ajouter ou de mettre a jour un objet. Cela permet d'ajouter par exemple un objet provenant d'un autre context mais du meme type de DAO

Parameters:

e - l'entite a ajouter ou mettre a jour

Returns:

l'entity passé en paramètre.

Throws:

TopiaException

delete

void delete(Entity e)
            throws TopiaException

Throws:

TopiaException

findByTopiaId

Entity findByTopiaId(java.lang.String k)
                                         throws TopiaException

Throws:

TopiaException

findAll

java.util.List<Entity> findAll()
                                                   throws TopiaException

Throws:

TopiaException

findAllIds

java.util.List<java.lang.String> findAllIds()
                                            throws TopiaException

Recuperation de tous les ids en base pour le type d'entite du dao.

Returns:

la liste de tous les ids

Throws:

TopiaException - si pb en base

findAllWithOrder

java.util.List<Entity> findAllWithOrder(java.lang.String... propertyNames)
                                                            throws TopiaException

Throws:

TopiaException

size

int size()
         throws TopiaException

TODO modifier l'implantation pour faire un simple count sur la base

Returns:

la taille de ?

Throws:

TopiaException

findByPrimaryKey

Entity findByPrimaryKey(java.util.Map<java.lang.String,java.lang.Object> keys)
                                            throws TopiaException

Recherche la classe en utilisant la cle naturelle, chaque champs de la cle naturelle est une entre de la map passe en argument.

Parameters:

keys - la liste des champs de la cle naturelle avec leur valeur

Returns:

l'entite trouvé

Throws:

TopiaException

findByPrimaryKey

Entity findByPrimaryKey(java.lang.Object... k)
                                            throws TopiaException

Recherche la classe en utilisant la cle naturelle, si la cle naturelle est composé de plusieurs champs alors les arguments passés doivent être dans l'ordre de declaration dans le fichier de mapping

Parameters:

k - l'objet cle naturelle de la classe

Returns:

l'entité trouvé

Throws:

TopiaException

findByProperty

Entity findByProperty(java.lang.String propertyName,
                      java.lang.Object value)
                                          throws TopiaException

Throws:

TopiaException

findByProperties

Entity findByProperties(java.lang.String propertyName,
                        java.lang.Object value,
                        java.lang.Object... others)
                                            throws TopiaException

Parameters:

propertyName -

value -

others - les autres proprietes doivent aller par 2 propertyName, value

Returns:

l'entité trouvé

Throws:

TopiaException

findByProperties

Entity findByProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
                                            throws TopiaException

Throws:

TopiaException

findAllByProperty

java.util.List<Entity> findAllByProperty(java.lang.String propertyName,
                                         java.lang.Object value)
                                                             throws TopiaException

Throws:

TopiaException

findAllByProperties

java.util.List<Entity> findAllByProperties(java.lang.String propertyName,
                                           java.lang.Object value,
                                           java.lang.Object... others)
                                                               throws TopiaException

Parameters:

propertyName -

value -

others - les autres proprietes doivent aller par 2 propertyName, value

Returns:

l'entité trouvé

Throws:

TopiaException

findAllByProperties

java.util.List<Entity> findAllByProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
                                                               throws TopiaException

Throws:

TopiaException

findContainsProperties

Entity findContainsProperties(java.util.Map<java.lang.String,java.util.Collection> properties)
                                                  throws TopiaException

Cherche et renvoie la première entité trouvée dont les propriétés en clé de Map contiennent toutes les valeurs de la Collection.

Parameters:

properties -

Returns:

l'entité trouvé

Throws:

TopiaException

findContainsProperties

Entity findContainsProperties(java.lang.String propertyName,
                              java.util.Collection values,
                              java.lang.Object... others)
                                                  throws TopiaException

Cherche et renvoie la première entité trouvée dont la propriété propertyName contient values, ainsi de suite avec others.

Parameters:

propertyName -

values -

others -

Returns:

l'entité trouvé

Throws:

TopiaException

findAllContainsProperties

java.util.List<Entity> findAllContainsProperties(java.util.Map<java.lang.String,java.util.Collection> properties)
                                                                     throws TopiaException

Cherche et renvoie la première entité trouvée dont les propriétés en clé de Map contiennent toutes les valeurs de la Collection.

Parameters:

properties -

Returns:

l'entité trouvé

Throws:

TopiaException

findAllContainsProperties

java.util.List<Entity> findAllContainsProperties(java.lang.String propertyName,
                                                 java.util.Collection values,
                                                 java.lang.Object... others)
                                                                     throws TopiaException

Cherche et renvoie toutes les entités trouvées dont la propriété propertyName contient values, ainsi de suite avec others.

Parameters:

propertyName -

values -

others -

Returns:

l'entité trouvé

Throws:

TopiaException

getRequestPermission

java.util.List<java.security.Permission> getRequestPermission(java.lang.String topiaId,
                                                              int actions)
                                                              throws TopiaException

Retourne les permissions a verifier pour l'acces a l'entite pour le service Taas.

Parameters:

topiaId - topiaId d'une entite

actions -

Returns:

la liste des permissions

Throws:

TopiaException

addTopiaEntityListener

void addTopiaEntityListener(TopiaEntityListener listener)

addTopiaEntityVetoable

void addTopiaEntityVetoable(TopiaEntityVetoable vetoable)

removeTopiaEntityListener

void removeTopiaEntityListener(TopiaEntityListener listener)

removeTopiaEntityVetoable

void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)