org.jadira.usertype.spi.repository

Class JpaBaseRepository<T extends Serializable,ID extends Serializable>

java.lang.Object

org.jadira.usertype.spi.repository.JpaSearchRepository<T,ID>

org.jadira.usertype.spi.repository.JpaBaseRepository<T,ID>

Type Parameters:

T - Entity type that this Repository handles

ID - The type that identifies the ID column for the supported entity type

All Implemented Interfaces:

BaseRepository<T,ID>, SearchRepository<T,ID>

public abstract class JpaBaseRepository<T extends Serializable,ID extends Serializable>
extends JpaSearchRepository<T,ID>
implements BaseRepository<T,ID>

Base implementation of a Repository / type-safe DAO using Hibernate JPA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JpaBaseRepository()

Method Summary

Modifier and Type	Method and Description
T	evict(T entity) Evicts the supplied entity from the session.
protected ID	extractId(T entity) Determines the ID for the entity
void	flush() Synchronises the state of EntityManager for this repository with the database
void	lock(T entity, javax.persistence.LockModeType lockMode) Lock an entity instance that is contained in the persistence context with the specified lock mode type.
T	persist(T entity) Persists the given entity.
T	refresh(T entity) Refresh the supplied entity from the database, overriding its state where changed.
void	remove(ID entityId) Removes the given entity from the database, cascading as appropriate.

Methods inherited from class org.jadira.usertype.spi.repository.JpaSearchRepository

clear, findById, getEntityClass, getEntityManager, getIdClass, getSingleResult, setEntityManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jadira.usertype.spi.repository.SearchRepository

clear, findById

Constructor Detail

JpaBaseRepository

protected JpaBaseRepository()

Method Detail

extractId

protected ID extractId(T entity)

Determines the ID for the entity

Parameters:

entity - The entity to retrieve the ID for

Returns:

The ID

persist

public T persist(T entity)

Persists the given entity. Normally, you will assign the result of the persist operation back to the original object reference. The implementation of persist in this object model will perform a no-op or merge if required. This means you do not need to consider whether an entity has been already persisted or is detached when calling this method. This is especially useful with multi-tier applications.

Specified by:

persist in interface BaseRepository<T extends Serializable,ID extends Serializable>

Parameters:

entity - The entity to be persisted

Returns:

The entity, persisted

remove

public void remove(ID entityId)

Removes the given entity from the database, cascading as appropriate. The implementation of persist in this object model will perform a merge in the case of an unattached entity. This means you do not need to consider whether an entity is detached when calling this method. This is especially useful with multi-tier applications.

Specified by:

remove in interface BaseRepository<T extends Serializable,ID extends Serializable>

Parameters:

entityId - The ID for the entity to be removed

refresh

public T refresh(T entity)

Refresh the supplied entity from the database, overriding its state where changed. In the case of a detached entity a merge will be first performed. Therefore you must assign the result of this method always back to the original object reference.

Specified by:

refresh in interface BaseRepository<T extends Serializable,ID extends Serializable>

Parameters:

entity - The entity to be refreshed.

Returns:

The entity, refreshed

evict

public T evict(T entity)

Evicts the supplied entity from the session. Therefore, during flush, the entity will not be synchronised. you must assign the result of this method always back to the original object reference, as in the case of a detached entity, a merge will be first performed, meaning that the evicted entity returned will be a copy.

Specified by:

evict in interface BaseRepository<T extends Serializable,ID extends Serializable>

Parameters:

entity - The entity to be evicted.

Returns:

The entity, evicted

flush

public void flush()

Synchronises the state of EntityManager for this repository with the database

Specified by:

flush in interface BaseRepository<T extends Serializable,ID extends Serializable>

lock

public void lock(T entity,
                 javax.persistence.LockModeType lockMode)

Lock an entity instance that is contained in the persistence context with the specified lock mode type.

Specified by:

lock in interface BaseRepository<T extends Serializable,ID extends Serializable>

Parameters:

entity - The entity to be locked.

lockMode - The LockModeType

See Also:

EntityManager.lock(Object, LockModeType)