public interface HibernateOperations
HibernateTemplate
. Not often used, but a useful
option to enhance testability, as it can easily be mocked or stubbed.
Defines HibernateTemplate
's data access methods that
mirror various Session
methods. Users are
strongly encouraged to read the Hibernate Session
javadocs
for details on the semantics of those methods.
Note that operations that return an Iterator
(i.e.
iterate(..)
) are supposed to be used within Spring-driven
or JTA-driven transactions (with HibernateTransactionManager
,
JtaTransactionManager
,
or EJB CMT). Else, the Iterator
won't be able to read
results from its ResultSet
anymore, as the underlying
Hibernate Session
will already have been closed.
Note that lazy loading will just work with an open Hibernate
Session
, either within a transaction or within
OpenSessionInViewFilter
/
OpenSessionInViewInterceptor
.
Furthermore, some operations just make sense within transactions,
for example: contains
, evict
, lock
,
flush
, clear
.
HibernateTemplate
,
Session
,
HibernateTransactionManager
,
JtaTransactionManager
,
OpenSessionInViewFilter
,
OpenSessionInViewInterceptor
Modifier and Type | Method and Description |
---|---|
int |
bulkUpdate(String queryString)
Update/delete all objects according to the given query.
|
int |
bulkUpdate(String queryString,
Object... values)
Update/delete all objects according to the given query, binding a number of
values to "?" parameters in the query string.
|
int |
bulkUpdate(String queryString,
Object value)
Update/delete all objects according to the given query, binding one value
to a "?" parameter in the query string.
|
void |
clear()
Remove all objects from the
Session cache, and
cancel all pending saves, updates and deletes. |
void |
closeIterator(Iterator it)
Immediately close an
Iterator created by any of the various
iterate(..) operations, instead of waiting until the
session is closed or disconnected. |
boolean |
contains(Object entity)
Check whether the given object is in the Session cache.
|
void |
delete(Object entity)
Delete the given persistent instance.
|
void |
delete(Object entity,
LockMode lockMode)
Delete the given persistent instance.
|
void |
delete(String entityName,
Object entity)
Delete the given persistent instance.
|
void |
delete(String entityName,
Object entity,
LockMode lockMode)
Delete the given persistent instance.
|
void |
deleteAll(Collection entities)
Delete all given persistent instances.
|
Filter |
enableFilter(String filterName)
Return an enabled Hibernate
Filter for the given filter name. |
void |
evict(Object entity)
Remove the given object from the
Session cache. |
<T> T |
execute(HibernateCallback<T> action)
Execute the action specified by the given action object within a
Session . |
List |
executeFind(HibernateCallback<?> action)
Deprecated.
as of Spring 3.2.7, in favor of using a regular
execute(org.springframework.orm.hibernate3.HibernateCallback<T>)
call with a generic List type declared |
List |
find(String queryString)
Execute an HQL query.
|
List |
find(String queryString,
Object... values)
Execute an HQL query, binding a number of values to "?" parameters
in the query string.
|
List |
find(String queryString,
Object value)
Execute an HQL query, binding one value to a "?" parameter 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.
|
List |
findByExample(Object exampleEntity)
Execute a query based on the given example entity object.
|
List |
findByExample(Object exampleEntity,
int firstResult,
int maxResults)
Execute a query based on a given example entity object.
|
List |
findByExample(String entityName,
Object exampleEntity)
Execute a query based on the given example entity object.
|
List |
findByExample(String entityName,
Object 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)
Execute a named query.
|
List |
findByNamedQuery(String queryName,
Object... values)
Execute a named query binding a number of values to "?" parameters
in the query string.
|
List |
findByNamedQuery(String queryName,
Object value)
Execute a named query, binding one value to a "?" parameter 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.
|
void |
flush()
Flush all pending saves, updates and deletes to the database.
|
<T> T |
get(Class<T> entityClass,
Serializable id)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
<T> T |
get(Class<T> entityClass,
Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
Object |
get(String entityName,
Serializable id)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
Object |
get(String entityName,
Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
void |
initialize(Object proxy)
Force initialization of a Hibernate proxy or persistent collection.
|
Iterator |
iterate(String queryString)
Execute a query for persistent instances.
|
Iterator |
iterate(String queryString,
Object... values)
Execute a query for persistent instances, binding a number of
values to "?" parameters in the query string.
|
Iterator |
iterate(String queryString,
Object value)
Execute a query for persistent instances, binding one value
to a "?" parameter in the query string.
|
<T> T |
load(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> T |
load(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.
|
void |
load(Object entity,
Serializable id)
Load the persistent instance with the given identifier
into the given object, throwing an exception if not found.
|
Object |
load(String entityName,
Serializable id)
Return the persistent instance of the given entity class
with the given identifier, throwing an exception if not found.
|
Object |
load(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.
|
void |
lock(Object entity,
LockMode lockMode)
Obtain the specified lock level upon the given object, implicitly
checking whether the corresponding database entry still exists.
|
void |
lock(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> T |
merge(String entityName,
T entity)
Copy the state of the given object onto the persistent object
with the same identifier.
|
<T> T |
merge(T entity)
Copy the state of the given object onto the persistent object
with the same identifier.
|
void |
persist(Object entity)
Persist the given transient instance.
|
void |
persist(String entityName,
Object entity)
Persist the given transient instance.
|
void |
refresh(Object entity)
Re-read the state of the given persistent instance.
|
void |
refresh(Object entity,
LockMode lockMode)
Re-read the state of the given persistent instance.
|
void |
replicate(Object entity,
ReplicationMode replicationMode)
Persist the state of the given detached instance according to the
given replication mode, reusing the current identifier value.
|
void |
replicate(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.
|
Serializable |
save(Object entity)
Persist the given transient instance.
|
Serializable |
save(String entityName,
Object entity)
Persist the given transient instance.
|
void |
saveOrUpdate(Object entity)
Save or update the given persistent instance,
according to its id (matching the configured "unsaved-value"?).
|
void |
saveOrUpdate(String entityName,
Object entity)
Save or update the given persistent instance,
according to its id (matching the configured "unsaved-value"?).
|
void |
saveOrUpdateAll(Collection entities)
Deprecated.
as of Spring 2.5, in favor of individual
saveOrUpdate or merge usage |
void |
update(Object entity)
Update the given persistent instance,
associating it with the current Hibernate
Session . |
void |
update(Object entity,
LockMode lockMode)
Update the given persistent instance,
associating it with the current Hibernate
Session . |
void |
update(String entityName,
Object entity)
Update the given persistent instance,
associating it with the current Hibernate
Session . |
void |
update(String entityName,
Object entity,
LockMode lockMode)
Update the given persistent instance,
associating it with the current Hibernate
Session . |
<T> T execute(HibernateCallback<T> action) throws DataAccessException
Session
.
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 any Session
lifecycle methods, like close,
disconnect, or reconnect, to let the template do its work.
action
- callback object that specifies the Hibernate actionnull
DataAccessException
- in case of Hibernate errorsHibernateTransactionManager
,
Session
@Deprecated List executeFind(HibernateCallback<?> action) throws DataAccessException
execute(org.springframework.orm.hibernate3.HibernateCallback<T>)
call with a generic List type declaredList
.
This is a convenience method for executing Hibernate find calls or queries within an action.
action
- callback object that specifies the Hibernate actionnull
DataAccessException
- in case of Hibernate errors<T> T get(Class<T> entityClass, Serializable id) throws DataAccessException
null
if 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.
entityClass
- a persistent classid
- the identifier of the persistent instancenull
if not foundDataAccessException
- in case of Hibernate errorsSession.get(Class, java.io.Serializable)
<T> T get(Class<T> entityClass, Serializable id, LockMode lockMode) throws DataAccessException
null
if 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.
entityClass
- a persistent classid
- the identifier of the persistent instancelockMode
- the lock mode to obtainnull
if not foundDataAccessException
- in case of Hibernate errorsSession.get(Class, java.io.Serializable, org.hibernate.LockMode)
Object get(String entityName, Serializable id) throws DataAccessException
null
if 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.
entityName
- the name of the persistent entityid
- the identifier of the persistent instancenull
if not foundDataAccessException
- in case of Hibernate errorsSession.get(Class, java.io.Serializable)
Object get(String entityName, Serializable id, LockMode lockMode) throws DataAccessException
null
if 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.
entityName
- the name of the persistent entityid
- the identifier of the persistent instancelockMode
- the lock mode to obtainnull
if not foundDataAccessException
- in case of Hibernate errorsSession.get(Class, java.io.Serializable, org.hibernate.LockMode)
<T> T load(Class<T> entityClass, Serializable id) throws DataAccessException
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.
entityClass
- a persistent classid
- the identifier of the persistent instanceObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.load(Class, java.io.Serializable)
<T> T load(Class<T> entityClass, Serializable id, LockMode lockMode) throws DataAccessException
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.
entityClass
- a persistent classid
- the identifier of the persistent instancelockMode
- the lock mode to obtainObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.load(Class, java.io.Serializable)
Object load(String entityName, Serializable id) throws DataAccessException
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.
entityName
- the name of the persistent entityid
- the identifier of the persistent instanceObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.load(Class, java.io.Serializable)
Object load(String entityName, Serializable id, LockMode lockMode) throws DataAccessException
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.
entityName
- the name of the persistent entityid
- the identifier of the persistent instancelockMode
- the lock mode to obtainObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.load(Class, java.io.Serializable)
<T> List<T> loadAll(Class<T> entityClass) throws DataAccessException
entityClass
- a persistent classList
containing 0 or more persistent instancesDataAccessException
- if there is a Hibernate errorSharedSessionContract.createCriteria(java.lang.Class)
void load(Object entity, Serializable id) throws DataAccessException
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.
entity
- the object (of the target class) to load intoid
- the identifier of the persistent instanceObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.load(Object, java.io.Serializable)
void refresh(Object entity) throws DataAccessException
entity
- the persistent instance to re-readDataAccessException
- in case of Hibernate errorsSession.refresh(Object)
void refresh(Object entity, LockMode lockMode) throws DataAccessException
entity
- the persistent instance to re-readlockMode
- the lock mode to obtainDataAccessException
- in case of Hibernate errorsSession.refresh(Object, org.hibernate.LockMode)
boolean contains(Object entity) throws DataAccessException
entity
- the persistence instance to checkDataAccessException
- if there is a Hibernate errorSession.contains(java.lang.Object)
void evict(Object entity) throws DataAccessException
Session
cache.entity
- the persistent instance to evictDataAccessException
- in case of Hibernate errorsSession.evict(java.lang.Object)
void initialize(Object proxy) throws DataAccessException
proxy
- a proxy for a persistent object or a persistent collectionDataAccessException
- if we can't initialize the proxy, for example
because it is not associated with an active SessionHibernate.initialize(java.lang.Object)
Filter enableFilter(String filterName) throws IllegalStateException
Filter
for the given filter name.
The returned Filter
instance can be used to set filter parameters.filterName
- the name of the filterFilter
(either already
enabled or enabled on the fly by this operation)IllegalStateException
- if we are not running within a
transactional Session (in which case this operation does not make sense)void lock(Object entity, LockMode lockMode) throws DataAccessException
entity
- the persistent instance to locklockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.lock(Object, org.hibernate.LockMode)
void lock(String entityName, Object entity, LockMode lockMode) throws DataAccessException
entityName
- the name of the persistent entityentity
- the persistent instance to locklockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.lock(String, Object, org.hibernate.LockMode)
Serializable save(Object entity) throws DataAccessException
entity
- the transient instance to persistDataAccessException
- in case of Hibernate errorsSession.save(Object)
Serializable save(String entityName, Object entity) throws DataAccessException
entityName
- the name of the persistent entityentity
- the transient instance to persistDataAccessException
- in case of Hibernate errorsSession.save(String, Object)
void update(Object entity) throws DataAccessException
Session
.entity
- the persistent instance to updateDataAccessException
- in case of Hibernate errorsSession.update(Object)
void update(Object entity, LockMode lockMode) throws DataAccessException
Session
.
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
entity
- the persistent instance to updatelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.update(Object)
void update(String entityName, Object entity) throws DataAccessException
Session
.entityName
- the name of the persistent entityentity
- the persistent instance to updateDataAccessException
- in case of Hibernate errorsSession.update(String, Object)
void update(String entityName, Object entity, LockMode lockMode) throws DataAccessException
Session
.
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
entityName
- the name of the persistent entityentity
- the persistent instance to updatelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.update(String, Object)
void saveOrUpdate(Object entity) throws DataAccessException
Session
.entity
- the persistent instance to save or update
(to be associated with the Hibernate Session
)DataAccessException
- in case of Hibernate errorsSession.saveOrUpdate(Object)
void saveOrUpdate(String entityName, Object entity) throws DataAccessException
Session
.entityName
- the name of the persistent entityentity
- the persistent instance to save or update
(to be associated with the Hibernate Session
)DataAccessException
- in case of Hibernate errorsSession.saveOrUpdate(String, Object)
@Deprecated void saveOrUpdateAll(Collection entities) throws DataAccessException
saveOrUpdate
or merge
usageSession
.entities
- the persistent instances to save or update
(to be associated with the Hibernate Session
)DataAccessException
- in case of Hibernate errorsvoid replicate(Object entity, ReplicationMode replicationMode) throws DataAccessException
entity
- the persistent object to replicatereplicationMode
- the Hibernate ReplicationModeDataAccessException
- in case of Hibernate errorsSession.replicate(Object, org.hibernate.ReplicationMode)
void replicate(String entityName, Object entity, ReplicationMode replicationMode) throws DataAccessException
entityName
- the name of the persistent entityentity
- the persistent object to replicatereplicationMode
- the Hibernate ReplicationModeDataAccessException
- in case of Hibernate errorsSession.replicate(String, Object, org.hibernate.ReplicationMode)
void persist(Object entity) throws DataAccessException
Similar to save
, associating the given object
with the current Hibernate Session
.
entity
- the persistent instance to persistDataAccessException
- in case of Hibernate errorsSession.persist(Object)
,
save(java.lang.Object)
void persist(String entityName, Object entity) throws DataAccessException
Similar to save
, associating the given object
with the current Hibernate Session
.
entityName
- the name of the persistent entityentity
- the persistent instance to persistDataAccessException
- in case of Hibernate errorsSession.persist(String, Object)
,
save(java.lang.Object)
<T> T merge(T entity) throws DataAccessException
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 merge
will not update the identifiers
in the passed-in object graph (in contrast to TopLink)! Consider
registering Spring's IdTransferringMergeEventListener
if
you would like to have newly assigned ids transferred to the original
object graph too.
entity
- the object to merge with the corresponding persistence instanceDataAccessException
- in case of Hibernate errorsSession.merge(Object)
,
saveOrUpdate(java.lang.Object)
,
IdTransferringMergeEventListener
<T> T merge(String entityName, T entity) throws DataAccessException
Similar to saveOrUpdate
, but never associates the given
object with the current Hibernate Session
. In
the case of a new entity, the state will be copied over as well.
Note that merge
will not update the identifiers
in the passed-in object graph (in contrast to TopLink)! Consider
registering Spring's IdTransferringMergeEventListener
if you would like to have newly assigned ids transferred to the
original object graph too.
entityName
- the name of the persistent entityentity
- the object to merge with the corresponding persistence instanceDataAccessException
- in case of Hibernate errorsSession.merge(String, Object)
,
saveOrUpdate(java.lang.Object)
void delete(Object entity) throws DataAccessException
entity
- the persistent instance to deleteDataAccessException
- in case of Hibernate errorsSession.delete(Object)
void delete(Object entity, LockMode lockMode) throws DataAccessException
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
entity
- the persistent instance to deletelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.delete(Object)
void delete(String entityName, Object entity) throws DataAccessException
entityName
- the name of the persistent entityentity
- the persistent instance to deleteDataAccessException
- in case of Hibernate errorsSession.delete(Object)
void delete(String entityName, Object entity, LockMode lockMode) throws DataAccessException
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
entityName
- the name of the persistent entityentity
- the persistent instance to deletelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsSession.delete(Object)
void deleteAll(Collection entities) throws DataAccessException
This can be combined with any of the find methods to delete by query in two lines of code.
entities
- the persistent instances to deleteDataAccessException
- in case of Hibernate errorsSession.delete(Object)
void flush() throws DataAccessException
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.
DataAccessException
- in case of Hibernate errorsSession.flush()
void clear() throws DataAccessException
Session
cache, and
cancel all pending saves, updates and deletes.DataAccessException
- in case of Hibernate errorsSession.clear()
List find(String queryString) throws DataAccessException
queryString
- a query expressed in Hibernate's query languageList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
List find(String queryString, Object value) throws DataAccessException
queryString
- a query expressed in Hibernate's query languagevalue
- the value of the parameterList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
List find(String queryString, Object... values) throws DataAccessException
queryString
- a query expressed in Hibernate's query languagevalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
List findByNamedParam(String queryString, String paramName, Object value) throws DataAccessException
queryString
- a query expressed in Hibernate's query languageparamName
- the name of the parametervalue
- the value of the parameterList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByNamedParam(String queryString, String[] paramNames, Object[] values) throws DataAccessException
queryString
- a query expressed in Hibernate's query languageparamNames
- the names of the parametersvalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByValueBean(String queryString, Object valueBean) throws DataAccessException
queryString
- a query expressed in Hibernate's query languagevalueBean
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsQuery.setProperties(java.lang.Object)
,
SharedSessionContract.createQuery(java.lang.String)
List findByNamedQuery(String queryName) throws DataAccessException
A named query is defined in a Hibernate mapping file.
queryName
- the name of a Hibernate query in a mapping fileList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByNamedQuery(String queryName, Object value) throws DataAccessException
A named query is defined in a Hibernate mapping file.
queryName
- the name of a Hibernate query in a mapping filevalue
- the value of the parameterList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByNamedQuery(String queryName, Object... values) throws DataAccessException
A named query is defined in a Hibernate mapping file.
queryName
- the name of a Hibernate query in a mapping filevalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByNamedQueryAndNamedParam(String queryName, String paramName, Object value) throws DataAccessException
A named query is defined in a Hibernate mapping file.
queryName
- the name of a Hibernate query in a mapping fileparamName
- the name of parametervalue
- the value of the parameterList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByNamedQueryAndNamedParam(String queryName, String[] paramNames, Object[] values) throws DataAccessException
A named query is defined in a Hibernate mapping file.
queryName
- the name of a Hibernate query in a mapping fileparamNames
- the names of the parametersvalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsSharedSessionContract.getNamedQuery(String)
List findByNamedQueryAndValueBean(String queryName, Object valueBean) throws DataAccessException
A named query is defined in a Hibernate mapping file.
queryName
- the name of a Hibernate query in a mapping filevalueBean
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsQuery.setProperties(java.lang.Object)
,
SharedSessionContract.getNamedQuery(String)
List findByCriteria(DetachedCriteria criteria) throws DataAccessException
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.List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsDetachedCriteria.getExecutableCriteria(org.hibernate.Session)
List findByCriteria(DetachedCriteria criteria, int firstResult, int maxResults) throws DataAccessException
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)List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsDetachedCriteria.getExecutableCriteria(org.hibernate.Session)
,
Criteria.setFirstResult(int)
,
Criteria.setMaxResults(int)
List findByExample(Object exampleEntity) throws DataAccessException
exampleEntity
- an instance of the desired entity,
serving as example for "query-by-example"List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsExample.create(Object)
List findByExample(String entityName, Object exampleEntity) throws DataAccessException
entityName
- the name of the persistent entityexampleEntity
- an instance of the desired entity,
serving as example for "query-by-example"List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsExample.create(Object)
List findByExample(Object exampleEntity, int firstResult, int maxResults) throws DataAccessException
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)List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsExample.create(Object)
,
Criteria.setFirstResult(int)
,
Criteria.setMaxResults(int)
List findByExample(String entityName, Object exampleEntity, int firstResult, int maxResults) throws DataAccessException
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)List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsExample.create(Object)
,
Criteria.setFirstResult(int)
,
Criteria.setMaxResults(int)
Iterator iterate(String queryString) throws DataAccessException
Returns the results as an Iterator
. Entities returned are
initialized on demand. See the Hibernate API documentation for details.
queryString
- a query expressed in Hibernate's query languageIterator
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
,
Query.iterate()
Iterator iterate(String queryString, Object value) throws DataAccessException
Returns the results as an Iterator
. Entities returned are
initialized on demand. See the Hibernate API documentation for details.
queryString
- a query expressed in Hibernate's query languagevalue
- the value of the parameterIterator
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
,
Query.iterate()
Iterator iterate(String queryString, Object... values) throws DataAccessException
Returns the results as an Iterator
. Entities returned are
initialized on demand. See the Hibernate API documentation for details.
queryString
- a query expressed in Hibernate's query languagevalues
- the values of the parametersIterator
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
,
Query.iterate()
void closeIterator(Iterator it) throws DataAccessException
Iterator
created by any of the various
iterate(..)
operations, instead of waiting until the
session is closed or disconnected.it
- the Iterator
to closeDataAccessException
- if the Iterator
could not be closedHibernate.close(java.util.Iterator)
int bulkUpdate(String queryString) throws DataAccessException
queryString
- an update/delete query expressed in Hibernate's query languageDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
,
Query.executeUpdate()
int bulkUpdate(String queryString, Object value) throws DataAccessException
queryString
- an update/delete query expressed in Hibernate's query languagevalue
- the value of the parameterDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
,
Query.executeUpdate()
int bulkUpdate(String queryString, Object... values) throws DataAccessException
queryString
- an update/delete query expressed in Hibernate's query languagevalues
- the values of the parametersDataAccessException
- in case of Hibernate errorsSharedSessionContract.createQuery(java.lang.String)
,
Query.executeUpdate()