org.nuiton.topia.persistence.internal.support

Class HibernateTopiaJpaSupport

java.lang.Object

org.nuiton.topia.persistence.internal.support.HibernateTopiaJpaSupport

All Implemented Interfaces:

TopiaJpaSupport

public class HibernateTopiaJpaSupport
extends Object
implements TopiaJpaSupport

This class is the Hibernate implementation of TopiaJpaSupport. It realizes the bridge between the JPA specification and the technical choice made for its implementation : Hibernate.

Since:

3.0

Author:

Arnaud Thimel (Code Lutin)

Field Summary

Fields

Modifier and Type	Field and Description
protected TopiaFiresSupport	firesSupport Object that handles each event propagation.
protected TopiaHibernateSupport	hibernateSupport Object to get Hibernate's Session, Configuration, ...
protected boolean	useFlushMode This flag permits to use (or not) the flush mode when doing queries.

Constructor Summary

Constructors

Constructor and Description
HibernateTopiaJpaSupport(TopiaHibernateSupport hibernateSupport, TopiaFiresSupport firesSupport)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkHqlParameters(Map<String,Object> parameters)
void	delete(Object object) Remove a persistent instance.
int	execute(String jpaql, Map<String,Object> parameters) Execute JPA-QL operation on data (Update, Delete).
<T> List<T>	find(String jpaql, int startIndex, int endIndex, Map<String,Object> parameters) Allow to do some JPA-QL query using the given bounds.
<T> List<T>	findAll(String jpaql, Map<String,Object> parameters) Allow to do some JPA-QL query WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity
<T> T	findUnique(String jpaql, Map<String,Object> parameters) Allow to do some JPA-QL query and return an unique result.
TopiaHibernateSupport	getHibernateSupport()
protected org.hibernate.Query	prepareQuery(String jpaql, Map<String,Object> parameters)
void	save(Object object) Persist the given transient instance, first assigning a generated identifier.
void	saveOrUpdate(Object object) Either TopiaJpaSupport.save(Object) or TopiaJpaSupport.update(Object) the given instance.
void	setUseFlushMode(boolean useFlushMode) Tells to the context if it has to use a flush mode before each query.
void	update(Object object) Update the persistent instance with the identifier of the given detached instance.

Methods inherited from class java.lang.Object

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

Field Detail

hibernateSupport

protected TopiaHibernateSupport hibernateSupport

Object to get Hibernate's Session, Configuration, ...

firesSupport

protected TopiaFiresSupport firesSupport

Object that handles each event propagation. Listeners are registered inside this instance. This instance is the persistenceContext's one.

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 when doing queries (says in method findAll(String, java.util.Map) or find(String, int, int, java.util.Map)) 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

Constructor Detail

HibernateTopiaJpaSupport

public HibernateTopiaJpaSupport(TopiaHibernateSupport hibernateSupport,
                        TopiaFiresSupport firesSupport)

Method Detail

getHibernateSupport

public TopiaHibernateSupport getHibernateSupport()

setUseFlushMode

public void setUseFlushMode(boolean useFlushMode)

Description copied from interface: TopiaJpaSupport

Tells to the context if it has to use a flush mode before each query.

By default, we use a flush mode, but in some case it costs to much doing this, that's why you can disable it setting the value to false.

Specified by:

setUseFlushMode in interface TopiaJpaSupport

Parameters:

useFlushMode - the new value to set

prepareQuery

protected org.hibernate.Query prepareQuery(String jpaql,
                               Map<String,Object> parameters)

checkHqlParameters

protected void checkHqlParameters(Map<String,Object> parameters)

findAll

public <T> List<T> findAll(String jpaql,
                  Map<String,Object> parameters)

Description copied from interface: TopiaJpaSupport

Allow to do some JPA-QL 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:

jpaql - the JPA-QL query

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The result list

findUnique

public <T> T findUnique(String jpaql,
               Map<String,Object> parameters)

Description copied from interface: TopiaJpaSupport

Allow to do some JPA-QL 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:

jpaql - the JPA-QL query

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The result instance or null

find

public <T> List<T> find(String jpaql,
               int startIndex,
               int endIndex,
               Map<String,Object> parameters)

Description copied from interface: 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:

jpaql - the JPA-QL query

startIndex - first index of entity to return

endIndex - last index of entity to return

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The result list

execute

public int execute(String jpaql,
          Map<String,Object> parameters)

Description copied from interface: TopiaJpaSupport

Execute JPA-QL operation on data (Update, Delete).

Specified by:

execute in interface TopiaJpaSupport

Parameters:

jpaql - the JPA-QL query

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The number of entities updated or deleted.

save

public void save(Object object)

Description copied from interface: TopiaJpaSupport

Persist the given transient instance, first assigning a generated identifier. This method is JPA implementation independent.

This method is "inspired" of the Hibernate's Session#save method.

Specified by:

save in interface TopiaJpaSupport

Parameters:

object - a transient instance of a persistent class

update

public void update(Object object)

Description copied from interface: TopiaJpaSupport

Update the persistent instance with the identifier of the given detached instance.

This method is "inspired" of the Hibernate's Session#update method.

Specified by:

update in interface TopiaJpaSupport

Parameters:

object - a detached instance containing updated state

saveOrUpdate

public void saveOrUpdate(Object object)

Description copied from interface: TopiaJpaSupport

Either TopiaJpaSupport.save(Object) or TopiaJpaSupport.update(Object) the given instance.

This method is "inspired" of the Hibernate's Session#saveOrUpdate method.

Specified by:

saveOrUpdate in interface TopiaJpaSupport

Parameters:

object - a transient or detached instance containing new or updated state

See Also:

TopiaJpaSupport.save(java.lang.Object), TopiaJpaSupport.update(Object object)

delete

public void delete(Object object)

Description copied from interface: TopiaJpaSupport

Remove a persistent instance.

This method is "inspired" of the Hibernate's Session#delete method.

Specified by:

delete in interface TopiaJpaSupport

Parameters:

object - the instance to be removed