org.nuiton.topia.persistence.internal

Class AbstractTopiaPersistenceContext

java.lang.Object

org.nuiton.topia.persistence.internal.AbstractTopiaPersistenceContext

All Implemented Interfaces:

TopiaReplicationSupport, TopiaDaoSupplier, TopiaPersistenceContext, TopiaReplicationDestination, TopiaTransaction

public abstract class AbstractTopiaPersistenceContext
extends Object
implements TopiaPersistenceContext

Abstract implementation of the TopiaPersistenceContext. This class will be extended by a generated one in order to generate getXxxDao methods.

Since:

3.0

Author:

Arnaud Thimel : thimel@codelutin.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractTopiaPersistenceContext.InternalTopiaHibernateSupport This subclass of TopiaHibernateSupport is made to be used only internally within this persistence context.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed Flog used to check if this persistence context is closed
protected Map<Class<? extends TopiaEntity>,TopiaDao<? extends TopiaEntity>>	daoCache Already loaded DAO cache within this persistence context
protected TopiaFiresSupport	firesSupport
protected AbstractTopiaPersistenceContext.InternalTopiaHibernateSupport	hibernateSupport This subclass of TopiaHibernateSupport is made to be used only internally within this persistence context.
protected HibernateTopiaReplicationSupport	hibernateTopiaReplicationSupport
protected TopiaJpaSupport	jpaSupport This instance of TopiaJpaSupport is created by the persistence context itself.
protected TopiaListenableSupport	listenableSupport
protected TopiaHibernateSessionRegistry	sessionRegistry The shared instance of TopiaHibernateSessionRegistry
protected TopiaSqlSupport	sqlSupport This instance of TopiaSqlSupport is created by the persistence context itself.
protected TopiaIdFactory	topiaIdFactory Used to affect a new topiaId when create is called.

Constructor Summary

Constructors

Constructor and Description
AbstractTopiaPersistenceContext(HibernateProvider hibernateProvider, TopiaListenableSupport listenableSupport, TopiaIdFactory topiaIdFactory, TopiaHibernateSessionRegistry sessionRegistry) Creating a new TopiaPersistenceContext is equivalent to creating a new transaction

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkNotClosed()
void	close() Closes the PersistenceContext.
void	commit() Applies all the modifications made to this context on the persistence device.
void	delete(TopiaEntity entity) Delete into this TopiaContext an entity created by another TopiaContext
<E extends TopiaEntity> void	deleteAll(Iterable<E> entities) Delete into this TopiaContext an entities created by another TopiaContext
<E extends TopiaEntity> E	findByTopiaId(String topiaId) Retrieve TopiaEntity using its unique topiaId.
<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.
protected TopiaFiresSupport	getFiresSupport()
TopiaHibernateSupport	getHibernateSupport()
protected HibernateTopiaReplicationSupport	getHibernateTopiaReplicationSupport()
TopiaSqlSupport	getSqlSupport()
TopiaFiresSupport	getTopiaFiresSupport() Get the currently configured TopiaFiresSupport.
TopiaIdFactory	getTopiaIdFactory() Get the currently configured TopiaIdFactory.
boolean	isClosed() Tells if the context is closed
void	replicate(TopiaEntity entity) Must replicate given entity in current database
void	replicate(TopiaReplicationDestination topiaReplicationDestination, Object... entityAndCondition) Makes a replication of some entities from this context to the given context without any entity modification.
<T extends TopiaEntity> void	replicateEntities(TopiaReplicationDestination topiaReplicationDestination, 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(TopiaReplicationDestination topiaReplicationDestination, T entity) Replicate a given entity from this context to the given context.
void	rollback() Cancels all the modifications made to this context, coming back to the state when this transaction has been created (using TopiaApplicationContext.newPersistenceContext()) or previously rollbacked (using the current method).
protected void	startTransaction()
void	update(TopiaEntity entity) Add into this TopiaContext an entity created by another TopiaContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

daoCache

protected Map<Class<? extends TopiaEntity>,TopiaDao<? extends TopiaEntity>> daoCache

Already loaded DAO cache within this persistence context

hibernateTopiaReplicationSupport

protected HibernateTopiaReplicationSupport hibernateTopiaReplicationSupport

listenableSupport

protected TopiaListenableSupport listenableSupport

topiaIdFactory

protected TopiaIdFactory topiaIdFactory

Used to affect a new topiaId when create is called.

sessionRegistry

protected TopiaHibernateSessionRegistry sessionRegistry

The shared instance of TopiaHibernateSessionRegistry

firesSupport

protected TopiaFiresSupport firesSupport

hibernateSupport

protected AbstractTopiaPersistenceContext.InternalTopiaHibernateSupport hibernateSupport

This subclass of TopiaHibernateSupport is made to be used only internally within this persistence context. This instance is created by the persistence context itself.

jpaSupport

protected TopiaJpaSupport jpaSupport

This instance of TopiaJpaSupport is created by the persistence context itself. It is actually using the TopiaHibernateSupport instance.

sqlSupport

protected TopiaSqlSupport sqlSupport

This instance of TopiaSqlSupport is created by the persistence context itself. It is actually using the TopiaHibernateSupport instance.

closed

protected boolean closed

Flog used to check if this persistence context is closed

Constructor Detail

AbstractTopiaPersistenceContext

public AbstractTopiaPersistenceContext(HibernateProvider hibernateProvider,
                               TopiaListenableSupport listenableSupport,
                               TopiaIdFactory topiaIdFactory,
                               TopiaHibernateSessionRegistry sessionRegistry)

Creating a new TopiaPersistenceContext is equivalent to creating a new transaction

Parameters:

hibernateProvider - holds the Hibernate configuration and session factory

listenableSupport - the listenableSupport instance to use within this persistence context

topiaIdFactory - the TopiaIdFactory instance created according to the application's configuration

Method Detail

getFiresSupport

protected TopiaFiresSupport getFiresSupport()

getHibernateSupport

public TopiaHibernateSupport getHibernateSupport()

getSqlSupport

public TopiaSqlSupport getSqlSupport()

getTopiaIdFactory

public TopiaIdFactory getTopiaIdFactory()

Description copied from interface: TopiaPersistenceContext

Get the currently configured TopiaIdFactory.

Specified by:

getTopiaIdFactory in interface TopiaPersistenceContext

Returns:

the TopiaIdFactory in use

See Also:

TopiaIdFactory

getTopiaFiresSupport

public TopiaFiresSupport getTopiaFiresSupport()

Description copied from interface: TopiaPersistenceContext

Get the currently configured TopiaFiresSupport.

Specified by:

getTopiaFiresSupport in interface TopiaPersistenceContext

Returns:

the TopiaFiresSupport in use

See Also:

TopiaFiresSupport

startTransaction

protected void startTransaction()
                         throws TopiaException

Throws:

TopiaException

checkNotClosed

protected void checkNotClosed()

findByTopiaId

public <E extends TopiaEntity> E findByTopiaId(String topiaId)

Description copied from interface: TopiaPersistenceContext

Retrieve TopiaEntity using its unique topiaId.

Specified by:

findByTopiaId in interface TopiaPersistenceContext

Parameters:

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

Returns:

the entity found or null

update

public void update(TopiaEntity entity)

Description copied from interface: TopiaPersistenceContext

Add into this TopiaContext an entity created by another TopiaContext

Specified by:

update in interface TopiaPersistenceContext

Parameters:

entity - the entity to add

delete

public void delete(TopiaEntity entity)

Description copied from interface: TopiaPersistenceContext

Delete into this TopiaContext an entity created by another TopiaContext

Specified by:

delete in interface TopiaPersistenceContext

Parameters:

entity - the entity to delete

deleteAll

public <E extends TopiaEntity> void deleteAll(Iterable<E> entities)

Description copied from interface: TopiaPersistenceContext

Delete into this TopiaContext an entities created by another TopiaContext

Specified by:

deleteAll in interface TopiaPersistenceContext

Parameters:

entities - the entities to delete

getDao

public <E extends TopiaEntity> TopiaDao<E> getDao(Class<E> entityClass)

Description copied from interface: TopiaDaoSupplier

Get Dao for specified class. If the specialized Dao exists then it is returned otherwise a TopiaException will be thrown.

Specified by:

getDao in interface TopiaDaoSupplier

Parameters:

entityClass - type of entity

Returns:

the expected dao

getDao

public <E extends TopiaEntity,D extends TopiaDao<E>> D getDao(Class<E> entityClass,
                                                     Class<D> daoClass)

Description copied from interface: TopiaDaoSupplier

Get Dao for specified class. If the specialized Dao exists then it is returned otherwise a TopiaException will be thrown.

Specified by:

getDao in interface TopiaDaoSupplier

Parameters:

entityClass - type of entity

daoClass - the concrete dao class to use

Returns:

the expected dao

commit

public void commit()

Description copied from interface: TopiaTransaction

Applies all the modifications made to this context on the persistence device.

Once commit is done, a new internal transaction is started, but you do not have to get a new instance of TopiaTransaction.

Specified by:

commit in interface TopiaTransaction

rollback

public void rollback()

Description copied from interface: TopiaTransaction

Cancels all the modifications made to this context, coming back to the state when this transaction has been created (using TopiaApplicationContext.newPersistenceContext()) or previously rollbacked (using the current method).

Once rollback is done, a new internal transaction is started, but you do not have to get a new instance of TopiaTransaction.

Specified by:

rollback in interface TopiaTransaction

isClosed

public boolean isClosed()

Description copied from interface: TopiaPersistenceContext

Tells if the context is closed

Specified by:

isClosed in interface TopiaPersistenceContext

Returns:

true if the context is closed, false otherwise

close

public void close()

Description copied from interface: TopiaPersistenceContext

Closes the PersistenceContext. After calling close, it's impossible to make any operation on the database.

Specified by:

close in interface TopiaPersistenceContext

getHibernateTopiaReplicationSupport

protected HibernateTopiaReplicationSupport getHibernateTopiaReplicationSupport()

replicate

public void replicate(TopiaEntity entity)

Description copied from interface: TopiaReplicationDestination

Must replicate given entity in current database

Specified by:

replicate in interface TopiaReplicationDestination

Parameters:

entity - the remote entity to replicate

replicateEntities

public <T extends TopiaEntity> void replicateEntities(TopiaReplicationDestination topiaReplicationDestination,
                                             List<T> entities)
                       throws IllegalArgumentException

Description copied from interface: TopiaReplicationSupport

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

Specified by:

replicateEntities in interface TopiaReplicationSupport

Parameters:

topiaReplicationDestination - the destination context

entities - the list of entities instance to replicate

Throws:

IllegalArgumentException - if one of the context is closed or if trying to replicate within the same database

replicateEntity

public <T extends TopiaEntity> void replicateEntity(TopiaReplicationDestination topiaReplicationDestination,
                                           T entity)
                     throws IllegalArgumentException

Description copied from interface: TopiaReplicationSupport

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

Specified by:

replicateEntity in interface TopiaReplicationSupport

Parameters:

topiaReplicationDestination - the destination context

entity - the entity instance to replicate

Throws:

IllegalArgumentException - if one of the context is closed or if trying to replicate within the same database

replicate

public void replicate(TopiaReplicationDestination topiaReplicationDestination,
             Object... entityAndCondition)
               throws IllegalArgumentException

Description copied from interface: 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 TopiaReplicationSupport.replicateEntities(TopiaReplicationDestination, java.util.List).

Specified by:

replicate in interface TopiaReplicationSupport

Parameters:

topiaReplicationDestination - 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:

IllegalArgumentException - if one of the context is closed or if trying to replicate within the same database