TopiaContextImpl (ToPIA :: Persistence 3.0-alpha-1 API)

java.lang.Object
- org.nuiton.topia.framework.TopiaContextImpl

All Implemented Interfaces:

TopiaContextImplementor, TopiaContext
```
public class TopiaContextImpl
extends Object
implements TopiaContextImplementor
```
Le TopiaContextImpl est le point d'entre pour acceder aux donnees. Il est configurer par un fichier de propriete
List des proprietes disponible

topia.persistence.properties.file
le fichier de propriété a utiliser pour configurer hibernate

topia.persistence.directories
la liste des repertoires contenant les mappings hibernates (.hbm.xml) la liste de repertoire est separer par des virgules ','

topia.persistence.classes
la liste des classes que doit géré hibernate. On peut tres bien utiliser topia.persistence.directories pour un ensemble d'entié du meme repertoire et topia.persistence.classes pour d'autres classes

TopiaContextImpl.java
Created: 23 déc. 2005 16:58:50

Version:

$Id: TopiaContextImpl.java 2779 2013-07-23 14:49:44Z echatellier $

Author:

bpoussin , tchemit , fdesbois

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TopiaContextImpl.SQLWork

Nested Classes
Modifier and Type	Class and Description
`static class`	`TopiaContextImpl.SQLWork`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<TopiaContextImplementor>`	`childContext` Set of child context created with `beginTransaction()`.
`protected boolean`	`closed` Indique si le contexte a ete ferme
`protected Properties`	`config` Propriete de configuration
`protected Map<Class<? extends TopiaEntity>,TopiaDAO<? extends TopiaEntity>>`	`daoCache` cache des DAO deja chargé pour ce context
`protected TopiaFiresSupport`	`firesSupport`
`protected org.hibernate.Session`	`hibernate` La session utilisé par le TopiaContextImpl
`protected org.hibernate.cfg.Configuration`	`hibernateConfiguration` L'objet configuration utilisé pour la creation de la factory hibernate
`protected org.hibernate.SessionFactory`	`hibernateFactory` la factory permettant de recuperer la session hibernate.
`protected TopiaContextImplementor`	`parentContext` Le pere de ce context, les contexts initaux n'ont pas de context pere
`protected List<Class<?>>`	`persistenceClasses` Liste des classes perssitance
`protected Map<String,TopiaService>`	`services` key: service name; value: service instance
`protected TopiaIdFactory`	`topiaIdFactory` Used to affect a new topiaId when create is called.
`protected boolean`	`useFlushMode` This flag permits to use (or not) the flush mode when doing queries.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TopiaContextImpl()` Default constructor, useful for tests.
	`TopiaContextImpl(Properties config)` Constructor used by `TopiaContextFactory` to initialize rootContext using `config`.
`protected`	`TopiaContextImpl(TopiaContextImplementor parentContext)` Constructor used by `beginTransaction()` to instantiate child from `parentContext`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(TopiaEntity e)` Add into this TopiaContext an entity created by another TopiaContext
`protected void`	`addChildContext(TopiaContextImplementor child)`
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Register to the context a PropertyChangeListener about some entity's property change.
`void`	`addTopiaContextListener(TopiaContextListener listener)` Deprecated.
`void`	`addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)` Register to the context a TopiaEntitiesVetoable about any TopiaEntity.
`void`	`addTopiaEntityListener(Class<? extends TopiaEntity> entityClass, TopiaEntityListener listener)` Register to the context a TopiaEntityListener about the given entity class.
`void`	`addTopiaEntityListener(TopiaEntityListener listener)` Register to the context a TopiaEntityListener about any TopiaEntity.
`void`	`addTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass, TopiaEntityVetoable vetoable)` Register to the context a TopiaEntityVetoable about the given entity class.
`void`	`addTopiaEntityVetoable(TopiaEntityVetoable vetoable)` Register to the context a TopiaEntityVetoable about any TopiaEntity.
`void`	`addTopiaSchemaListener(TopiaSchemaListener listener)` Register to the context a TopiaSchemaListener about any schema modification.
`void`	`addTopiaTransactionListener(TopiaTransactionListener listener)` Register to the context a TopiaTransactionListener about the transaction.
`void`	`addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)` Register to the context a TopiaTransactionVetoable about the transaction.
`void`	`backup(File file, boolean compress)` Backup database in gzip compressed file.
`TopiaContext`	`beginTransaction()` Returns a new context containing its own transaction.
`protected String[]`	`buildQueries(Object... entityAndCondition)` Build the list of queries from the given parameter `entityAndCondition`.
`protected void`	`checkClosed(String message)`
`void`	`clear(boolean dropDatabase)` Only h2 supported for now
`void`	`clearCache()` Clear hibernate cache to free memory.
`void`	`closeContext()` Closes the context.
`void`	`commitTransaction()` Applies all the modifications made to this context on the persistence device.
`void`	`createSchema()` Triggers database schema creation
`void`	`dropSchema()` Triggers database schema drop
`void`	`evict(TopiaEntity e)` Detaches the given entity from the session
`int`	`execute(String hql, Object... propertyNamesAndValues)` Execute HQL operation on data (Update, Delete)
`void`	`executeSQL(String sqlScript)` Execute a given sql code inside this transaction.
`protected void`	`finalize()` Pour le context root on ferme tous les fils, et la factory hibernate.
`<E> List<E>`	`find(String hql, int startIndex, int endIndex, Object... propertyNamesAndValues)` Allow to do some JPA-QL query using the given bounds.
`<E> List<E>`	`findAll(String hql, Object... propertyNamesAndValues)` Allow to do some HQL query WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity
`<E extends TopiaEntity> E`	`findByTopiaId(String id)` Retrieve `TopiaEntity` using its unique `id`.
`<E> E`	`findUnique(String hql, Object... propertyNamesAndValues)` Allow to do some HQL query and return an unique result.
`Set<TopiaContextImplementor>`	`getChildContext()` Retrieve a thread-safe copy of children context set.
`Properties`	`getConfig()`
`<E extends TopiaEntity> TopiaDAO<E>`	`getDAO(Class<E> entityClass)` Get DAO for specified class.
`<E extends TopiaEntity,D extends TopiaDAO<E>> D`	`getDAO(Class<E> entityClass, Class<D> daoClass)` Get DAO for specified class.
`TopiaFiresSupport`	`getFiresSupport()`
`org.hibernate.Session`	`getHibernate()`
`org.hibernate.cfg.Configuration`	`getHibernateConfiguration()`
`org.hibernate.SessionFactory`	`getHibernateFactory()`
`TopiaContextImplementor`	`getParentContext()`
`List<Class<?>>`	`getPersistenceClasses()`
`protected String`	`getProperExceptionMessage(Throwable eee)`
`TopiaContextImplementor`	`getRootContext()`
`<E extends TopiaService> E`	`getService(Class<E> interfaceService)` Take one service, this service must be valid service interface with public static final SERVICE_NAME declaration.
`protected TopiaService`	`getService(String name)`
`protected <E extends TopiaService> String`	`getServiceName(Class<E> interfaceService)` Retrieve service name using SERVICE_NAME static field on service interface.
`Map<String,TopiaService>`	`getServices()`
`TopiaIdFactory`	`getTopiaIdFactory()`
`protected void`	`initTopiaIdFactory()`
`boolean`	`isClosed()` Tells if the context is closed
`boolean`	`isSchemaExist(Class<?> clazz)` Detect if the table is created on storage for a given persistant class.
`protected Map<String,TopiaService>`	`loadServices(Properties config)`
`protected void`	`postInitServices(Map<String,TopiaService> services)`
`protected void`	`preInitServices(Map<String,TopiaService> services)`
`void`	`removeChildContext(TopiaContextImplementor child)`
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Unregister the given PropertyChangeListener about some entity's property change from the context
`void`	`removeTopiaContextListener(TopiaContextListener listener)` Deprecated.
`void`	`removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)` Unregister the given TopiaEntitiesVetoable about any TopiaEntity from the context
`void`	`removeTopiaEntityListener(Class<? extends TopiaEntity> entityClass, TopiaEntityListener listener)` Unregister the given TopiaEntityListener about the given entity class from the context
`void`	`removeTopiaEntityListener(TopiaEntityListener listener)` Unregister the given TopiaEntityListener about any TopiaEntity from the context
`void`	`removeTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass, TopiaEntityVetoable vetoable)` Unregister the given TopiaEntityVetoable about the given entity class from the context
`void`	`removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)` Unregister the given TopiaEntityVetoable about any TopiaEntity from the context
`void`	`removeTopiaSchemaListener(TopiaSchemaListener listener)` Unregister the given TopiaSchemaListener about any schema modification from the context
`void`	`removeTopiaTransactionListener(TopiaTransactionListener listener)` Unregister the given TopiaTransactionListener about the transaction from the context
`void`	`removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)` Unregister the given TopiaTransactionVetoable about the transaction from the context
`void`	`replicate(TopiaContext dstCtxt, Object... entityAndCondition)` Makes a replication of some entities from this context to the given context without any entity modification.
`protected void`	`replicate0(TopiaContextImpl dstContextImpl, Object... entities)`
`<T extends TopiaEntity> void`	`replicateEntities(TopiaContext dstCtxt, List<T> entities)` Makes a replication of some entities from this context to the given context without any entity modification.
`<T extends TopiaEntity> void`	`replicateEntity(TopiaContext dstCtxt, T entity)` Replicate a given entity from this context to the given context.
`void`	`restore(File file)` Read database from gzip compressed file Only work for h2 database
`void`	`rollbackTransaction()` Cancels all the modifications made to this context, coming back to the state on the last beginTransaction.
`<E extends TopiaService> boolean`	`serviceEnabled(Class<E> interfaceService)` Return true if specific service is available.
`protected boolean`	`serviceEnabled(String name)`
`void`	`setUseFlushMode(boolean useFlushMode)` Change the value of flag `useFlushMode`.
`void`	`showCreateSchema()` Displays the SQL queries that would be used for a schema creation
`void`	`updateSchema()` Triggers database schema update

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

- Field Detail
  - parentContext
```
protected TopiaContextImplementor parentContext
```
    Le pere de ce context, les contexts initaux n'ont pas de context pere
  - hibernateConfiguration
```
protected org.hibernate.cfg.Configuration hibernateConfiguration
```
    L'objet configuration utilisé pour la creation de la factory hibernate
  - hibernateFactory
```
protected org.hibernate.SessionFactory hibernateFactory
```
    la factory permettant de recuperer la session hibernate. Seul les TopiaContextImpl initiaux contiennent un hibernateFactory
  - hibernate
```
protected org.hibernate.Session hibernate
```
    La session utilisé par le TopiaContextImpl
  - closed
```
protected boolean closed
```
    Indique si le contexte a ete ferme
  - useFlushMode
```
protected boolean useFlushMode
```
    This flag permits to use (or not) the flush mode when doing queries. The normal usage is to says yes (that's why the default value is true), in that case whebn doing queries (says in method findAll(String, Object...) or find(String, int, int, Object...)) it will use the flush mode FlushMode.AUTO). But sometimes, when doing a lot of queries (for some imports for example), we do NOT want the session to be flushed each time we do a find, then you can set this flag to false using the method setUseFlushMode(boolean)
    
    Since:
    
    2.5
  - config
```
protected Properties config
```
    Propriete de configuration
  - topiaIdFactory
```
protected TopiaIdFactory topiaIdFactory
```
    Used to affect a new topiaId when create is called.
    
    Since:
    
    3.0
  - daoCache
```
protected Map<Class<? extends TopiaEntity>,TopiaDAO<? extends TopiaEntity>> daoCache
```
    cache des DAO deja chargé pour ce context
  - childContext
```
protected final Set<TopiaContextImplementor> childContext
```
    Set of child context created with beginTransaction(). We are listener on these context. A WeakHashMap is used to remove old context automically when it's not used anymore. The finalize() method will be executed when Garbage collector is called when reference is removed. The set is synchronized in case of using multi-threading.
    
    See Also:
    Collections.synchronizedSet(Set), Collections.newSetFromMap(Map)
  - services
```
protected Map<String,TopiaService> services
```
    key: service name; value: service instance
  - firesSupport
```
protected TopiaFiresSupport firesSupport
```
  - persistenceClasses
```
protected List<Class<?>> persistenceClasses
```
    Liste des classes perssitance
- Constructor Detail
  - TopiaContextImpl
```
protected TopiaContextImpl()
```
    Default constructor, useful for tests.
  - TopiaContextImpl
```
public TopiaContextImpl(Properties config)
                 throws TopiaNotFoundException
```
    Constructor used by TopiaContextFactory to initialize rootContext using config.
    
    Parameters:
    config - for the new root context
    
    Throws:
    
    TopiaNotFoundException - if one of persistent class from configuration is not found
  - TopiaContextImpl
```
protected TopiaContextImpl(TopiaContextImplementor parentContext)
```
    Constructor used by beginTransaction() to instantiate child from parentContext.
    
    Parameters:
    parentContext - context parent of the new TopiaContext child
- Method Detail
  - initTopiaIdFactory
```
protected void initTopiaIdFactory()
```
  - getProperExceptionMessage
```
protected String getProperExceptionMessage(Throwable eee)
```
  - loadServices
```
protected Map<String,TopiaService> loadServices(Properties config)
```
  - preInitServices
```
protected void preInitServices(Map<String,TopiaService> services)
```
  - postInitServices
```
protected void postInitServices(Map<String,TopiaService> services)
```
  - getService
```
protected TopiaService getService(String name)
```
  - serviceEnabled
```
protected boolean serviceEnabled(String name)
```
  - getServiceName
```
protected <E extends TopiaService> String getServiceName(Class<E> interfaceService)
                         throws IllegalAccessException,
                                NoSuchFieldException
```
    Retrieve service name using SERVICE_NAME static field on service interface.
    
    Type Parameters:
    E - type of the service that extends TopiaService
    Parameters:
    interfaceService - class of the service
    
    Returns:
    the service name
    
    Throws:
    
    IllegalAccessException - if field SERVICE_NAME can't be accessed
    
    NoSuchFieldException - if no field SERVICE_NAME is defined
  - getServices
```
public Map<String,TopiaService> getServices()
```
    Specified by:
    
    getServices in interface TopiaContextImplementor
  - getService
```
public <E extends TopiaService> E getService(Class<E> interfaceService)
                                  throws TopiaNotFoundException
```
    Take one service, this service must be valid service interface with public static final SERVICE_NAME declaration.
    
    Specified by:
    
    getService in interface TopiaContext
    
    Type Parameters:
    E - type of the service that extends TopiaService
    Parameters:
    interfaceService - class of the service
    
    Returns:
    the service
    
    Throws:
    
    TopiaNotFoundException - if an error appears or service not found.
    See Also:
    getServiceName(Class)
  - serviceEnabled
```
public <E extends TopiaService> boolean serviceEnabled(Class<E> interfaceService)
```
    Description copied from interface: TopiaContext
    
    Return true if specific service is available.
    
    Specified by:
    
    serviceEnabled in interface TopiaContext
    
    Type Parameters:
    E - type of service
    Parameters:
    interfaceService - fqn of the service
    
    Returns:
    the service
  - getChildContext
```
public Set<TopiaContextImplementor> getChildContext()
```
    Description copied from interface: TopiaContextImplementor
    
    Retrieve a thread-safe copy of children context set.
    
    Specified by:
    
    getChildContext in interface TopiaContextImplementor
    
    Returns:
    Returns the childContext.
  - addChildContext
```
protected void addChildContext(TopiaContextImplementor child)
```
  - removeChildContext
```
public void removeChildContext(TopiaContextImplementor child)
```
    Specified by:
    
    removeChildContext in interface TopiaContextImplementor
  - getParentContext
```
public TopiaContextImplementor getParentContext()
```
    Specified by:
    
    getParentContext in interface TopiaContextImplementor
    
    Returns:
    Returns the parentContext.
  - getRootContext
```
public TopiaContextImplementor getRootContext()
```
    Specified by:
    
    getRootContext in interface TopiaContextImplementor
  - getConfig
```
public Properties getConfig()
```
    Specified by:
    
    getConfig in interface TopiaContextImplementor
    
    Returns:
    Returns the config.
  - getTopiaIdFactory
```
public TopiaIdFactory getTopiaIdFactory()
```
    Specified by:
    
    getTopiaIdFactory in interface TopiaContextImplementor
  - setUseFlushMode
```
public void setUseFlushMode(boolean useFlushMode)
```
    Change the value of flag useFlushMode.
    
    Specified by:
    
    setUseFlushMode in interface TopiaContextImplementor
    
    Parameters:
    useFlushMode - the new value to set
    Since:
    
    2.5
    
    See Also:
    useFlushMode
  - createSchema
```
public void createSchema()
                  throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Triggers database schema creation
    
    Specified by:
    
    createSchema in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - showCreateSchema
```
public void showCreateSchema()
                      throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Displays the SQL queries that would be used for a schema creation
    
    Specified by:
    
    showCreateSchema in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - updateSchema
```
public void updateSchema()
                  throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Triggers database schema update
    
    Specified by:
    
    updateSchema in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - dropSchema
```
public void dropSchema()
                throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Triggers database schema drop
    
    Specified by:
    
    dropSchema in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - getHibernate
```
public org.hibernate.Session getHibernate()
                                   throws TopiaException
```
    Specified by:
    
    getHibernate in interface TopiaContextImplementor
    
    Returns:
    Returns the hibernate.
    
    Throws:
    
    TopiaException - si aucune transaction n'est ouverte
  - getHibernateFactory
```
public org.hibernate.SessionFactory getHibernateFactory()
                                                 throws TopiaNotFoundException
```
    Specified by:
    
    getHibernateFactory in interface TopiaContextImplementor
    
    Returns:
    Returns the hibernateFactory.
    
    Throws:
    
    TopiaNotFoundException
  - getHibernateConfiguration
```
public org.hibernate.cfg.Configuration getHibernateConfiguration()
                                                          throws TopiaNotFoundException
```
    Specified by:
    
    getHibernateConfiguration in interface TopiaContextImplementor
    
    Returns:
    Returns the hibernate configuration
    
    Throws:
    
    TopiaNotFoundException
  - getDAO
```
public <E extends TopiaEntity> TopiaDAO<E> getDAO(Class<E> entityClass)
                                       throws TopiaException
```
    Description copied from interface: TopiaContextImplementor
    
    Get DAO for specified class. If Specialized DAO exists then it returned otherwize TopiaDAO<entityClass> is returned
    
    Specified by:
    
    getDAO in interface TopiaContextImplementor
    
    Type Parameters:
    E - type of entity
    Parameters:
    entityClass - type of entity
    
    Returns:
    the required dao
    
    Throws:
    
    TopiaException - if any error
  - getDAO
```
public <E extends TopiaEntity,D extends TopiaDAO<E>> D getDAO(Class<E> entityClass,
                                                     Class<D> daoClass)
                          throws TopiaException
```
    Description copied from interface: TopiaContextImplementor
    
    Get DAO for specified class. If Specialized DAO exists then it returned otherwize TopiaDAO<entityClass> is returned
    
    Specified by:
    
    getDAO in interface TopiaContextImplementor
    
    Type Parameters:
    E - type of entity
    Parameters:
    entityClass - type of entity
    daoClass - the concrete dao class to use
    
    Returns:
    the required dao
    
    Throws:
    
    TopiaException - if any error
  - beginTransaction
```
public TopiaContext beginTransaction()
                              throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Returns a new context containing its own transaction.
    
    Specified by:
    
    beginTransaction in interface TopiaContext
    
    Returns:
    new context with transaction
    
    Throws:
    
    TopiaException - if any exception
  - commitTransaction
```
public void commitTransaction()
                       throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Applies all the modifications made to this context on the persistence device. Once commit is done, a new transaction is started.
    
    Specified by:
    
    commitTransaction in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - rollbackTransaction
```
public void rollbackTransaction()
                         throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Cancels all the modifications made to this context, coming back to the state on the last beginTransaction. Once rollback is done, a new transaction is started.
    
    Specified by:
    
    rollbackTransaction in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - closeContext
```
public void closeContext()
                  throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Closes the context. All the children contexts will be closed in the same time.
    
    Specified by:
    
    closeContext in interface TopiaContext
    
    Throws:
    
    TopiaException - if any exception
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Pour le context root on ferme tous les fils, et la factory hibernate.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: TopiaContext
    
    Tells if the context is closed
    
    Specified by:
    
    isClosed in interface TopiaContext
    
    Returns:
    true if the context is closed, false otherwise
  - executeSQL
```
public void executeSQL(String sqlScript)
                throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Execute a given sql code inside this transaction.
    
    Specified by:
    
    executeSQL in interface TopiaContext
    
    Parameters:
    sqlScript - the sql script to execute
    
    Throws:
    
    TopiaException - if any problem occurred while executing the sql script.
  - checkClosed
```
protected void checkClosed(String message)
                    throws TopiaException
```
    Throws:
    
    TopiaException
  - findByTopiaId
```
public <E extends TopiaEntity> E findByTopiaId(String id)
                                    throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Retrieve TopiaEntity using its unique id.
    
    Specified by:
    
    findByTopiaId in interface TopiaContext
    
    Parameters:
    id - unique identifier of the entity in all the application.
    
    Returns:
    the entity found or null
    
    Throws:
    
    TopiaException - for errors on retrieving the entity
  - findAll
```
public <E> List<E> findAll(String hql,
                  Object... propertyNamesAndValues)
                throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Allow to do some HQL query
    WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity
    
    Specified by:
    
    findAll in interface TopiaContext
    
    Parameters:
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    The result list
    
    Throws:
    
    TopiaException - for any error during querying
  - find
```
public <E> List<E> find(String hql,
               int startIndex,
               int endIndex,
               Object... propertyNamesAndValues)
             throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Allow to do some JPA-QL query using the given bounds.
    No lower bound : startIndex = 0.
    No upper bound : endIndex = -1.
    WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity
    
    Specified by:
    
    find in interface TopiaContext
    
    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:
    The result list
    
    Throws:
    
    TopiaException - for any error during querying
  - findUnique
```
public <E> E findUnique(String hql,
               Object... propertyNamesAndValues)
             throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Allow to do some HQL query and return an unique result. If nothing if found by the query, will return null. If more than one result is found, will throw an exception.
    WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity
    
    Specified by:
    
    findUnique in interface TopiaContext
    
    Parameters:
    hql - the HQL query
    propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]
    
    Returns:
    The result instance or null
    
    Throws:
    
    TopiaException - for any error during querying or if the the query returns more than one result.
  - execute
```
public int execute(String hql,
          Object... propertyNamesAndValues)
            throws TopiaException
```
    Execute HQL operation on data (Update, Delete)
    
    Specified by:
    
    execute in interface TopiaContext
    
    Parameters:
    hql - HQL query
    propertyNamesAndValues - arguments for query
    
    Returns:
    The number of entities updated or deleted.
    
    Throws:
    
    TopiaException
  - add
```
public void add(TopiaEntity e)
         throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Add into this TopiaContext an entity created by another TopiaContext
    
    Specified by:
    
    add in interface TopiaContext
    
    Parameters:
    e - the entity to add
    
    Throws:
    
    TopiaException - if any exception
  - evict
```
public void evict(TopiaEntity e)
           throws TopiaException
```
    Description copied from interface: TopiaContext
    
    Detaches the given entity from the session
    
    Specified by:
    
    evict in interface TopiaContext
    
    Parameters:
    e - the entity to detach
    
    Throws:
    
    TopiaException - if any exception
  - replicate
```
public void replicate(TopiaContext dstCtxt,
             Object... entityAndCondition)
               throws TopiaException,
                      IllegalArgumentException
```
    Description copied from interface: TopiaContext
    
    Makes a replication of some entities from this context to the given context without any entity modification.
    Note: If the entityAndCondition parameter is empty, all the database will be replicated
    Note 2: The simple replication may not be sufficent. You may want to replicate only a part of some entities : use the method TopiaContext.replicateEntities(TopiaContext, List).
    
    Specified by:
    
    replicate in interface TopiaContext
    
    Parameters:
    dstCtxt - the destination context
    entityAndCondition - [key;value;...] parameter which key is the entity class to replicate, and value the "where" condition to use when querying entities
    
    Throws:
    
    TopiaException - if any problem occurred during replicate
    
    IllegalArgumentException - if one of the context is closed or if trying to replicate within the same database
  - replicateEntity
```
public <T extends TopiaEntity> void replicateEntity(TopiaContext dstCtxt,
                                           T entity)
                     throws TopiaException,
                            IllegalArgumentException
```
    Description copied from interface: TopiaContext
    
    Replicate a given entity from this context to the given context.
    
    Specified by:
    
    replicateEntity in interface TopiaContext
    
    Type Parameters:
    T - type of the entity to replicate
    Parameters:
    dstCtxt - the destination context
    entity - the entity instance to replicate
    
    Throws:
    
    TopiaException - if any problem occurred during replicate
    
    IllegalArgumentException - if one of the context is closed or if trying to replicate within the same database
  - replicateEntities
```
public <T extends TopiaEntity> void replicateEntities(TopiaContext dstCtxt,
                                             List<T> entities)
                       throws TopiaException,
                              IllegalArgumentException
```
    Description copied from interface: TopiaContext
    
    Makes a replication of some entities from this context to the given context without any entity modification.
    
    Specified by:
    
    replicateEntities in interface TopiaContext
    
    Type Parameters:
    T - type of the entities to replicate
    Parameters:
    dstCtxt - the destination context
    entities - the list of entities instance to replicate
    
    Throws:
    
    TopiaException - if any problem occurred during replicate
    
    IllegalArgumentException - if one of the context is closed or if trying to replicate within the same database
  - getFiresSupport
```
public TopiaFiresSupport getFiresSupport()
```
    Specified by:
    
    getFiresSupport in interface TopiaContextImplementor
  - backup
```
public void backup(File file,
          boolean compress)
            throws TopiaException
```
    Backup database in gzip compressed file. Note: Only works for h2 database.
    
    Specified by:
    
    backup in interface TopiaContext
    
    Parameters:
    file - file to write backup
    compress - if true then use gzip to compress file
    
    Throws:
    
    TopiaException - if any exception
    See Also:
    TopiaContext.backup(File,boolean)
  - restore
```
public void restore(File file)
             throws TopiaException
```
    Read database from gzip compressed file
    Only work for h2 database
    
    Specified by:
    
    restore in interface TopiaContext
    
    Parameters:
    file - le fichier ou prendre les informations, il peut-etre compressé avec gzip ou non.
    
    Throws:
    
    TopiaException - if any exception
    See Also:
    TopiaContext.restore(File)
  - clear
```
public void clear(boolean dropDatabase)
           throws TopiaException
```
    Only h2 supported for now
    
    Specified by:
    
    clear in interface TopiaContext
    
    Parameters:
    dropDatabase - si vrai alors supprime aussi la base de données si la base utilise des fichiers les fichiers seront supprimé (ex: h2) ou sera fait sur la base (postgresql)
    
    Throws:
    
    TopiaException - if any exception
    See Also:
    TopiaContext.clear(boolean)
  - clearCache
```
public void clearCache()
                throws TopiaException
```
    Clear hibernate cache to free memory. see http://docs.jboss.org/hibernate/orm/3.5/reference/en-US/html/transactions.html#transactions-basics-issues
    
    Specified by:
    
    clearCache in interface TopiaContext
    
    Throws:
    
    TopiaException
  - getPersistenceClasses
```
public List<Class<?>> getPersistenceClasses()
```
    Specified by:
    
    getPersistenceClasses in interface TopiaContextImplementor
  - isSchemaExist
```
public boolean isSchemaExist(Class<?> clazz)
                      throws TopiaException
```
    Description copied from interface: TopiaContextImplementor
    
    Detect if the table is created on storage for a given persistant class.
    
    Specified by:
    
    isSchemaExist in interface TopiaContextImplementor
    
    Parameters:
    clazz - the researched class
    
    Returns:
    Returns the hibernate.
    
    Throws:
    
    TopiaException - si aucune transaction n'est ouverte
  - addTopiaEntityListener
```
public void addTopiaEntityListener(TopiaEntityListener listener)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaEntityListener about any TopiaEntity. listener instance will be notified AFTER any operation on the entity.
    
    Specified by:
    
    addTopiaEntityListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to register
  - addTopiaEntityListener
```
public void addTopiaEntityListener(Class<? extends TopiaEntity> entityClass,
                          TopiaEntityListener listener)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaEntityListener about the given entity class. listener instance will be notified AFTER any operation on the entity.
    
    Specified by:
    
    addTopiaEntityListener in interface TopiaContext
    
    Parameters:
    entityClass - the TopiaEntity's class to listen
    listener - the listener instance to register
  - addTopiaEntityVetoable
```
public void addTopiaEntityVetoable(TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaEntityVetoable about any TopiaEntity. vetoable instance will be notified BEFORE any operation on the entity.
    
    Specified by:
    
    addTopiaEntityVetoable in interface TopiaContext
    
    Parameters:
    vetoable - the vetoable instance to register
  - addTopiaEntityVetoable
```
public void addTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass,
                          TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaEntityVetoable about the given entity class. vetoable instance will be notified BEFORE any operation on the entity.
    
    Specified by:
    
    addTopiaEntityVetoable in interface TopiaContext
    
    Parameters:
    entityClass - the TopiaEntity's class to listen
    vetoable - the vetoable instance to register
  - addTopiaTransactionListener
```
public void addTopiaTransactionListener(TopiaTransactionListener listener)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaTransactionListener about the transaction. listener instance will be notified AFTER any operation on the transaction.
    
    Specified by:
    
    addTopiaTransactionListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to register
  - addTopiaTransactionVetoable
```
public void addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaTransactionVetoable about the transaction. vetoable instance will be notified BEFORE any operation on the transaction.
    
    Specified by:
    
    addTopiaTransactionVetoable in interface TopiaContext
    
    Parameters:
    vetoable - the vetoable instance to register
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Description copied from interface: TopiaContext
    
    Register to the context a PropertyChangeListener about some entity's property change. listener instance will be notified AFTER any change on the entity's property
    
    Specified by:
    
    addPropertyChangeListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to register
  - addTopiaContextListener
```
@Deprecated
public void addTopiaContextListener(TopiaContextListener listener)
```
    Deprecated.
    
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaContextListener about any schema modification. listener instance will be notified BEFORE and AFTER any change on the schema
    
    Specified by:
    
    addTopiaContextListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to register
  - addTopiaSchemaListener
```
public void addTopiaSchemaListener(TopiaSchemaListener listener)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaSchemaListener about any schema modification. listener instance will be notified BEFORE and AFTER any change on the schema
    
    Specified by:
    
    addTopiaSchemaListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to register
  - removeTopiaEntityListener
```
public void removeTopiaEntityListener(TopiaEntityListener listener)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaEntityListener about any TopiaEntity from the context
    
    Specified by:
    
    removeTopiaEntityListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to unregister
  - removeTopiaEntityListener
```
public void removeTopiaEntityListener(Class<? extends TopiaEntity> entityClass,
                             TopiaEntityListener listener)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaEntityListener about the given entity class from the context
    
    Specified by:
    
    removeTopiaEntityListener in interface TopiaContext
    
    Parameters:
    entityClass - the listened TopiaEntity's class
    listener - the listener instance to unregister
  - removeTopiaEntityVetoable
```
public void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaEntityVetoable about any TopiaEntity from the context
    
    Specified by:
    
    removeTopiaEntityVetoable in interface TopiaContext
    
    Parameters:
    vetoable - the vetoable instance to unregister
  - removeTopiaEntityVetoable
```
public void removeTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass,
                             TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaEntityVetoable about the given entity class from the context
    
    Specified by:
    
    removeTopiaEntityVetoable in interface TopiaContext
    
    Parameters:
    entityClass - the listened TopiaEntity's class
    vetoable - the vetoable instance to unregister
  - removeTopiaTransactionListener
```
public void removeTopiaTransactionListener(TopiaTransactionListener listener)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaTransactionListener about the transaction from the context
    
    Specified by:
    
    removeTopiaTransactionListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to unregister
  - removeTopiaTransactionVetoable
```
public void removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaTransactionVetoable about the transaction from the context
    
    Specified by:
    
    removeTopiaTransactionVetoable in interface TopiaContext
    
    Parameters:
    vetoable - the vetoable instance to unregister
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Description copied from interface: TopiaContext
    
    Unregister the given PropertyChangeListener about some entity's property change from the context
    
    Specified by:
    
    removePropertyChangeListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to unregister
  - removeTopiaContextListener
```
@Deprecated
public void removeTopiaContextListener(TopiaContextListener listener)
```
    Deprecated.
    
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaContextListener about any schema modification from the context
    
    Specified by:
    
    removeTopiaContextListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to unregister
  - removeTopiaSchemaListener
```
public void removeTopiaSchemaListener(TopiaSchemaListener listener)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaSchemaListener about any schema modification from the context
    
    Specified by:
    
    removeTopiaSchemaListener in interface TopiaContext
    
    Parameters:
    listener - the listener instance to unregister
  - addTopiaEntitiesVetoable
```
public void addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Register to the context a TopiaEntitiesVetoable about any TopiaEntity. vetoable instance will be notified BEFORE any entity load
    
    Specified by:
    
    addTopiaEntitiesVetoable in interface TopiaContext
    
    Parameters:
    vetoable - the vetoable instance to register
  - removeTopiaEntitiesVetoable
```
public void removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)
```
    Description copied from interface: TopiaContext
    
    Unregister the given TopiaEntitiesVetoable about any TopiaEntity from the context
    
    Specified by:
    
    removeTopiaEntitiesVetoable in interface TopiaContext
    
    Parameters:
    vetoable - the vetoable instance to unregister
  - buildQueries
```
protected String[] buildQueries(Object... entityAndCondition)
                         throws TopiaException,
                                IllegalArgumentException
```
    Build the list of queries from the given parameter entityAndCondition.
    If no parameter is given, then build the queries for all entities is db, with no condition.
    
    Parameters:
    entityAndCondition - the list of tuples (Class,String)
    
    Returns:
    the list of queries.
    
    Throws:
    
    TopiaException - if any pb of db while getting entities classes.
    
    IllegalArgumentException - if any pb with the given parameter (mainly ClassCastException).
  - replicate0
```
protected void replicate0(TopiaContextImpl dstContextImpl,
              Object... entities)
                   throws TopiaException
```
    Throws:
    
    TopiaException

Class TopiaContextImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parentContext

hibernateConfiguration

hibernateFactory

hibernate

closed

useFlushMode

config

topiaIdFactory

daoCache

childContext

services

firesSupport

persistenceClasses

Constructor Detail

TopiaContextImpl

TopiaContextImpl

TopiaContextImpl

Method Detail

initTopiaIdFactory

getProperExceptionMessage

loadServices

preInitServices

postInitServices

getService

serviceEnabled

getServiceName

getServices

getService

serviceEnabled

getChildContext

addChildContext

removeChildContext

getParentContext

getRootContext

getConfig

getTopiaIdFactory

setUseFlushMode

createSchema

showCreateSchema

updateSchema

dropSchema

getHibernate

getHibernateFactory

getHibernateConfiguration

getDAO

getDAO

beginTransaction

commitTransaction

rollbackTransaction

closeContext

finalize

isClosed

executeSQL

checkClosed

findByTopiaId

findAll

find

findUnique

execute

add

evict

replicate

replicateEntity

replicateEntities

getFiresSupport

backup

restore

clear

clearCache

getPersistenceClasses

isSchemaExist

addTopiaEntityListener

addTopiaEntityListener