Class HibernateTemplate
- java.lang.Object
- org.springframework.orm.hibernate4.HibernateTemplate
- All Implemented Interfaces:
InitializingBean,HibernateOperations
public class HibernateTemplate extends Object implements HibernateOperations, InitializingBean
Helper class that simplifies Hibernate data access code. Automatically converts HibernateExceptions into DataAccessExceptions, following theorg.springframework.daoexception hierarchy.The central method is
execute, supporting Hibernate access code implementing theHibernateCallbackinterface. It provides Hibernate Session handling such that neither the HibernateCallback implementation nor the calling code needs to explicitly care about retrieving/closing Hibernate Sessions, or handling Session lifecycle exceptions. For typical single step actions, there are various convenience methods (find, load, saveOrUpdate, delete).Can be used within a service implementation via direct instantiation with a SessionFactory reference, or get prepared in an application context and given to services as bean reference. Note: The SessionFactory should always be configured as bean in the application context, in the first case given to the service directly, in the second case to the prepared template.
NOTE: Hibernate access code can also be coded in plain Hibernate style. Hence, for newly started projects, consider adopting the standard Hibernate style of coding data access objects instead, based on
SessionFactory.getCurrentSession(). This HibernateTemplate primarily exists as a migration helper for Hibernate 3 based data access code, to benefit from bug fixes in Hibernate 4.x.- Since:
- 4.0.1
- Author:
- Juergen Hoeller
- See Also:
setSessionFactory(org.hibernate.SessionFactory),HibernateCallback,Session,LocalSessionFactoryBean,HibernateTransactionManager,OpenSessionInViewFilter,OpenSessionInViewInterceptor
Constructor Summary
Constructors Constructor Description HibernateTemplate()Create a new HibernateTemplate instance.HibernateTemplate(SessionFactory sessionFactory)Create a new HibernateTemplate instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidafterPropertiesSet()Invoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.protected voidapplyNamedParameterToQuery(Query queryObject, String paramName, Object value)Apply the given name parameter to the given Query object.intbulkUpdate(String queryString, Object... values)Update/delete all objects according to the given query, binding a number of values to "?" parameters in the query string.protected voidcheckWriteOperationAllowed(Session session)Check whether write operations are allowed on the given Session.voidclear()Remove all objects from theSessioncache, and cancel all pending saves, updates and deletes.voidcloseIterator(Iterator<?> it)Immediately close anIteratorcreated by any of the variousiterate(..)operations, instead of waiting until the session is closed or disconnected.booleancontains(Object entity)Check whether the given object is in the Session cache.protected SessioncreateSessionProxy(Session session)Create a close-suppressing proxy for the given Hibernate Session.voiddelete(Object entity)Delete the given persistent instance.voiddelete(Object entity, LockMode lockMode)Delete the given persistent instance.voiddelete(String entityName, Object entity)Delete the given persistent instance.voiddelete(String entityName, Object entity, LockMode lockMode)Delete the given persistent instance.voiddeleteAll(Collection<?> entities)Delete all given persistent instances.protected voiddisableFilters(Session session)Disable the specified filters on the given Session.protected <T> TdoExecute(HibernateCallback<T> action, boolean enforceNativeSession)Execute the action specified by the given action object within a Session.FilterenableFilter(String filterName)Return an enabled HibernateFilterfor the given filter name.protected voidenableFilters(Session session)Enable the specified filters on the given Session.voidevict(Object entity)Remove the given object from theSessioncache.<T> Texecute(HibernateCallback<T> action)Execute the action specified by the given action object within aSession.<T> TexecuteWithNativeSession(HibernateCallback<T> action)Execute the action specified by the given action object within a nativeSession.List<?>find(String queryString, Object... values)Execute an HQL query, binding a number of values to "?" parameters in the query string.List<?>findByCriteria(DetachedCriteria criteria)Execute a query based on a given Hibernate criteria object.List<?>findByCriteria(DetachedCriteria criteria, int firstResult, int maxResults)Execute a query based on the given Hibernate criteria object.<T> List<T>findByExample(String entityName, T exampleEntity)Execute a query based on the given example entity object.<T> List<T>findByExample(String entityName, T exampleEntity, int firstResult, int maxResults)Execute a query based on a given example entity object.<T> List<T>findByExample(T exampleEntity)Execute a query based on the given example entity object.<T> List<T>findByExample(T exampleEntity, int firstResult, int maxResults)Execute a query based on a given example entity object.List<?>findByNamedParam(String queryString, String[] paramNames, Object[] values)Execute an HQL query, binding a number of values to ":" named parameters in the query string.List<?>findByNamedParam(String queryString, String paramName, Object value)Execute an HQL query, binding one value to a ":" named parameter in the query string.List<?>findByNamedQuery(String queryName, Object... values)Execute a named query binding a number of values to "?" parameters in the query string.List<?>findByNamedQueryAndNamedParam(String queryName, String[] paramNames, Object[] values)Execute a named query, binding a number of values to ":" named parameters in the query string.List<?>findByNamedQueryAndNamedParam(String queryName, String paramName, Object value)Execute a named query, binding one value to a ":" named parameter in the query string.List<?>findByNamedQueryAndValueBean(String queryName, Object valueBean)Execute a named query, binding the properties of the given bean to ":" named parameters in the query string.List<?>findByValueBean(String queryString, Object valueBean)Execute an HQL query, binding the properties of the given bean to named parameters in the query string.voidflush()Flush all pending saves, updates and deletes to the database.<T> Tget(Class<T> entityClass, Serializable id)Return the persistent instance of the given entity class with the given identifier, ornullif not found.<T> Tget(Class<T> entityClass, Serializable id, LockMode lockMode)Return the persistent instance of the given entity class with the given identifier, ornullif not found.Objectget(String entityName, Serializable id)Return the persistent instance of the given entity class with the given identifier, ornullif not found.Objectget(String entityName, Serializable id, LockMode lockMode)Return the persistent instance of the given entity class with the given identifier, ornullif not found.intgetFetchSize()Return the fetch size specified for this HibernateTemplate.String[]getFilterNames()Return the names of Hibernate filters to be activated, if any.intgetMaxResults()Return the maximum number of rows specified for this HibernateTemplate.StringgetQueryCacheRegion()Return the name of the cache region for queries executed by this template.SessionFactorygetSessionFactory()Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.voidinitialize(Object proxy)Force initialization of a Hibernate proxy or persistent collection.booleanisCacheQueries()Return whether to cache all queries executed by this template.booleanisCheckWriteOperations()Return whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).booleanisExposeNativeSession()Return whether to expose the native Hibernate Session to HibernateCallback code, or rather a Session proxy.Iterator<?>iterate(String queryString, Object... values)Execute a query for persistent instances, binding a number of values to "?" parameters in the query string.<T> Tload(Class<T> entityClass, Serializable id)Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.<T> Tload(Class<T> entityClass, Serializable id, LockMode lockMode)Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.voidload(Object entity, Serializable id)Load the persistent instance with the given identifier into the given object, throwing an exception if not found.Objectload(String entityName, Serializable id)Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.Objectload(String entityName, Serializable id, LockMode lockMode)Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.<T> List<T>loadAll(Class<T> entityClass)Return all persistent instances of the given entity class.voidlock(Object entity, LockMode lockMode)Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.voidlock(String entityName, Object entity, LockMode lockMode)Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.<T> Tmerge(String entityName, T entity)Copy the state of the given object onto the persistent object with the same identifier.<T> Tmerge(T entity)Copy the state of the given object onto the persistent object with the same identifier.voidpersist(Object entity)Persist the given transient instance.voidpersist(String entityName, Object entity)Persist the given transient instance.protected voidprepareCriteria(Criteria criteria)Prepare the given Criteria object, applying cache settings and/or a transaction timeout.protected voidprepareQuery(Query queryObject)Prepare the given Query object, applying cache settings and/or a transaction timeout.voidrefresh(Object entity)Re-read the state of the given persistent instance.voidrefresh(Object entity, LockMode lockMode)Re-read the state of the given persistent instance.voidreplicate(Object entity, ReplicationMode replicationMode)Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.voidreplicate(String entityName, Object entity, ReplicationMode replicationMode)Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.Serializablesave(Object entity)Persist the given transient instance.Serializablesave(String entityName, Object entity)Persist the given transient instance.voidsaveOrUpdate(Object entity)Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?).voidsaveOrUpdate(String entityName, Object entity)Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?).voidsetCacheQueries(boolean cacheQueries)Set whether to cache all queries executed by this template.voidsetCheckWriteOperations(boolean checkWriteOperations)Set whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).voidsetExposeNativeSession(boolean exposeNativeSession)Set whether to expose the native Hibernate Session to HibernateCallback code.voidsetFetchSize(int fetchSize)Set the fetch size for this HibernateTemplate.voidsetFilterNames(String... filterNames)Set one or more names of Hibernate filters to be activated for all Sessions that this accessor works with.voidsetMaxResults(int maxResults)Set the maximum number of rows for this HibernateTemplate.voidsetQueryCacheRegion(String queryCacheRegion)Set the name of the cache region for queries executed by this template.voidsetSessionFactory(SessionFactory sessionFactory)Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.voidupdate(Object entity)Update the given persistent instance, associating it with the current HibernateSession.voidupdate(Object entity, LockMode lockMode)Update the given persistent instance, associating it with the current HibernateSession.voidupdate(String entityName, Object entity)Update the given persistent instance, associating it with the current HibernateSession.voidupdate(String entityName, Object entity, LockMode lockMode)Update the given persistent instance, associating it with the current HibernateSession.
Constructor Detail
HibernateTemplate
public HibernateTemplate()
Create a new HibernateTemplate instance.
HibernateTemplate
public HibernateTemplate(SessionFactory sessionFactory)
Create a new HibernateTemplate instance.- Parameters:
sessionFactory- the SessionFactory to create Sessions with
Method Detail
setSessionFactory
public void setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
getSessionFactory
public SessionFactory getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.
setFilterNames
public void setFilterNames(String... filterNames)
Set one or more names of Hibernate filters to be activated for all Sessions that this accessor works with.Each of those filters will be enabled at the beginning of each operation and correspondingly disabled at the end of the operation. This will work for newly opened Sessions as well as for existing Sessions (for example, within a transaction).
getFilterNames
public String[] getFilterNames()
Return the names of Hibernate filters to be activated, if any.
setExposeNativeSession
public void setExposeNativeSession(boolean exposeNativeSession)
Set whether to expose the native Hibernate Session to HibernateCallback code.Default is "false": a Session proxy will be returned, suppressing
closecalls and automatically applying query cache settings and transaction timeouts.
isExposeNativeSession
public boolean isExposeNativeSession()
Return whether to expose the native Hibernate Session to HibernateCallback code, or rather a Session proxy.
setCheckWriteOperations
public void setCheckWriteOperations(boolean checkWriteOperations)
Set whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).Default is "true", for fail-fast behavior when attempting write operations within a read-only transaction. Turn this off to allow save/update/delete on a Session with flush mode MANUAL.
isCheckWriteOperations
public boolean isCheckWriteOperations()
Return whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).
setCacheQueries
public void setCacheQueries(boolean cacheQueries)
Set whether to cache all queries executed by this template.If this is "true", all Query and Criteria objects created by this template will be marked as cacheable (including all queries through find methods).
To specify the query region to be used for queries cached by this template, set the "queryCacheRegion" property.
isCacheQueries
public boolean isCacheQueries()
Return whether to cache all queries executed by this template.
setQueryCacheRegion
public void setQueryCacheRegion(String queryCacheRegion)
Set the name of the cache region for queries executed by this template.If this is specified, it will be applied to all Query and Criteria objects created by this template (including all queries through find methods).
The cache region will not take effect unless queries created by this template are configured to be cached via the "cacheQueries" property.
getQueryCacheRegion
public String getQueryCacheRegion()
Return the name of the cache region for queries executed by this template.
setFetchSize
public void setFetchSize(int fetchSize)
Set the fetch size for this HibernateTemplate. This is important for processing large result sets: Setting this higher than the default value will increase processing speed at the cost of memory consumption; setting this lower can avoid transferring row data that will never be read by the application.Default is 0, indicating to use the JDBC driver's default.
getFetchSize
public int getFetchSize()
Return the fetch size specified for this HibernateTemplate.
setMaxResults
public void setMaxResults(int maxResults)
Set the maximum number of rows for this HibernateTemplate. This is important for processing subsets of large result sets, avoiding to read and hold the entire result set in the database or in the JDBC driver if we're never interested in the entire result in the first place (for example, when performing searches that might return a large number of matches).Default is 0, indicating to use the JDBC driver's default.
getMaxResults
public int getMaxResults()
Return the maximum number of rows specified for this HibernateTemplate.
afterPropertiesSet
public void afterPropertiesSet()
Description copied from interface:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSetin interfaceInitializingBean
execute
public <T> T execute(HibernateCallback<T> action) throws DataAccessException
Description copied from interface:HibernateOperationsExecute the action specified by the given action object within aSession.Application exceptions thrown by the action object get propagated to the caller (can only be unchecked). Hibernate exceptions are transformed into appropriate DAO ones. Allows for returning a result object, that is a domain object or a collection of domain objects.
Note: Callback code is not supposed to handle transactions itself! Use an appropriate transaction manager like
HibernateTransactionManager. Generally, callback code must not touch anySessionlifecycle methods, like close, disconnect, or reconnect, to let the template do its work.- Specified by:
executein interfaceHibernateOperations- Parameters:
action- callback object that specifies the Hibernate action- Returns:
- a result object returned by the action, or
null - Throws:
DataAccessException- in case of Hibernate errors- See Also:
HibernateTransactionManager,Session
executeWithNativeSession
public <T> T executeWithNativeSession(HibernateCallback<T> action)
Execute the action specified by the given action object within a nativeSession.This execute variant overrides the template-wide
"exposeNativeSession"setting.- Parameters:
action- callback object that specifies the Hibernate action- Returns:
- a result object returned by the action, or
null - Throws:
DataAccessException- in case of Hibernate errors
doExecute
protected <T> T doExecute(HibernateCallback<T> action, boolean enforceNativeSession) throws DataAccessException
Execute the action specified by the given action object within a Session.- Parameters:
action- callback object that specifies the Hibernate actionenforceNativeSession- whether to enforce exposure of the native Hibernate Session to callback code- Returns:
- a result object returned by the action, or
null - Throws:
DataAccessException- in case of Hibernate errors
createSessionProxy
protected Session createSessionProxy(Session session)
Create a close-suppressing proxy for the given Hibernate Session. The proxy also prepares returned Query and Criteria objects.- Parameters:
session- the Hibernate Session to create a proxy for- Returns:
- the Session proxy
- See Also:
Session.close(),prepareQuery(org.hibernate.Query),prepareCriteria(org.hibernate.Criteria)
enableFilters
protected void enableFilters(Session session)
Enable the specified filters on the given Session.- Parameters:
session- the current Hibernate Session- See Also:
setFilterNames(java.lang.String...),Session.enableFilter(String)
disableFilters
protected void disableFilters(Session session)
Disable the specified filters on the given Session.- Parameters:
session- the current Hibernate Session- See Also:
setFilterNames(java.lang.String...),Session.disableFilter(String)
get
public <T> T get(Class<T> entityClass, Serializable id) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, ornullif not found.This method is a thin wrapper around
Session.get(Class, java.io.Serializable)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
getin interfaceHibernateOperations- Parameters:
entityClass- a persistent classid- the identifier of the persistent instance- Returns:
- the persistent instance, or
nullif not found - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.get(Class, java.io.Serializable)
get
public <T> T get(Class<T> entityClass, Serializable id, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, ornullif not found.Obtains the specified lock mode if the instance exists.
This method is a thin wrapper around
Session.get(Class, java.io.Serializable, LockMode)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
getin interfaceHibernateOperations- Parameters:
entityClass- a persistent classid- the identifier of the persistent instancelockMode- the lock mode to obtain- Returns:
- the persistent instance, or
nullif not found - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.get(Class, java.io.Serializable, org.hibernate.LockMode)
get
public Object get(String entityName, Serializable id) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, ornullif not found.This method is a thin wrapper around
Session.get(String, java.io.Serializable)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
getin interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityid- the identifier of the persistent instance- Returns:
- the persistent instance, or
nullif not found - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.get(Class, java.io.Serializable)
get
public Object get(String entityName, Serializable id, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, ornullif not found. Obtains the specified lock mode if the instance exists.This method is a thin wrapper around
Session.get(String, java.io.Serializable, LockMode)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
getin interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityid- the identifier of the persistent instancelockMode- the lock mode to obtain- Returns:
- the persistent instance, or
nullif not found - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.get(Class, java.io.Serializable, org.hibernate.LockMode)
load
public <T> T load(Class<T> entityClass, Serializable id) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, throwing an exception if not found.This method is a thin wrapper around
Session.load(Class, java.io.Serializable)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
loadin interfaceHibernateOperations- Parameters:
entityClass- a persistent classid- the identifier of the persistent instance- Returns:
- the persistent instance
- Throws:
ObjectRetrievalFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.load(Class, java.io.Serializable)
load
public <T> T load(Class<T> entityClass, Serializable id, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, throwing an exception if not found. Obtains the specified lock mode if the instance exists.This method is a thin wrapper around
Session.load(Class, java.io.Serializable, LockMode)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
loadin interfaceHibernateOperations- Parameters:
entityClass- a persistent classid- the identifier of the persistent instancelockMode- the lock mode to obtain- Returns:
- the persistent instance
- Throws:
ObjectRetrievalFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.load(Class, java.io.Serializable)
load
public Object load(String entityName, Serializable id) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, throwing an exception if not found.This method is a thin wrapper around
Session.load(String, java.io.Serializable)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
loadin interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityid- the identifier of the persistent instance- Returns:
- the persistent instance
- Throws:
ObjectRetrievalFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.load(Class, java.io.Serializable)
load
public Object load(String entityName, Serializable id, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsReturn the persistent instance of the given entity class with the given identifier, throwing an exception if not found.Obtains the specified lock mode if the instance exists.
This method is a thin wrapper around
Session.load(String, java.io.Serializable, LockMode)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
loadin interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityid- the identifier of the persistent instancelockMode- the lock mode to obtain- Returns:
- the persistent instance
- Throws:
ObjectRetrievalFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.load(Class, java.io.Serializable)
loadAll
public <T> List<T> loadAll(Class<T> entityClass) throws DataAccessException
Description copied from interface:HibernateOperationsReturn all persistent instances of the given entity class. Note: Use queries or criteria for retrieving a specific subset.- Specified by:
loadAllin interfaceHibernateOperations- Parameters:
entityClass- a persistent class- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- if there is a Hibernate error- See Also:
SharedSessionContract.createCriteria(java.lang.Class)
load
public void load(Object entity, Serializable id) throws DataAccessException
Description copied from interface:HibernateOperationsLoad the persistent instance with the given identifier into the given object, throwing an exception if not found.This method is a thin wrapper around
Session.load(Object, java.io.Serializable)for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.- Specified by:
loadin interfaceHibernateOperations- Parameters:
entity- the object (of the target class) to load intoid- the identifier of the persistent instance- Throws:
ObjectRetrievalFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.load(Object, java.io.Serializable)
refresh
public void refresh(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsRe-read the state of the given persistent instance.- Specified by:
refreshin interfaceHibernateOperations- Parameters:
entity- the persistent instance to re-read- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.refresh(Object)
refresh
public void refresh(Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsRe-read the state of the given persistent instance. Obtains the specified lock mode for the instance.- Specified by:
refreshin interfaceHibernateOperations- Parameters:
entity- the persistent instance to re-readlockMode- the lock mode to obtain- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.refresh(Object, org.hibernate.LockMode)
contains
public boolean contains(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsCheck whether the given object is in the Session cache.- Specified by:
containsin interfaceHibernateOperations- Parameters:
entity- the persistence instance to check- Returns:
- whether the given object is in the Session cache
- Throws:
DataAccessException- if there is a Hibernate error- See Also:
Session.contains(java.lang.Object)
evict
public void evict(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsRemove the given object from theSessioncache.- Specified by:
evictin interfaceHibernateOperations- Parameters:
entity- the persistent instance to evict- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.evict(java.lang.Object)
initialize
public void initialize(Object proxy) throws DataAccessException
Description copied from interface:HibernateOperationsForce initialization of a Hibernate proxy or persistent collection.- Specified by:
initializein interfaceHibernateOperations- Parameters:
proxy- a proxy for a persistent object or a persistent collection- Throws:
DataAccessException- if we can't initialize the proxy, for example because it is not associated with an active Session- See Also:
Hibernate.initialize(java.lang.Object)
enableFilter
public Filter enableFilter(String filterName) throws IllegalStateException
Description copied from interface:HibernateOperationsReturn an enabled HibernateFilterfor the given filter name. The returnedFilterinstance can be used to set filter parameters.- Specified by:
enableFilterin interfaceHibernateOperations- Parameters:
filterName- the name of the filter- Returns:
- the enabled Hibernate
Filter(either already enabled or enabled on the fly by this operation) - Throws:
IllegalStateException- if we are not running within a transactional Session (in which case this operation does not make sense)
lock
public void lock(Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsObtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.- Specified by:
lockin interfaceHibernateOperations- Parameters:
entity- the persistent instance to locklockMode- the lock mode to obtain- Throws:
ObjectOptimisticLockingFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.lock(Object, org.hibernate.LockMode)
lock
public void lock(String entityName, Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsObtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.- Specified by:
lockin interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to locklockMode- the lock mode to obtain- Throws:
ObjectOptimisticLockingFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.lock(String, Object, org.hibernate.LockMode)
save
public Serializable save(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsPersist the given transient instance.- Specified by:
savein interfaceHibernateOperations- Parameters:
entity- the transient instance to persist- Returns:
- the generated identifier
- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.save(Object)
save
public Serializable save(String entityName, Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsPersist the given transient instance.- Specified by:
savein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the transient instance to persist- Returns:
- the generated identifier
- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.save(String, Object)
update
public void update(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsUpdate the given persistent instance, associating it with the current HibernateSession.- Specified by:
updatein interfaceHibernateOperations- Parameters:
entity- the persistent instance to update- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.update(Object)
update
public void update(Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsUpdate the given persistent instance, associating it with the current HibernateSession.Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
- Specified by:
updatein interfaceHibernateOperations- Parameters:
entity- the persistent instance to updatelockMode- the lock mode to obtain- Throws:
ObjectOptimisticLockingFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.update(Object)
update
public void update(String entityName, Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsUpdate the given persistent instance, associating it with the current HibernateSession.- Specified by:
updatein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to update- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.update(String, Object)
update
public void update(String entityName, Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsUpdate the given persistent instance, associating it with the current HibernateSession.Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
- Specified by:
updatein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to updatelockMode- the lock mode to obtain- Throws:
ObjectOptimisticLockingFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.update(String, Object)
saveOrUpdate
public void saveOrUpdate(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsSave or update the given persistent instance, according to its id (matching the configured "unsaved-value"?). Associates the instance with the current HibernateSession.- Specified by:
saveOrUpdatein interfaceHibernateOperations- Parameters:
entity- the persistent instance to save or update (to be associated with the HibernateSession)- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.saveOrUpdate(Object)
saveOrUpdate
public void saveOrUpdate(String entityName, Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsSave or update the given persistent instance, according to its id (matching the configured "unsaved-value"?). Associates the instance with the current HibernateSession.- Specified by:
saveOrUpdatein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to save or update (to be associated with the HibernateSession)- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.saveOrUpdate(String, Object)
replicate
public void replicate(Object entity, ReplicationMode replicationMode) throws DataAccessException
Description copied from interface:HibernateOperationsPersist the state of the given detached instance according to the given replication mode, reusing the current identifier value.- Specified by:
replicatein interfaceHibernateOperations- Parameters:
entity- the persistent object to replicatereplicationMode- the Hibernate ReplicationMode- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.replicate(Object, org.hibernate.ReplicationMode)
replicate
public void replicate(String entityName, Object entity, ReplicationMode replicationMode) throws DataAccessException
Description copied from interface:HibernateOperationsPersist the state of the given detached instance according to the given replication mode, reusing the current identifier value.- Specified by:
replicatein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent object to replicatereplicationMode- the Hibernate ReplicationMode- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.replicate(String, Object, org.hibernate.ReplicationMode)
persist
public void persist(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsPersist the given transient instance. Follows JSR-220 semantics.Similar to
save, associating the given object with the current HibernateSession.- Specified by:
persistin interfaceHibernateOperations- Parameters:
entity- the persistent instance to persist- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.persist(Object),HibernateOperations.save(java.lang.Object)
persist
public void persist(String entityName, Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsPersist the given transient instance. Follows JSR-220 semantics.Similar to
save, associating the given object with the current HibernateSession.- Specified by:
persistin interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to persist- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.persist(String, Object),HibernateOperations.save(java.lang.Object)
merge
public <T> T merge(T entity) throws DataAccessException
Description copied from interface:HibernateOperationsCopy the state of the given object onto the persistent object with the same identifier. Follows JSR-220 semantics.Similar to
saveOrUpdate, but never associates the given object with the current Hibernate Session. In case of a new entity, the state will be copied over as well.Note that
mergewill not update the identifiers in the passed-in object graph (in contrast to TopLink)! Consider registering Spring'sIdTransferringMergeEventListenerif you would like to have newly assigned ids transferred to the original object graph too.- Specified by:
mergein interfaceHibernateOperations- Parameters:
entity- the object to merge with the corresponding persistence instance- Returns:
- the updated, registered persistent instance
- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.merge(Object),HibernateOperations.saveOrUpdate(java.lang.Object)
merge
public <T> T merge(String entityName, T entity) throws DataAccessException
Description copied from interface:HibernateOperationsCopy the state of the given object onto the persistent object with the same identifier. Follows JSR-220 semantics.Similar to
saveOrUpdate, but never associates the given object with the current HibernateSession. In the case of a new entity, the state will be copied over as well.Note that
mergewill not update the identifiers in the passed-in object graph (in contrast to TopLink)! Consider registering Spring'sIdTransferringMergeEventListenerif you would like to have newly assigned ids transferred to the original object graph too.- Specified by:
mergein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the object to merge with the corresponding persistence instance- Returns:
- the updated, registered persistent instance
- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.merge(String, Object),HibernateOperations.saveOrUpdate(java.lang.Object)
delete
public void delete(Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsDelete the given persistent instance.- Specified by:
deletein interfaceHibernateOperations- Parameters:
entity- the persistent instance to delete- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.delete(Object)
delete
public void delete(Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsDelete the given persistent instance.Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
- Specified by:
deletein interfaceHibernateOperations- Parameters:
entity- the persistent instance to deletelockMode- the lock mode to obtain- Throws:
ObjectOptimisticLockingFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.delete(Object)
delete
public void delete(String entityName, Object entity) throws DataAccessException
Description copied from interface:HibernateOperationsDelete the given persistent instance.- Specified by:
deletein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to delete- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.delete(Object)
delete
public void delete(String entityName, Object entity, LockMode lockMode) throws DataAccessException
Description copied from interface:HibernateOperationsDelete the given persistent instance.Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
- Specified by:
deletein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityentity- the persistent instance to deletelockMode- the lock mode to obtain- Throws:
ObjectOptimisticLockingFailureException- if not foundDataAccessException- in case of Hibernate errors- See Also:
Session.delete(Object)
deleteAll
public void deleteAll(Collection<?> entities) throws DataAccessException
Description copied from interface:HibernateOperationsDelete all given persistent instances.This can be combined with any of the find methods to delete by query in two lines of code.
- Specified by:
deleteAllin interfaceHibernateOperations- Parameters:
entities- the persistent instances to delete- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.delete(Object)
flush
public void flush() throws DataAccessException
Description copied from interface:HibernateOperationsFlush all pending saves, updates and deletes to the database.Only invoke this for selective eager flushing, for example when JDBC code needs to see certain changes within the same transaction. Else, it is preferable to rely on auto-flushing at transaction completion.
- Specified by:
flushin interfaceHibernateOperations- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.flush()
clear
public void clear() throws DataAccessException
Description copied from interface:HibernateOperationsRemove all objects from theSessioncache, and cancel all pending saves, updates and deletes.- Specified by:
clearin interfaceHibernateOperations- Throws:
DataAccessException- in case of Hibernate errors- See Also:
Session.clear()
find
public List<?> find(String queryString, Object... values) throws DataAccessException
Description copied from interface:HibernateOperationsExecute an HQL query, binding a number of values to "?" parameters in the query string.- Specified by:
findin interfaceHibernateOperations- Parameters:
queryString- a query expressed in Hibernate's query languagevalues- the values of the parameters- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.createQuery(java.lang.String)
findByNamedParam
public List<?> findByNamedParam(String queryString, String paramName, Object value) throws DataAccessException
Description copied from interface:HibernateOperationsExecute an HQL query, binding one value to a ":" named parameter in the query string.- Specified by:
findByNamedParamin interfaceHibernateOperations- Parameters:
queryString- a query expressed in Hibernate's query languageparamName- the name of the parametervalue- the value of the parameter- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.getNamedQuery(String)
findByNamedParam
public List<?> findByNamedParam(String queryString, String[] paramNames, Object[] values) throws DataAccessException
Description copied from interface:HibernateOperationsExecute an HQL query, binding a number of values to ":" named parameters in the query string.- Specified by:
findByNamedParamin interfaceHibernateOperations- Parameters:
queryString- a query expressed in Hibernate's query languageparamNames- the names of the parametersvalues- the values of the parameters- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.getNamedQuery(String)
findByValueBean
public List<?> findByValueBean(String queryString, Object valueBean) throws DataAccessException
Description copied from interface:HibernateOperationsExecute an HQL query, binding the properties of the given bean to named parameters in the query string.- Specified by:
findByValueBeanin interfaceHibernateOperations- Parameters:
queryString- a query expressed in Hibernate's query languagevalueBean- the values of the parameters- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Query.setProperties(java.lang.Object),SharedSessionContract.createQuery(java.lang.String)
findByNamedQuery
public List<?> findByNamedQuery(String queryName, Object... values) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a named query binding a number of values to "?" parameters in the query string.A named query is defined in a Hibernate mapping file.
- Specified by:
findByNamedQueryin interfaceHibernateOperations- Parameters:
queryName- the name of a Hibernate query in a mapping filevalues- the values of the parameters- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.getNamedQuery(String)
findByNamedQueryAndNamedParam
public List<?> findByNamedQueryAndNamedParam(String queryName, String paramName, Object value) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a named query, binding one value to a ":" named parameter in the query string.A named query is defined in a Hibernate mapping file.
- Specified by:
findByNamedQueryAndNamedParamin interfaceHibernateOperations- Parameters:
queryName- the name of a Hibernate query in a mapping fileparamName- the name of parametervalue- the value of the parameter- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.getNamedQuery(String)
findByNamedQueryAndNamedParam
public List<?> findByNamedQueryAndNamedParam(String queryName, String[] paramNames, Object[] values) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a named query, binding a number of values to ":" named parameters in the query string.A named query is defined in a Hibernate mapping file.
- Specified by:
findByNamedQueryAndNamedParamin interfaceHibernateOperations- Parameters:
queryName- the name of a Hibernate query in a mapping fileparamNames- the names of the parametersvalues- the values of the parameters- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.getNamedQuery(String)
findByNamedQueryAndValueBean
public List<?> findByNamedQueryAndValueBean(String queryName, Object valueBean) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a named query, binding the properties of the given bean to ":" named parameters in the query string.A named query is defined in a Hibernate mapping file.
- Specified by:
findByNamedQueryAndValueBeanin interfaceHibernateOperations- Parameters:
queryName- the name of a Hibernate query in a mapping filevalueBean- the values of the parameters- Returns:
- a
Listcontaining the results of the query execution - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Query.setProperties(java.lang.Object),SharedSessionContract.getNamedQuery(String)
findByCriteria
public List<?> findByCriteria(DetachedCriteria criteria) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query based on a given Hibernate criteria object.- Specified by:
findByCriteriain interfaceHibernateOperations- Parameters:
criteria- the detached Hibernate criteria object. Note: Do not reuse criteria objects! They need to recreated per execution, due to the suboptimal design of Hibernate's criteria facility.- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
DetachedCriteria.getExecutableCriteria(org.hibernate.Session)
findByCriteria
public List<?> findByCriteria(DetachedCriteria criteria, int firstResult, int maxResults) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query based on the given Hibernate criteria object.- Specified by:
findByCriteriain interfaceHibernateOperations- Parameters:
criteria- the detached Hibernate criteria object. Note: Do not reuse criteria objects! They need to recreated per execution, due to the suboptimal design of Hibernate's criteria facility.firstResult- the index of the first result object to be retrieved (numbered from 0)maxResults- the maximum number of result objects to retrieve (or <=0 for no limit)- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
DetachedCriteria.getExecutableCriteria(org.hibernate.Session),Criteria.setFirstResult(int),Criteria.setMaxResults(int)
findByExample
public <T> List<T> findByExample(T exampleEntity) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query based on the given example entity object.- Specified by:
findByExamplein interfaceHibernateOperations- Parameters:
exampleEntity- an instance of the desired entity, serving as example for "query-by-example"- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Example.create(Object)
findByExample
public <T> List<T> findByExample(String entityName, T exampleEntity) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query based on the given example entity object.- Specified by:
findByExamplein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityexampleEntity- an instance of the desired entity, serving as example for "query-by-example"- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Example.create(Object)
findByExample
public <T> List<T> findByExample(T exampleEntity, int firstResult, int maxResults) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query based on a given example entity object.- Specified by:
findByExamplein interfaceHibernateOperations- Parameters:
exampleEntity- an instance of the desired entity, serving as example for "query-by-example"firstResult- the index of the first result object to be retrieved (numbered from 0)maxResults- the maximum number of result objects to retrieve (or <=0 for no limit)- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Example.create(Object),Criteria.setFirstResult(int),Criteria.setMaxResults(int)
findByExample
public <T> List<T> findByExample(String entityName, T exampleEntity, int firstResult, int maxResults) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query based on a given example entity object.- Specified by:
findByExamplein interfaceHibernateOperations- Parameters:
entityName- the name of the persistent entityexampleEntity- an instance of the desired entity, serving as example for "query-by-example"firstResult- the index of the first result object to be retrieved (numbered from 0)maxResults- the maximum number of result objects to retrieve (or <=0 for no limit)- Returns:
- a
Listcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
Example.create(Object),Criteria.setFirstResult(int),Criteria.setMaxResults(int)
iterate
public Iterator<?> iterate(String queryString, Object... values) throws DataAccessException
Description copied from interface:HibernateOperationsExecute a query for persistent instances, binding a number of values to "?" parameters in the query string.Returns the results as an
Iterator. Entities returned are initialized on demand. See the Hibernate API documentation for details.- Specified by:
iteratein interfaceHibernateOperations- Parameters:
queryString- a query expressed in Hibernate's query languagevalues- the values of the parameters- Returns:
- an
Iteratorcontaining 0 or more persistent instances - Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.createQuery(java.lang.String),Query.iterate()
closeIterator
public void closeIterator(Iterator<?> it) throws DataAccessException
Description copied from interface:HibernateOperationsImmediately close anIteratorcreated by any of the variousiterate(..)operations, instead of waiting until the session is closed or disconnected.- Specified by:
closeIteratorin interfaceHibernateOperations- Parameters:
it- theIteratorto close- Throws:
DataAccessException- if theIteratorcould not be closed- See Also:
Hibernate.close(java.util.Iterator)
bulkUpdate
public int bulkUpdate(String queryString, Object... values) throws DataAccessException
Description copied from interface:HibernateOperationsUpdate/delete all objects according to the given query, binding a number of values to "?" parameters in the query string.- Specified by:
bulkUpdatein interfaceHibernateOperations- Parameters:
queryString- an update/delete query expressed in Hibernate's query languagevalues- the values of the parameters- Returns:
- the number of instances updated/deleted
- Throws:
DataAccessException- in case of Hibernate errors- See Also:
SharedSessionContract.createQuery(java.lang.String),Query.executeUpdate()
checkWriteOperationAllowed
protected void checkWriteOperationAllowed(Session session) throws InvalidDataAccessApiUsageException
Check whether write operations are allowed on the given Session.Default implementation throws an InvalidDataAccessApiUsageException in case of
FlushMode.MANUAL. Can be overridden in subclasses.- Parameters:
session- current Hibernate Session- Throws:
InvalidDataAccessApiUsageException- if write operations are not allowed- See Also:
setCheckWriteOperations(boolean),Session.getFlushMode(),FlushMode.MANUAL
prepareQuery
protected void prepareQuery(Query queryObject)
Prepare the given Query object, applying cache settings and/or a transaction timeout.- Parameters:
queryObject- the Query object to prepare- See Also:
setCacheQueries(boolean),setQueryCacheRegion(java.lang.String)
prepareCriteria
protected void prepareCriteria(Criteria criteria)
Prepare the given Criteria object, applying cache settings and/or a transaction timeout.- Parameters:
criteria- the Criteria object to prepare- See Also:
setCacheQueries(boolean),setQueryCacheRegion(java.lang.String)
applyNamedParameterToQuery
protected void applyNamedParameterToQuery(Query queryObject, String paramName, Object value) throws HibernateException
Apply the given name parameter to the given Query object.- Parameters:
queryObject- the Query objectparamName- the name of the parametervalue- the value of the parameter- Throws:
HibernateException- if thrown by the Query object