public final class

SessionImpl

extends AbstractSessionImpl
implements Session LobCreationContext EventSource JDBCContext.Context
java.lang.Object
   ↳ org.hibernate.impl.AbstractSessionImpl
     ↳ org.hibernate.impl.SessionImpl

Class Overview

Concrete implementation of a Session, and also the central, organizing component of Hibernate's internal implementation. As such, this class exposes two interfaces; Session itself, to the application, and SessionImplementor, to other components of Hibernate. This class is not threadsafe.

Summary

[Expand]
Inherited Fields
From class org.hibernate.impl.AbstractSessionImpl
Public Methods
void afterOperation(boolean success)
Check if there is a Hibernate or JTA transaction in progress and, if there is not, flush if necessary, make sure the connection has been committed (if it is not in autocommit mode) and run the after completion processing
void afterScrollOperation()
void afterTransactionBegin(Transaction tx)
We cannot rely upon this method being called! It is only called if we are using Hibernate Transaction API.
void afterTransactionCompletion(boolean success, Transaction tx)
Notify the session that the transaction completed, so we no longer own the old locks.
void applyNonFlushedChanges(NonFlushedChanges nonFlushedChanges)
Apply non-flushed changes from a different session to this session.
void beforeTransactionCompletion(Transaction tx)
Notify the session that the transaction is about to complete
Transaction beginTransaction()
Begin a unit of work and return the associated Transaction object.
String bestGuessEntityName(Object object)
The best guess entity name for an entity not in an association
Session.LockRequest buildLockRequest(LockOptions lockOptions)
Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope.
void cancelQuery()
Cancel the execution of the current query.
void clear()
Completely clear the session.
Connection close()
End the session by releasing the JDBC connection and cleaning up.
Connection connection()
Get the JDBC connection of this Session.
boolean contains(Object object)
Check if this instance is associated with this Session.
Criteria createCriteria(Class persistentClass)
Create a new Criteria instance, for the given entity class, or a superclass of an entity class.
Criteria createCriteria(Class persistentClass, String alias)
Create a new Criteria instance, for the given entity class, or a superclass of an entity class, with the given alias.
Criteria createCriteria(String entityName)
Create a new Criteria instance, for the given entity name.
Criteria createCriteria(String entityName, String alias)
Create a new Criteria instance, for the given entity name, with the given alias.
Query createFilter(Object collection, String queryString)
Create a new instance of Query for the given collection and filter string.
Query createQuery(String queryString)
Query createSQLQuery(String sql, String returnAlias, Class returnClass)
Create a new instance of Query for the given SQL string.
SQLQuery createSQLQuery(String sql)
Query createSQLQuery(String sql, String[] returnAliases, Class[] returnClasses)
Create a new instance of Query for the given SQL string.
void delete(String entityName, Object object)
Delete a persistent object (by explicit entity name)
int delete(String query, Object[] values, Type[] types)
Delete all objects returned by the query.
void delete(Object object)
Delete a persistent object
int delete(String query, Object value, Type type)
Delete all objects returned by the query.
int delete(String query)
Delete all objects returned by the query.
void delete(String entityName, Object object, boolean isCascadeDeleteEnabled, Set transientEntities)
Delete a persistent object
void disableFetchProfile(String name)
Disable a particular fetch profile on this session.
void disableFilter(String filterName)
Disable the named filter for the current session.
Connection disconnect()
Disconnect the Session from the current JDBC connection.
void doWork(Work work)
Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
void enableFetchProfile(String name)
Enable a particular fetch profile on this session.
Filter enableFilter(String filterName)
Enable the named filter for this current session.
void evict(Object object)
remove any hard references to the entity that are held by the infrastructure (references held by application or other persistant instances are okay)
Object execute(LobCreationContext.Callback callback)
Execute the given callback, making sure it has access to a viable JDBC Connection.
int executeNativeUpdate(NativeSQLQuerySpecification nativeQuerySpecification, QueryParameters queryParameters)
Execute a native SQL update or delete query
int executeUpdate(String query, QueryParameters queryParameters)
Execute a HQL update or delete query
Collection filter(Object collection, String filter, Object value, Type type)
Apply a filter to a persistent collection.
Collection filter(Object collection, String filter, Object[] values, Type[] types)
Apply a filter to a persistent collection.
Collection filter(Object collection, String filter)
Apply a filter to a persistent collection.
List find(String query, Object[] values, Type[] types)
Execute a query with bind parameters, binding an array of values to "?" parameters in the query string.
List find(String query)
Retrieve a list of persistent objects using a hibernate query
List find(String query, Object value, Type type)
Execute a query with bind parameters, binding a value to a "?" parameter in the query string.
void flush()
Force this session to flush.
void forceFlush(EntityEntry entityEntry)
Force an immediate flush
Object get(Class entityClass, Serializable id, LockOptions lockOptions)
Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object get(Class entityClass, Serializable id, LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object get(String entityName, Serializable id)
Return the persistent instance of the given named entity with the given identifier, or null if there is no such persistent instance.
Object get(Class entityClass, Serializable id)
Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object get(String entityName, Serializable id, LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object get(String entityName, Serializable id, LockOptions lockOptions)
Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
ActionQueue getActionQueue()
Get the ActionQueue for this session
Batcher getBatcher()
Get the prepared statement Batcher for this session
CacheMode getCacheMode()
Get the current cache mode.
ConnectionReleaseMode getConnectionReleaseMode()
Serializable getContextEntityIdentifier(Object object)
Get the id value for an object that is actually associated with the session.
LockMode getCurrentLockMode(Object object)
Determine the current lock mode of the given object.
int getDontFlushFromFind()
Filter getEnabledFilter(String filterName)
Retrieve a currently enabled filter by name.
Map getEnabledFilters()
Return the currently enabled filters.
EntityMode getEntityMode()
Retrieve the entity mode in effect for this session.
String getEntityName(Object object)
Return the entity name for a persistent entity
EntityPersister getEntityPersister(String entityName, Object object)
Get the EntityPersister for any instance
Object getEntityUsingInterceptor(EntityKey key)
Get the entity instance associated with the given Key, calling the Interceptor if necessary
String getFetchProfile()
Get the internal fetch profile currently associated with this session.
Type getFilterParameterType(String filterParameterName)
Retreive the type for a given filter parrameter.
Object getFilterParameterValue(String filterParameterName)
Retreive the currently set value for a filter parameter.
FlushMode getFlushMode()
Get the current flush mode for this session.
Serializable getIdentifier(Object object)
Return the identifier value of the given entity as associated with this session.
Interceptor getInterceptor()
Retrieves the interceptor currently in use by this event source.
JDBCContext getJDBCContext()
EventListeners getListeners()
Retrieves the configured event listeners from this event source.
LoadQueryInfluencers getLoadQueryInfluencers()
Get the load query influencers associated with this session.
LobHelper getLobHelper()
Retrieve this session's helper/delegate for creating LOB instances.
Query getNamedQuery(String queryName)
Get a Query instance for a named query or named native SQL query
NonFlushedChanges getNonFlushedChanges()
Return changes to this session and its child sessions that have not been flushed yet.
PersistenceContext getPersistenceContext()
Get the persistence context for this session
Session getSession(EntityMode entityMode)
Starts a new Session with the given entity mode in effect.
SessionFactory getSessionFactory()
Get the session factory which created this session.
SessionStatistics getStatistics()
Get the statistics for this session.
long getTimestamp()
System time before the start of the transaction
Transaction getTransaction()
Get the Transaction instance associated with this session.
TypeHelper getTypeHelper()
Convenience access to the TypeHelper associated with this session's SessionFactory.
String guessEntityName(Object object)
The guessed entity name for an entity not in an association
Object immediateLoad(String entityName, Serializable id)
Load the data for the object with the specified id into a newly created object.
void initializeCollection(PersistentCollection collection, boolean writing)
Initialize the collection (if not already initialized)
Object instantiate(EntityPersister persister, Serializable id)
give the interceptor an opportunity to override the default instantiation
Object instantiate(String entityName, Serializable id)
Instantiate the entity class, initializing with the given identifier
Object internalLoad(String entityName, Serializable id, boolean eager, boolean nullable)
Load an instance without checking if it was deleted.
boolean isAutoCloseSessionEnabled()
boolean isConnected()
Check if the session is currently connected.
boolean isDefaultReadOnly()
Will entities and proxies that are loaded into this session be made read-only by default? To determine the read-only/modifiable setting for a particular entity or proxy:
boolean isDirty()
Does this session contain any changes which must be synchronized with the database? In other words, would any DML operations be executed if we flushed this session?
boolean isEventSource()
boolean isFetchProfileEnabled(String name)
Is a particular fetch profile enabled on this session?
boolean isFlushBeforeCompletionEnabled()
boolean isFlushModeNever()
boolean isOpen()
Check if the session is still open.
boolean isReadOnly(Object entityOrProxy)
Is the specified entity or proxy read-only? To get the default read-only/modifiable setting used for entities and proxies that are loaded into the session:
boolean isTransactionInProgress()
Does this Session have an active Hibernate transaction or is there a JTA transaction in progress?
Iterator iterate(String query, Object[] values, Type[] types)
Execute a query and return the results in an iterator.
Iterator iterate(String query, QueryParameters queryParameters)
Execute an iterate() query
Iterator iterate(String query, Object value, Type type)
Execute a query and return the results in an iterator.
Iterator iterate(String query)
Execute a query and return the results in an iterator.
Iterator iterateFilter(Object collection, String filter, QueryParameters queryParameters)
Iterate a filter
List list(String query, QueryParameters queryParameters)
Execute a find() query
List list(CriteriaImpl criteria)
Execute a criteria query
List listCustomQuery(CustomQuery customQuery, QueryParameters queryParameters)
Execute an SQL Query
List listFilter(Object collection, String filter, QueryParameters queryParameters)
Execute a filter
void load(Object object, Serializable id)
Read the persistent state associated with the given identifier into the given transient instance.
Object load(Class entityClass, Serializable id, LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
Object load(Class entityClass, Serializable id)
Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists.
Object load(String entityName, Serializable id)
Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists.
Object load(String entityName, Serializable id, LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
Object load(String entityName, Serializable id, LockOptions lockOptions)
Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
Object load(Class entityClass, Serializable id, LockOptions lockOptions)
Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
void lock(String entityName, Object object, LockMode lockMode)
Obtain the specified lock level upon the given object.
void lock(Object object, LockMode lockMode)
Obtain the specified lock level upon the given object.
void managedClose()
void managedFlush()
void merge(String entityName, Object object, Map copiedAlready)
Cascade merge an entity instance
Object merge(Object object)
Copy the state of the given object onto the persistent object with the same identifier.
Object merge(String entityName, Object object)
Copy the state of the given object onto the persistent object with the same identifier.
void persist(Object object)
Make a transient instance persistent.
void persist(String entityName, Object object)
Make a transient instance persistent.
void persist(String entityName, Object object, Map copiedAlready)
Cascade persist an entity instance
void persistOnFlush(String entityName, Object object)
void persistOnFlush(String entityName, Object object, Map copiedAlready)
Cascade persist an entity instance during the flush process
void persistOnFlush(Object object)
void reconnect(Connection conn)
Reconnect to the given JDBC connection.
void reconnect()
Obtain a new JDBC connection.
void refresh(Object object, LockOptions lockOptions)
Re-read the state of the given instance from the underlying database, with the given LockMode.
void refresh(Object object)
Re-read the state of the given instance from the underlying database.
void refresh(Object object, Map refreshedAlready)
Cascade refesh an entity instance
void refresh(Object object, LockMode lockMode)
Re-read the state of the given instance from the underlying database, with the given LockMode.
void replicate(String entityName, Object obj, ReplicationMode replicationMode)
Persist the state of the given detached instance, reusing the current identifier value.
void replicate(Object obj, ReplicationMode replicationMode)
Persist the state of the given detached instance, reusing the current identifier value.
void save(String entityName, Object object, Serializable id)
Persist the given transient instance, using the given identifier.
Serializable save(Object obj)
Persist the given transient instance, first assigning a generated identifier.
Serializable save(String entityName, Object object)
Persist the given transient instance, first assigning a generated identifier.
void save(Object obj, Serializable id)
Persist the given transient instance, using the given identifier.
void saveOrUpdate(String entityName, Object obj)
Either save(String, Object) or update(String, Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).
void saveOrUpdate(Object object)
Either save(Object) or update(Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).
Object saveOrUpdateCopy(Object object)
Copy the state of the given object onto the persistent object with the same identifier.
Object saveOrUpdateCopy(String entityName, Object object, Serializable id)
Copy the state of the given object onto the persistent object with the given identifier.
Object saveOrUpdateCopy(Object object, Serializable id)
Copy the state of the given object onto the persistent object with the given identifier.
Object saveOrUpdateCopy(String entityName, Object object)
Copy the state of the given object onto the persistent object with the same identifier.
void saveOrUpdateCopy(String entityName, Object object, Map copiedAlready)
Cascade copy an entity instance
ScrollableResults scroll(CriteriaImpl criteria, ScrollMode scrollMode)
Execute a criteria query
ScrollableResults scroll(String query, QueryParameters queryParameters)
Execute a scroll() query
ScrollableResults scrollCustomQuery(CustomQuery customQuery, QueryParameters queryParameters)
Execute an SQL Query
void setAutoClear(boolean enabled)
Enable/disable automatic cache clearing from after transaction completion (for EJB3)
void setCacheMode(CacheMode cacheMode)
Set the cache mode.
void setDefaultReadOnly(boolean defaultReadOnly)
Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from modifiable to read-only mode.
void setFetchProfile(String fetchProfile)
Set the current internal fetch profile for this session.
void setFlushMode(FlushMode flushMode)
Set the flush mode for this session.
void setReadOnly(Object entity, boolean readOnly)
Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode.
boolean shouldAutoClose()
String toString()
void update(String entityName, Object object, Serializable id)
Update the persistent state associated with the given identifier.
void update(Object obj)
Update the persistent instance with the identifier of the given detached instance.
void update(Object obj, Serializable id)
Update the persistent state associated with the given identifier.
void update(String entityName, Object object)
Update the persistent instance with the identifier of the given detached instance.
Protected Methods
boolean autoFlushIfRequired(Set querySpaces)
detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush
[Expand]
Inherited Methods
From class org.hibernate.impl.AbstractSessionImpl
From class java.lang.Object
From interface org.hibernate.Session
From interface org.hibernate.classic.Session
From interface org.hibernate.engine.SessionImplementor
From interface org.hibernate.engine.jdbc.LobCreationContext
From interface org.hibernate.event.EventSource
From interface org.hibernate.jdbc.JDBCContext.Context
From interface org.hibernate.transaction.TransactionFactory.Context

Public Methods

public void afterOperation (boolean success)

Check if there is a Hibernate or JTA transaction in progress and, if there is not, flush if necessary, make sure the connection has been committed (if it is not in autocommit mode) and run the after completion processing

public void afterScrollOperation ()

public void afterTransactionBegin (Transaction tx)

We cannot rely upon this method being called! It is only called if we are using Hibernate Transaction API.

public void afterTransactionCompletion (boolean success, Transaction tx)

Notify the session that the transaction completed, so we no longer own the old locks. (Also we should release cache softlocks.) May be called multiple times during the transaction completion process. Also called after an autocommit, in which case the second argument is null.

public void applyNonFlushedChanges (NonFlushedChanges nonFlushedChanges)

Apply non-flushed changes from a different session to this session. It is assumed that this SessionImpl is "clean" (e.g., has no non-flushed changes, no cached entities, no cached collections, no queued actions). The specified NonFlushedChanges object cannot be bound to any session.

Parameters
nonFlushedChanges the non-flushed changes
Throws
HibernateException

public void beforeTransactionCompletion (Transaction tx)

Notify the session that the transaction is about to complete

public Transaction beginTransaction ()

Begin a unit of work and return the associated Transaction object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction. The class of the returned Transaction object is determined by the property hibernate.transaction_factory.

Returns
  • a Transaction instance
Throws
HibernateException

public String bestGuessEntityName (Object object)

The best guess entity name for an entity not in an association

public Session.LockRequest buildLockRequest (LockOptions lockOptions)

Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope. timeout and scope is ignored for optimistic locking. After building the LockRequest, call LockRequest.lock to perform the requested locking. Use: session.buildLockRequest(). setLockMode(LockMode.PESSIMISTIC_WRITE).setTimeOut(1000 * 60).lock(entity);

Parameters
lockOptions contains the lock level
Returns
  • a lockRequest that can be used to lock the passed object.

public void cancelQuery ()

Cancel the execution of the current query.

This is the sole method on session which may be safely called from another thread.

Throws
HibernateException

public void clear ()

Completely clear the session. Evict all loaded instances and cancel all pending saves, updates and deletions. Do not close open iterators or instances of ScrollableResults.

public Connection close ()

End the session by releasing the JDBC connection and cleaning up. It is not strictly necessary to close the session but you must at least disconnect() it.

Returns
  • the connection provided by the application or null.
Throws
HibernateException

public Connection connection ()

Get the JDBC connection of this Session.

If the session is using aggressive collection release (as in a CMT environment), it is the application's responsibility to close the connection returned by this call. Otherwise, the application should not close the connection.

Returns
  • the JDBC connection in use by the Session
Throws
HibernateException

public boolean contains (Object object)

Check if this instance is associated with this Session.

Parameters
object an instance of a persistent class
Returns
  • true if the given instance is associated with this Session

public Criteria createCriteria (Class persistentClass)

Create a new Criteria instance, for the given entity class, or a superclass of an entity class.

Parameters
persistentClass a class, which is persistent, or has persistent subclasses
Returns
  • Criteria

public Criteria createCriteria (Class persistentClass, String alias)

Create a new Criteria instance, for the given entity class, or a superclass of an entity class, with the given alias.

Parameters
persistentClass a class, which is persistent, or has persistent subclasses
Returns
  • Criteria

public Criteria createCriteria (String entityName)

Create a new Criteria instance, for the given entity name.

Returns
  • Criteria

public Criteria createCriteria (String entityName, String alias)

Create a new Criteria instance, for the given entity name, with the given alias.

Returns
  • Criteria

public Query createFilter (Object collection, String queryString)

Create a new instance of Query for the given collection and filter string.

Parameters
collection a persistent collection
queryString a Hibernate query
Returns
  • Query

public Query createQuery (String queryString)

public Query createSQLQuery (String sql, String returnAlias, Class returnClass)

Create a new instance of Query for the given SQL string.

Returned instances should all be SQLQuery.

Parameters
sql a query expressed in SQL
returnAlias a table alias that appears inside {} in the SQL string
returnClass the returned persistent class

public SQLQuery createSQLQuery (String sql)

public Query createSQLQuery (String sql, String[] returnAliases, Class[] returnClasses)

Create a new instance of Query for the given SQL string.

Returned instances should all be SQLQuery.

Parameters
sql a query expressed in SQL
returnAliases an array of table aliases that appear inside {} in the SQL string
returnClasses the returned persistent classes

public void delete (String entityName, Object object)

Delete a persistent object (by explicit entity name)

Parameters
entityName The entity name for the instance to be removed.
object the instance to be removed
Throws
HibernateException

public int delete (String query, Object[] values, Type[] types)

Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling delete(Object) individually.

Parameters
query the query string
values a list of values to be written to "?" placeholders in the query.
types a list of Hibernate types of the values
Returns
  • the number of instances deleted
Throws
HibernateException

public void delete (Object object)

Delete a persistent object

Parameters
object the instance to be removed
Throws
HibernateException

public int delete (String query, Object value, Type type)

Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling delete(Object) individually.

Parameters
query the query string
value a value to be witten to a "?" placeholder in the query string.
type the hibernate type of value.
Returns
  • the number of instances deleted
Throws
HibernateException

public int delete (String query)

Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling delete(Object) individually.

Parameters
query the query string
Returns
  • the number of instances deleted
Throws
HibernateException

public void delete (String entityName, Object object, boolean isCascadeDeleteEnabled, Set transientEntities)

Delete a persistent object

Throws
HibernateException

public void disableFetchProfile (String name)

Disable a particular fetch profile on this session. No-op if requested profile is already disabled.

Parameters
name The name of the fetch profile to be disabled.
Throws
UnknownProfileException

public void disableFilter (String filterName)

Disable the named filter for the current session.

Parameters
filterName The name of the filter to be disabled.

public Connection disconnect ()

Disconnect the Session from the current JDBC connection. If the connection was obtained by Hibernate close it and return it to the connection pool; otherwise, return it to the application.

This is used by applications which supply JDBC connections to Hibernate and which require long-sessions (or long-conversations)

Note that disconnect() called on a session where the connection was retrieved by Hibernate through its configured ConnectionProvider has no effect, provided ON_CLOSE is not in effect.

Returns
  • the application-supplied connection or null
Throws
HibernateException

public void doWork (Work work)

Controller for allowing users to perform JDBC related work using the Connection managed by this Session.

Parameters
work The work to be performed.
Throws
HibernateException

public void enableFetchProfile (String name)

Enable a particular fetch profile on this session. No-op if requested profile is already enabled.

Parameters
name The name of the fetch profile to be enabled.
Throws
UnknownProfileException

public Filter enableFilter (String filterName)

Enable the named filter for this current session.

Parameters
filterName The name of the filter to be enabled.
Returns
  • The Filter instance representing the enabled filter.

public void evict (Object object)

remove any hard references to the entity that are held by the infrastructure (references held by application or other persistant instances are okay)

Parameters
object a persistent instance
Throws
HibernateException

public Object execute (LobCreationContext.Callback callback)

Execute the given callback, making sure it has access to a viable JDBC Connection.

Parameters
callback The callback to execute .
Returns
  • The LOB created by the callback.

public int executeNativeUpdate (NativeSQLQuerySpecification nativeQuerySpecification, QueryParameters queryParameters)

Execute a native SQL update or delete query

Throws
HibernateException

public int executeUpdate (String query, QueryParameters queryParameters)

Execute a HQL update or delete query

Throws
HibernateException

public Collection filter (Object collection, String filter, Object value, Type type)

Apply a filter to a persistent collection. A filter is a Hibernate query that may refer to this, the collection element.

Parameters
collection a persistent collection to filter
filter a filter query string
value a value to be witten to a "?" placeholder in the query string
type the hibernate type of value
Returns
  • Collection
Throws
HibernateException

public Collection filter (Object collection, String filter, Object[] values, Type[] types)

Apply a filter to a persistent collection. Bind the given parameters to "?" placeholders. A filter is a Hibernate query that may refer to this, the collection element.

Parameters
collection a persistent collection to filter
filter a filter query string
values a list of values to be written to "?" placeholders in the query
types a list of Hibernate types of the values
Returns
  • Collection
Throws
HibernateException

public Collection filter (Object collection, String filter)

Apply a filter to a persistent collection. A filter is a Hibernate query that may refer to this, the collection element. Filters allow efficient access to very large lazy collections. (Executing the filter does not initialize the collection.)

Parameters
collection a persistent collection to filter
filter a filter query string
Returns
  • Collection the resulting collection
Throws
HibernateException

public List find (String query, Object[] values, Type[] types)

Execute a query with bind parameters, binding an array of values to "?" parameters in the query string.

Parameters
query the query string
values an array of values to be bound to the "?" placeholders (JDBC IN parameters).
types an array of Hibernate types of the values
Returns
  • a distinct list of instances
Throws
HibernateException

public List find (String query)

Retrieve a list of persistent objects using a hibernate query

Parameters
query a query expressed in Hibernate's query language
Returns
  • a distinct list of instances (or arrays of instances)
Throws
HibernateException

public List find (String query, Object value, Type type)

Execute a query with bind parameters, binding a value to a "?" parameter in the query string.

Parameters
query the query string
value a value to be bound to a "?" placeholder (JDBC IN parameter).
type the Hibernate type of the value
Returns
  • a distinct list of instances (or arrays of instances)
Throws
HibernateException

public void flush ()

Force this session to flush. Must be called at the end of a unit of work, before committing the transaction and closing the session (depending on flush-mode, commit() calls this method).

Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

Throws
HibernateException

public void forceFlush (EntityEntry entityEntry)

Force an immediate flush

Throws
HibernateException

public Object get (Class entityClass, Serializable id, LockOptions lockOptions)

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.) Obtain the specified lock mode if the instance exists.

Parameters
entityClass a persistent class
id an identifier
lockOptions the lock mode
Returns
  • a persistent instance or null
Throws
HibernateException

public Object get (Class entityClass, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.) Obtain the specified lock mode if the instance exists.

Parameters
entityClass a persistent class
id an identifier
lockMode the lock mode
Returns
  • a persistent instance or null
Throws
HibernateException

public Object get (String entityName, Serializable id)

Return the persistent instance of the given named entity with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.)

Parameters
entityName the entity name
id an identifier
Returns
  • a persistent instance or null
Throws
HibernateException

public Object get (Class entityClass, Serializable id)

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.)

Parameters
entityClass a persistent class
id an identifier
Returns
  • a persistent instance or null
Throws
HibernateException

public Object get (String entityName, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.) Obtain the specified lock mode if the instance exists.

Parameters
entityName the entity name
id an identifier
lockMode the lock mode
Returns
  • a persistent instance or null
Throws
HibernateException

public Object get (String entityName, Serializable id, LockOptions lockOptions)

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.) Obtain the specified lock mode if the instance exists.

Parameters
entityName the entity name
id an identifier
lockOptions contains the lock mode
Returns
  • a persistent instance or null
Throws
HibernateException

public ActionQueue getActionQueue ()

Get the ActionQueue for this session

public Batcher getBatcher ()

Get the prepared statement Batcher for this session

public CacheMode getCacheMode ()

Get the current cache mode.

Returns
  • The current cache mode.

public ConnectionReleaseMode getConnectionReleaseMode ()

public Serializable getContextEntityIdentifier (Object object)

Get the id value for an object that is actually associated with the session. This is a bit stricter than getEntityIdentifierIfNotUnsaved().

public LockMode getCurrentLockMode (Object object)

Determine the current lock mode of the given object.

Parameters
object a persistent instance
Returns
  • the current lock mode
Throws
HibernateException

public int getDontFlushFromFind ()

public Filter getEnabledFilter (String filterName)

Retrieve a currently enabled filter by name.

Parameters
filterName The name of the filter to be retrieved.
Returns
  • The Filter instance representing the enabled filter.

public Map getEnabledFilters ()

Return the currently enabled filters. The filter map is keyed by filter name, with values corresponding to the FilterImpl instance.

Returns
  • The currently enabled filters.

public EntityMode getEntityMode ()

Retrieve the entity mode in effect for this session.

Returns
  • The entity mode for this session.

public String getEntityName (Object object)

Return the entity name for a persistent entity

Parameters
object a persistent entity
Returns
  • the entity name

public EntityPersister getEntityPersister (String entityName, Object object)

Get the EntityPersister for any instance

Parameters
entityName optional entity name
object the entity instance

public Object getEntityUsingInterceptor (EntityKey key)

Get the entity instance associated with the given Key, calling the Interceptor if necessary

Throws
HibernateException

public String getFetchProfile ()

Get the internal fetch profile currently associated with this session.

Returns
  • The current internal fetch profile, or null if none currently associated.

public Type getFilterParameterType (String filterParameterName)

Retreive the type for a given filter parrameter.

Parameters
filterParameterName The filter parameter name in the format {FILTER_NAME.PARAMETER_NAME}.
Returns
  • The filter param type

public Object getFilterParameterValue (String filterParameterName)

Retreive the currently set value for a filter parameter.

Parameters
filterParameterName The filter parameter name in the format {FILTER_NAME.PARAMETER_NAME}.
Returns
  • The filter parameter value.

public FlushMode getFlushMode ()

Get the current flush mode for this session.

Returns
  • The flush mode

public Serializable getIdentifier (Object object)

Return the identifier value of the given entity as associated with this session. An exception is thrown if the given entity instance is transient or detached in relation to this session.

Parameters
object a persistent instance
Returns
  • the identifier
Throws
HibernateException

public Interceptor getInterceptor ()

Retrieves the interceptor currently in use by this event source.

Returns
  • The interceptor.

public JDBCContext getJDBCContext ()

public EventListeners getListeners ()

Retrieves the configured event listeners from this event source.

Returns
  • The configured event listeners.

public LoadQueryInfluencers getLoadQueryInfluencers ()

Get the load query influencers associated with this session.

Returns
  • the load query influencers associated with this session; should never be null.

public LobHelper getLobHelper ()

Retrieve this session's helper/delegate for creating LOB instances.

Returns
  • This session's LOB helper

public Query getNamedQuery (String queryName)

Get a Query instance for a named query or named native SQL query

Throws
MappingException

public NonFlushedChanges getNonFlushedChanges ()

Return changes to this session and its child sessions that have not been flushed yet.

Returns
  • The non-flushed changes.
Throws
HibernateException

public PersistenceContext getPersistenceContext ()

Get the persistence context for this session

public Session getSession (EntityMode entityMode)

Starts a new Session with the given entity mode in effect. This secondary Session inherits the connection, transaction, and other context information from the primary Session. It doesn't need to be flushed or closed by the developer.

Parameters
entityMode The entity mode to use for the new session.
Returns
  • The new session

public SessionFactory getSessionFactory ()

Get the session factory which created this session.

Returns
  • The session factory.

public SessionStatistics getStatistics ()

Get the statistics for this session.

public long getTimestamp ()

System time before the start of the transaction

public Transaction getTransaction ()

Get the Transaction instance associated with this session. The class of the returned Transaction object is determined by the property hibernate.transaction_factory.

Returns
  • a Transaction instance
Throws
HibernateException

public TypeHelper getTypeHelper ()

Convenience access to the TypeHelper associated with this session's SessionFactory.

Equivalent to calling getSessionFactory().getTypeHelper()

Returns

public String guessEntityName (Object object)

The guessed entity name for an entity not in an association

Throws
HibernateException

public Object immediateLoad (String entityName, Serializable id)

Load the data for the object with the specified id into a newly created object. This is only called when lazily initializing a proxy. Do NOT return a proxy.

Throws
HibernateException

public void initializeCollection (PersistentCollection collection, boolean writing)

Initialize the collection (if not already initialized)

Throws
HibernateException

public Object instantiate (EntityPersister persister, Serializable id)

give the interceptor an opportunity to override the default instantiation

Throws
HibernateException

public Object instantiate (String entityName, Serializable id)

Instantiate the entity class, initializing with the given identifier

Throws
HibernateException

public Object internalLoad (String entityName, Serializable id, boolean eager, boolean nullable)

Load an instance without checking if it was deleted. When nullable is disabled this method may create a new proxy or return an existing proxy; if it does not exist, throw an exception. When nullable is enabled, the method does not create new proxies (but might return an existing proxy); if it does not exist, return null. When eager is enabled, the object is eagerly fetched

Throws
HibernateException

public boolean isAutoCloseSessionEnabled ()

public boolean isConnected ()

Check if the session is currently connected.

Returns
  • boolean

public boolean isDefaultReadOnly ()

Will entities and proxies that are loaded into this session be made read-only by default? To determine the read-only/modifiable setting for a particular entity or proxy:

Returns
  • true, loaded entities/proxies will be made read-only by default; false, loaded entities/proxies will be made modifiable by default.

public boolean isDirty ()

Does this session contain any changes which must be synchronized with the database? In other words, would any DML operations be executed if we flushed this session?

Returns
  • True if the session contains pending changes; false otherwise.
Throws
HibernateException

public boolean isEventSource ()

public boolean isFetchProfileEnabled (String name)

Is a particular fetch profile enabled on this session?

Parameters
name The name of the profile to be checked.
Returns
  • True if fetch profile is enabled; false if not.
Throws
UnknownProfileException

public boolean isFlushBeforeCompletionEnabled ()

public boolean isFlushModeNever ()

public boolean isOpen ()

Check if the session is still open.

Returns
  • boolean

public boolean isReadOnly (Object entityOrProxy)

Is the specified entity or proxy read-only? To get the default read-only/modifiable setting used for entities and proxies that are loaded into the session:

Parameters
entityOrProxy an entity or HibernateProxy
Returns
  • true, the entity or proxy is read-only; false, the entity or proxy is modifiable.

public boolean isTransactionInProgress ()

Does this Session have an active Hibernate transaction or is there a JTA transaction in progress?

public Iterator iterate (String query, Object[] values, Type[] types)

Execute a query and return the results in an iterator. Write the given values to "?" in the query string. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

Parameters
query the query string
values a list of values to be written to "?" placeholders in the query
types a list of Hibernate types of the values
Returns
  • an iterator
Throws
HibernateException

public Iterator iterate (String query, QueryParameters queryParameters)

Execute an iterate() query

Throws
HibernateException

public Iterator iterate (String query, Object value, Type type)

Execute a query and return the results in an iterator. Write the given value to "?" in the query string. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

Parameters
query the query string
value a value to be witten to a "?" placeholder in the query string
type the hibernate type of value
Returns
  • an iterator
Throws
HibernateException

public Iterator iterate (String query)

Execute a query and return the results in an iterator. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

Parameters
query the query string
Returns
  • an iterator
Throws
HibernateException

public Iterator iterateFilter (Object collection, String filter, QueryParameters queryParameters)

Iterate a filter

Throws
HibernateException

public List list (String query, QueryParameters queryParameters)

Execute a find() query

Throws
HibernateException

public List list (CriteriaImpl criteria)

Execute a criteria query

Throws
HibernateException

public List listCustomQuery (CustomQuery customQuery, QueryParameters queryParameters)

Execute an SQL Query

Throws
HibernateException

public List listFilter (Object collection, String filter, QueryParameters queryParameters)

Execute a filter

Throws
HibernateException

public void load (Object object, Serializable id)

Read the persistent state associated with the given identifier into the given transient instance.

Parameters
object an "empty" instance of the persistent class
id a valid identifier of an existing persistent instance of the class
Throws
HibernateException

public Object load (Class entityClass, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.

Parameters
entityClass a persistent class
id a valid identifier of an existing persistent instance of the class
lockMode the lock level
Returns
  • the persistent instance or proxy
Throws
HibernateException

public Object load (Class entityClass, Serializable id)

Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists. This method might return a proxied instance that is initialized on-demand, when a non-identifier method is accessed.

You should not use this method to determine if an instance exists (use get() instead). Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

Parameters
entityClass a persistent class
id a valid identifier of an existing persistent instance of the class
Returns
  • the persistent instance or proxy
Throws
HibernateException

public Object load (String entityName, Serializable id)

Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists. This method might return a proxied instance that is initialized on-demand, when a non-identifier method is accessed.

You should not use this method to determine if an instance exists (use get() instead). Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

Parameters
entityName a persistent class
id a valid identifier of an existing persistent instance of the class
Returns
  • the persistent instance or proxy
Throws
HibernateException

public Object load (String entityName, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.

Parameters
entityName a persistent class
id a valid identifier of an existing persistent instance of the class
lockMode the lock level
Returns
  • the persistent instance or proxy
Throws
HibernateException

public Object load (String entityName, Serializable id, LockOptions lockOptions)

Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.

Parameters
entityName a persistent class
id a valid identifier of an existing persistent instance of the class
lockOptions contains the lock level
Returns
  • the persistent instance or proxy
Throws
HibernateException

public Object load (Class entityClass, Serializable id, LockOptions lockOptions)

Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.

Parameters
entityClass a persistent class
id a valid identifier of an existing persistent instance of the class
lockOptions contains the lock level
Returns
  • the persistent instance or proxy
Throws
HibernateException

public void lock (String entityName, Object object, LockMode lockMode)

Obtain the specified lock level upon the given object. This may be used to perform a version check (LockMode.OPTIMISTIC), to upgrade to a pessimistic lock (LockMode.PESSIMISTIC_WRITE), or to simply reassociate a transient instance with a session (LockMode.NONE). This operation cascades to associated instances if the association is mapped with cascade="lock".

Parameters
object a persistent or transient instance
lockMode the lock level
Throws
HibernateException

public void lock (Object object, LockMode lockMode)

Obtain the specified lock level upon the given object. This may be used to perform a version check (LockMode.READ), to upgrade to a pessimistic lock (LockMode.PESSIMISTIC_WRITE), or to simply reassociate a transient instance with a session (LockMode.NONE). This operation cascades to associated instances if the association is mapped with cascade="lock".

Parameters
object a persistent or transient instance
lockMode the lock level
Throws
HibernateException

public void managedClose ()

public void managedFlush ()

public void merge (String entityName, Object object, Map copiedAlready)

Cascade merge an entity instance

Throws
HibernateException

public Object merge (Object object)

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy of and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with cascade="merge".

The semantics of this method are defined by JSR-220.

Parameters
object a detached instance with state to be copied
Returns
  • an updated persistent instance
Throws
HibernateException

public Object merge (String entityName, Object object)

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy of and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with cascade="merge".

The semantics of this method are defined by JSR-220.

Parameters
object a detached instance with state to be copied
Returns
  • an updated persistent instance
Throws
HibernateException

public void persist (Object object)

Make a transient instance persistent. This operation cascades to associated instances if the association is mapped with cascade="persist".

The semantics of this method are defined by JSR-220.

Parameters
object a transient instance to be made persistent
Throws
HibernateException

public void persist (String entityName, Object object)

Make a transient instance persistent. This operation cascades to associated instances if the association is mapped with cascade="persist".

The semantics of this method are defined by JSR-220.

Parameters
object a transient instance to be made persistent
Throws
HibernateException

public void persist (String entityName, Object object, Map copiedAlready)

Cascade persist an entity instance

Throws
HibernateException

public void persistOnFlush (String entityName, Object object)

Throws
HibernateException

public void persistOnFlush (String entityName, Object object, Map copiedAlready)

Cascade persist an entity instance during the flush process

Throws
HibernateException

public void persistOnFlush (Object object)

Throws
HibernateException

public void reconnect (Connection conn)

Reconnect to the given JDBC connection. This is used by applications which require long transactions and use application-supplied connections.

Parameters
conn a JDBC connection
Throws
HibernateException

public void reconnect ()

Obtain a new JDBC connection. This is used by applications which require long transactions and do not supply connections to the session.

Throws
HibernateException

public void refresh (Object object, LockOptions lockOptions)

Re-read the state of the given instance from the underlying database, with the given LockMode. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances.

Parameters
object a persistent or detached instance
lockOptions contains the lock mode to use
Throws
HibernateException

public void refresh (Object object)

Re-read the state of the given instance from the underlying database. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances. For example

  • where a database trigger alters the object state upon insert or update
  • after executing direct SQL (eg. a mass update) in the same session
  • after inserting a Blob or Clob

Parameters
object a persistent or detached instance
Throws
HibernateException

public void refresh (Object object, Map refreshedAlready)

Cascade refesh an entity instance

Throws
HibernateException

public void refresh (Object object, LockMode lockMode)

Re-read the state of the given instance from the underlying database, with the given LockMode. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances.

Parameters
object a persistent or detached instance
lockMode the lock mode to use
Throws
HibernateException

public void replicate (String entityName, Object obj, ReplicationMode replicationMode)

Persist the state of the given detached instance, reusing the current identifier value. This operation cascades to associated instances if the association is mapped with cascade="replicate".

Parameters
obj a detached instance of a persistent class
Throws
HibernateException

public void replicate (Object obj, ReplicationMode replicationMode)

Persist the state of the given detached instance, reusing the current identifier value. This operation cascades to associated instances if the association is mapped with cascade="replicate".

Parameters
obj a detached instance of a persistent class
Throws
HibernateException

public void save (String entityName, Object object, Serializable id)

Persist the given transient instance, using the given identifier. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
object a transient instance of a persistent class
id an unused valid identifier
Throws
HibernateException

public Serializable save (Object obj)

Persist the given transient instance, first assigning a generated identifier. (Or using the current value of the identifier property if the assigned generator is used.) This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
obj a transient instance of a persistent class
Returns
  • the generated identifier
Throws
HibernateException

public Serializable save (String entityName, Object object)

Persist the given transient instance, first assigning a generated identifier. (Or using the current value of the identifier property if the assigned generator is used.) This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
object a transient instance of a persistent class
Returns
  • the generated identifier
Throws
HibernateException

public void save (Object obj, Serializable id)

Persist the given transient instance, using the given identifier. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
obj a transient instance of a persistent class
id an unused valid identifier
Throws
HibernateException

public void saveOrUpdate (String entityName, Object obj)

Either save(String, Object) or update(String, Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).

This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
obj a transient or detached instance containing new or updated state
Throws
HibernateException

public void saveOrUpdate (Object object)

Either save(Object) or update(Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).

This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
object a transient or detached instance containing new or updated state
Throws
HibernateException

public Object saveOrUpdateCopy (Object object)

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved or does not exist in the database, save it and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters
object a transient instance with state to be copied
Returns
  • an updated persistent instance
Throws
HibernateException

public Object saveOrUpdateCopy (String entityName, Object object, Serializable id)

Copy the state of the given object onto the persistent object with the given identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If there is no database row with the given identifier, save the given instance and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters
object a persistent or transient instance with state to be copied
id the identifier of the instance to copy to
Returns
  • an updated persistent instance
Throws
HibernateException

public Object saveOrUpdateCopy (Object object, Serializable id)

Copy the state of the given object onto the persistent object with the given identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If there is no database row with the given identifier, save the given instance and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters
object a persistent or transient instance with state to be copied
id the identifier of the instance to copy to
Returns
  • an updated persistent instance
Throws
HibernateException

public Object saveOrUpdateCopy (String entityName, Object object)

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved or does not exist in the database, save it and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters
object a transient instance with state to be copied
Returns
  • an updated persistent instance
Throws
HibernateException

public void saveOrUpdateCopy (String entityName, Object object, Map copiedAlready)

Cascade copy an entity instance

Throws
HibernateException

public ScrollableResults scroll (CriteriaImpl criteria, ScrollMode scrollMode)

Execute a criteria query

public ScrollableResults scroll (String query, QueryParameters queryParameters)

Execute a scroll() query

Throws
HibernateException

public ScrollableResults scrollCustomQuery (CustomQuery customQuery, QueryParameters queryParameters)

Execute an SQL Query

Throws
HibernateException

public void setAutoClear (boolean enabled)

Enable/disable automatic cache clearing from after transaction completion (for EJB3)

public void setCacheMode (CacheMode cacheMode)

Set the cache mode.

Cache mode determines the manner in which this session can interact with the second level cache.

Parameters
cacheMode The new cache mode.

public void setDefaultReadOnly (boolean defaultReadOnly)

Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from modifiable to read-only mode. Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted. When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting. To change the read-only/modifiable setting for a particular entity or proxy that is already in this session:

Parameters
defaultReadOnly true, the default for loaded entities/proxies is read-only; false, the default for loaded entities/proxies is modifiable

public void setFetchProfile (String fetchProfile)

Set the current internal fetch profile for this session.

Parameters
fetchProfile The internal fetch profile name to use

public void setFlushMode (FlushMode flushMode)

Set the flush mode for this session.

The flush mode determines the points at which the session is flushed. Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

For a logically "read only" session, it is reasonable to set the session's flush mode to MANUAL at the start of the session (in order to achieve some extra performance).

Parameters
flushMode the new flush mode

public void setReadOnly (Object entity, boolean readOnly)

Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode. In read-only mode, no snapshot is maintained, the instance is never dirty checked, and changes are not persisted. If the entity or proxy already has the specified read-only/modifiable setting, then this method does nothing. To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session:

Parameters
entity an entity or HibernateProxy
readOnly if true, the entity or proxy is made read-only; if false, the entity or proxy is made modifiable.

public boolean shouldAutoClose ()

public String toString ()

public void update (String entityName, Object object, Serializable id)

Update the persistent state associated with the given identifier. An exception is thrown if there is a persistent instance with the same identifier in the current session. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
object a detached instance containing updated state
id identifier of persistent instance
Throws
HibernateException

public void update (Object obj)

Update the persistent instance with the identifier of the given detached instance. If there is a persistent instance with the same identifier, an exception is thrown. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
obj a detached instance containing updated state
Throws
HibernateException

public void update (Object obj, Serializable id)

Update the persistent state associated with the given identifier. An exception is thrown if there is a persistent instance with the same identifier in the current session. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
obj a detached instance containing updated state
id identifier of persistent instance
Throws
HibernateException

public void update (String entityName, Object object)

Update the persistent instance with the identifier of the given detached instance. If there is a persistent instance with the same identifier, an exception is thrown. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters
object a detached instance containing updated state
Throws
HibernateException

Protected Methods

protected boolean autoFlushIfRequired (Set querySpaces)

detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush

Throws
HibernateException