org.nuiton.topia

Interface TopiaContext

All Superinterfaces:

TopiaHibernateSupport, TopiaJpaSupport, TopiaListenableSupport, TopiaPersistenceContext, TopiaReplicationSupport, TopiaServiceSupport, TopiaSqlSupport, TopiaTransaction

All Known Subinterfaces:

TopiaContextImplementor

All Known Implementing Classes:

AbstractTopiaContext

public interface TopiaContext
extends TopiaTransaction, TopiaListenableSupport, TopiaSqlSupport, TopiaJpaSupport, TopiaPersistenceContext, TopiaServiceSupport, TopiaReplicationSupport, TopiaHibernateSupport

The TopiaContext is the most important class of ToPIA. It contains all the methods to manipulate data : transaction management, entities querying, event firing, schema management, services management, ...

To get an instance of TopiaContext, see TopiaContextFactory.getContext(java.util.Properties)

Created: 3 janv. 2006 21:18:34

Version:

$Id: TopiaContext.java 2790 2013-08-05 08:49:05Z athimel $

Author:

poussin , tchemit , athimel

Method Summary

Methods

Modifier and Type	Method and Description
void	add(TopiaEntity e) Deprecated. use TopiaPersistenceContext.update(org.nuiton.topia.persistence.TopiaEntity)
void	addPropertyChangeListener(PropertyChangeListener listener) Deprecated. use method from TopiaListenableSupport
void	addTopiaContextListener(TopiaContextListener listener) Deprecated. Use addTopiaSchemaListener
void	addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	addTopiaEntityListener(Class<? extends TopiaEntity> entityClass, TopiaEntityListener listener) Deprecated. use method from TopiaListenableSupport
void	addTopiaEntityListener(TopiaEntityListener listener) Deprecated. use method from TopiaListenableSupport
void	addTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass, TopiaEntityVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	addTopiaEntityVetoable(TopiaEntityVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	addTopiaTransactionListener(TopiaTransactionListener listener) Deprecated. use method from TopiaListenableSupport
void	addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	backup(File file, boolean compress) Deprecated. Only H2 compatible : remove it, or move to another class
TopiaContext	beginTransaction() Deprecated. we need another method that returns a TopiaTransaction only. This method doesn't exist yet
void	clear(boolean dropDatabase) Deprecated. Only H2 compatible : remove it, or move to another class
void	clearCache() Deprecated. use TopiaHibernateSupport#getHibernateSession().clear()
void	closeContext() Deprecated. use method from TopiaTransaction
void	commitTransaction() Deprecated. use method from TopiaTransaction
void	createSchema() Deprecated. use methods from TopiaPersistenceContext
int	execute(String hql, Object... propertyNamesAndValues) Deprecated. use method from TopiaJpaSupport
void	executeSQL(String sqlScript) Deprecated. use method from TopiaSqlSupport
<E> List<E>	find(String hql, int startIndex, int endIndex, Object... propertyNamesAndValues) Deprecated. use method from TopiaJpaSupport
<E> List<E>	findAll(String hql, Object... propertyNamesAndValues) Deprecated. use method from TopiaJpaSupport
<E extends TopiaEntity> E	findByTopiaId(String topiaId) Deprecated. use TopiaPersistenceContext.findByTopiaId(String)
<E> E	findUnique(String hql, Object... propertyNamesAndValues) Deprecated. use method from TopiaJpaSupport
<E extends TopiaService> E	getService(Class<E> interfaceService) Deprecated. use methods from TopiaServiceSupport
boolean	isClosed() Deprecated. use method from TopiaTransaction
void	removePropertyChangeListener(PropertyChangeListener listener) Deprecated. use method from TopiaListenableSupport
void	removeTopiaContextListener(TopiaContextListener listener) Deprecated. Use removeTopiaSchemaListener
void	removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	removeTopiaEntityListener(Class<? extends TopiaEntity> entityClass, TopiaEntityListener listener) Deprecated. use method from TopiaListenableSupport
void	removeTopiaEntityListener(TopiaEntityListener listener) Deprecated. use method from TopiaListenableSupport
void	removeTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass, TopiaEntityVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	removeTopiaEntityVetoable(TopiaEntityVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	removeTopiaTransactionListener(TopiaTransactionListener listener) Deprecated. use method from TopiaListenableSupport
void	removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable) Deprecated. use method from TopiaListenableSupport
void	replicate(TopiaContext destinationContext, Object... entityAndCondition) Deprecated. use methods from TopiaReplicationSupport
<T extends TopiaEntity> void	replicateEntities(TopiaContext destinationContext, List<T> entities) Deprecated. use methods from TopiaReplicationSupport
<T extends TopiaEntity> void	replicateEntity(TopiaContext destinationContext, T entity) Deprecated. use methods from TopiaReplicationSupport
void	restore(File file) Deprecated. Only H2 compatible : remove it, or move to another class
void	rollbackTransaction() Deprecated. use method from TopiaTransaction
<E extends TopiaService> boolean	serviceEnabled(Class<E> interfaceService) Deprecated. use methods from TopiaServiceSupport
void	showCreateSchema() Deprecated. use methods from TopiaPersistenceContext
void	updateSchema() Deprecated. use methods from TopiaPersistenceContext

Methods inherited from interface org.nuiton.topia.TopiaListenableSupport

addTopiaSchemaListener, removeTopiaSchemaListener

Methods inherited from interface org.nuiton.topia.TopiaPersistenceContext

dropSchema, getConfig, getDAO, getDAO, getPersistenceClasses, getSchemaName, getTopiaIdFactory, isSchemaEmpty, isTableExists, setUseFlushMode, update

Methods inherited from interface org.nuiton.topia.TopiaServiceSupport

getServices

Methods inherited from interface org.nuiton.topia.TopiaHibernateSupport

getHibernateConfiguration, getHibernateFactory, getHibernateSession

Method Detail

beginTransaction

@Deprecated
TopiaContext beginTransaction()
                              throws TopiaException

Deprecated. we need another method that returns a TopiaTransaction only. This method doesn't exist yet

Returns a new context containing its own transaction.

Returns:

new context with transaction

Throws:

TopiaException - if any exception

commitTransaction

@Deprecated
void commitTransaction()
                       throws TopiaException

Deprecated. use method from TopiaTransaction

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 TopiaTransaction

Throws:

TopiaException - if any exception

rollbackTransaction

@Deprecated
void rollbackTransaction()
                         throws TopiaException

Deprecated. use method from TopiaTransaction

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 TopiaTransaction

Throws:

TopiaException - if any exception

closeContext

@Deprecated
void closeContext()
                  throws TopiaException

Deprecated. use method from TopiaTransaction

Closes the context. All the children contexts will be closed in the same time.

Specified by:

closeContext in interface TopiaTransaction

Throws:

TopiaException - if any exception

isClosed

@Deprecated
boolean isClosed()

Deprecated. use method from TopiaTransaction

Tells if the context is closed

Specified by:

isClosed in interface TopiaTransaction

Returns:

true if the context is closed, false otherwise

addTopiaEntityListener

@Deprecated
void addTopiaEntityListener(TopiaEntityListener listener)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

listener - the listener instance to register

addTopiaEntityListener

@Deprecated
void addTopiaEntityListener(Class<? extends TopiaEntity> entityClass,
                                     TopiaEntityListener listener)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

entityClass - the TopiaEntity's class to listen

listener - the listener instance to register

removeTopiaEntityListener

@Deprecated
void removeTopiaEntityListener(TopiaEntityListener listener)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaEntityListener about any TopiaEntity from the context

Specified by:

removeTopiaEntityListener in interface TopiaListenableSupport

Parameters:

listener - the listener instance to unregister

removeTopiaEntityListener

@Deprecated
void removeTopiaEntityListener(Class<? extends TopiaEntity> entityClass,
                                        TopiaEntityListener listener)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaEntityListener about the given entity class from the context

Specified by:

removeTopiaEntityListener in interface TopiaListenableSupport

Parameters:

entityClass - the listened TopiaEntity's class

listener - the listener instance to unregister

addTopiaEntityVetoable

@Deprecated
void addTopiaEntityVetoable(TopiaEntityVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

vetoable - the vetoable instance to register

addTopiaEntityVetoable

@Deprecated
void addTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass,
                                     TopiaEntityVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

entityClass - the TopiaEntity's class to listen

vetoable - the vetoable instance to register

removeTopiaEntityVetoable

@Deprecated
void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaEntityVetoable about any TopiaEntity from the context

Specified by:

removeTopiaEntityVetoable in interface TopiaListenableSupport

Parameters:

vetoable - the vetoable instance to unregister

removeTopiaEntityVetoable

@Deprecated
void removeTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass,
                                        TopiaEntityVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaEntityVetoable about the given entity class from the context

Specified by:

removeTopiaEntityVetoable in interface TopiaListenableSupport

Parameters:

entityClass - the listened TopiaEntity's class

vetoable - the vetoable instance to unregister

addTopiaEntitiesVetoable

@Deprecated
void addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

Register to the context a TopiaEntitiesVetoable about any TopiaEntity. vetoable instance will be notified BEFORE any entity load

Specified by:

addTopiaEntitiesVetoable in interface TopiaListenableSupport

Parameters:

vetoable - the vetoable instance to register

removeTopiaEntitiesVetoable

@Deprecated
void removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaEntitiesVetoable about any TopiaEntity from the context

Specified by:

removeTopiaEntitiesVetoable in interface TopiaListenableSupport

Parameters:

vetoable - the vetoable instance to unregister

addTopiaTransactionListener

@Deprecated
void addTopiaTransactionListener(TopiaTransactionListener listener)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

listener - the listener instance to register

removeTopiaTransactionListener

@Deprecated
void removeTopiaTransactionListener(TopiaTransactionListener listener)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaTransactionListener about the transaction from the context

Specified by:

removeTopiaTransactionListener in interface TopiaListenableSupport

Parameters:

listener - the listener instance to unregister

addTopiaTransactionVetoable

@Deprecated
void addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

vetoable - the vetoable instance to register

removeTopiaTransactionVetoable

@Deprecated
void removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)

Deprecated. use method from TopiaListenableSupport

Unregister the given TopiaTransactionVetoable about the transaction from the context

Specified by:

removeTopiaTransactionVetoable in interface TopiaListenableSupport

Parameters:

vetoable - the vetoable instance to unregister

addPropertyChangeListener

@Deprecated
void addPropertyChangeListener(PropertyChangeListener listener)

Deprecated. use method from TopiaListenableSupport

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 TopiaListenableSupport

Parameters:

listener - the listener instance to register

removePropertyChangeListener

@Deprecated
void removePropertyChangeListener(PropertyChangeListener listener)

Deprecated. use method from TopiaListenableSupport

Unregister the given PropertyChangeListener about some entity's property change from the context

Specified by:

removePropertyChangeListener in interface TopiaListenableSupport

Parameters:

listener - the listener instance to unregister

addTopiaContextListener

@Deprecated
void addTopiaContextListener(TopiaContextListener listener)

Deprecated. Use addTopiaSchemaListener

Register to the context a TopiaContextListener about any schema modification. listener instance will be notified BEFORE and AFTER any change on the schema

Parameters:

listener - the listener instance to register

removeTopiaContextListener

@Deprecated
void removeTopiaContextListener(TopiaContextListener listener)

Deprecated. Use removeTopiaSchemaListener

Unregister the given TopiaContextListener about any schema modification from the context

Parameters:

listener - the listener instance to unregister

findByTopiaId

@Deprecated
<E extends TopiaEntity> E findByTopiaId(String topiaId)
                                    throws TopiaException

Deprecated. use TopiaPersistenceContext.findByTopiaId(String)

Retrieve TopiaEntity using its unique id.

Specified by:

findByTopiaId in interface TopiaPersistenceContext

Parameters:

topiaId - unique identifier of the entity in all the application.

Returns:

the entity found or null

Throws:

TopiaException - for errors on retrieving the entity

add

@Deprecated
void add(TopiaEntity e)
         throws TopiaException

Deprecated. use TopiaPersistenceContext.update(org.nuiton.topia.persistence.TopiaEntity)

Add into this TopiaContext an entity created by another TopiaContext

Parameters:

e - the entity to add

Throws:

TopiaException - if any exception

clearCache

@Deprecated
void clearCache()
                throws TopiaException

Deprecated. use TopiaHibernateSupport#getHibernateSession().clear()

Clear persistence implementation cache.

Throws:

TopiaException

Since:

2.6.13

findAll

@Deprecated
<E> List<E> findAll(String hql,
                             Object... propertyNamesAndValues)
                throws TopiaException

Deprecated. use method from TopiaJpaSupport

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 TopiaJpaSupport

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

@Deprecated
<E> List<E> find(String hql,
                          int startIndex,
                          int endIndex,
                          Object... propertyNamesAndValues)
             throws TopiaException

Deprecated. use method from TopiaJpaSupport

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 TopiaJpaSupport

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

@Deprecated
<E> E findUnique(String hql,
                          Object... propertyNamesAndValues)
             throws TopiaException

Deprecated. use method from TopiaJpaSupport

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 TopiaJpaSupport

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

@Deprecated
int execute(String hql,
                     Object... propertyNamesAndValues)
            throws TopiaException

Deprecated. use method from TopiaJpaSupport

Execute HQL operation on data (Update, Delete).

Specified by:

execute in interface TopiaJpaSupport

Parameters:

hql - the HQL query

propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]

Returns:

The number of entities updated or deleted.

Throws:

TopiaException - if any exception

executeSQL

@Deprecated
void executeSQL(String sqlScript)
                throws TopiaException

Deprecated. use method from TopiaSqlSupport

Execute a given sql code inside this transaction.

Specified by:

executeSQL in interface TopiaSqlSupport

Parameters:

sqlScript - the sql script to execute

Throws:

TopiaException - if any problem occurred while executing the sql script.

createSchema

@Deprecated
void createSchema()
                  throws TopiaException

Deprecated. use methods from TopiaPersistenceContext

Triggers database schema creation

Specified by:

createSchema in interface TopiaPersistenceContext

Throws:

TopiaException - if any exception

showCreateSchema

@Deprecated
void showCreateSchema()
                      throws TopiaException

Deprecated. use methods from TopiaPersistenceContext

Displays the SQL queries that would be used for a schema creation

Specified by:

showCreateSchema in interface TopiaPersistenceContext

Throws:

TopiaException - if any exception

updateSchema

@Deprecated
void updateSchema()
                  throws TopiaException

Deprecated. use methods from TopiaPersistenceContext

Triggers database schema update

Specified by:

updateSchema in interface TopiaPersistenceContext

Throws:

TopiaException - if any exception

serviceEnabled

@Deprecated
<E extends TopiaService> boolean serviceEnabled(Class<E> interfaceService)

Deprecated. use methods from TopiaServiceSupport

Return true if specific service is available.

Specified by:

serviceEnabled in interface TopiaServiceSupport

Type Parameters:

E - type of service

Parameters:

interfaceService - fqn of the service

Returns:

the service

getService

@Deprecated
<E extends TopiaService> E getService(Class<E> interfaceService)
                                  throws TopiaNotFoundException

Deprecated. use methods from TopiaServiceSupport

Return the service. This service must be valid with public static final SERVICE_NAME property.

Specified by:

getService in interface TopiaServiceSupport

Type Parameters:

E - type of service

Parameters:

interfaceService - class of the service

Returns:

the service

Throws:

TopiaNotFoundException - if service can't be retrieved

replicate

@Deprecated
void replicate(TopiaContext destinationContext,
                        Object... entityAndCondition)
               throws TopiaException,
                      IllegalArgumentException

Deprecated. use methods from TopiaReplicationSupport

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 replicateEntities(TopiaContext, List).

Specified by:

replicate in interface TopiaReplicationSupport

Parameters:

destinationContext - 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

@Deprecated
<T extends TopiaEntity> void replicateEntity(TopiaContext destinationContext,
                                                      T entity)
                     throws TopiaException,
                            IllegalArgumentException

Deprecated. use methods from TopiaReplicationSupport

Replicate a given entity from this context to the given context.

Specified by:

replicateEntity in interface TopiaReplicationSupport

Type Parameters:

T - type of the entity to replicate

Parameters:

destinationContext - 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

@Deprecated
<T extends TopiaEntity> void replicateEntities(TopiaContext destinationContext,
                                                        List<T> entities)
                       throws TopiaException,
                              IllegalArgumentException

Deprecated. use methods from TopiaReplicationSupport

Makes a replication of some entities from this context to the given context without any entity modification.

Specified by:

replicateEntities in interface TopiaReplicationSupport

Type Parameters:

T - type of the entities to replicate

Parameters:

destinationContext - 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

backup

@Deprecated
void backup(File file,
                     boolean compress)
            throws TopiaException

Deprecated. Only H2 compatible : remove it, or move to another class

Sauve la base de données dans un format natif a la base, la representation n'est pas portable d'une base a l'autre. Cette methode ne doit être utilisé que pour un stockage temporaire utile à une application.

Parameters:

file - le nom du fichier ou stocker les informations

compress - si vrai compress le fichier avec gzip

Throws:

TopiaException - if any exception

restore

@Deprecated
void restore(File file)
             throws TopiaException

Deprecated. Only H2 compatible : remove it, or move to another class

l'inverse de la methode backup(File, boolean).

Parameters:

file - le fichier ou prendre les informations, il peut-etre compressé avec gzip ou non.

Throws:

TopiaException - if any exception

clear

@Deprecated
void clear(boolean dropDatabase)
           throws TopiaException

Deprecated. Only H2 compatible : remove it, or move to another class

Supprime toutes les tables et autres elements de la database.

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