org.hibernate.engine

Class StatefulPersistenceContext

java.lang.Object

org.hibernate.engine.StatefulPersistenceContext

All Implemented Interfaces:

PersistenceContext

public class StatefulPersistenceContext
extends java.lang.Object
implements PersistenceContext

A PersistenceContext represents the state of persistent "stuff" which Hibernate is tracking. This includes persistent entities, collections, as well as proxies generated.

There is meant to be a one-to-one correspondence between a SessionImpl and a PersistentContext. The SessionImpl uses the PersistentContext to track the current state of its context. Event-listeners then use the PersistentContext to drive their processing.

Author:

Steve Ebersole

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	NO_ROW

Constructor Summary

Constructors

Constructor and Description
StatefulPersistenceContext(SessionImplementor session) Constructs a PersistentContext, bound to the given session.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildParent(java.lang.Object child, java.lang.Object parent) Put child/parent relation to cache for cascading op
void	addCollectionHolder(PersistentCollection holder) Register a PersistentCollection object for an array.
void	addEntity(EntityKey key, java.lang.Object entity) Add a canonical mapping from entity key to entity instance
void	addEntity(EntityUniqueKey euk, java.lang.Object entity) Add an entity to the cache by unique key
EntityEntry	addEntity(java.lang.Object entity, Status status, java.lang.Object[] loadedState, EntityKey entityKey, java.lang.Object version, LockMode lockMode, boolean existsInDatabase, EntityPersister persister, boolean disableVersionIncrement, boolean lazyPropertiesAreUnfetched) Adds an entity to the internal caches.
EntityEntry	addEntry(java.lang.Object entity, Status status, java.lang.Object[] loadedState, java.lang.Object rowId, java.io.Serializable id, java.lang.Object version, LockMode lockMode, boolean existsInDatabase, EntityPersister persister, boolean disableVersionIncrement, boolean lazyPropertiesAreUnfetched) Generates an appropriate EntityEntry instance and adds it to the event source's internal caches.
CollectionEntry	addInitializedCollection(CollectionPersister persister, PersistentCollection collection, java.io.Serializable id) add a collection we just pulled out of the cache (does not need initializing)
void	addInitializedDetachedCollection(CollectionPersister collectionPersister, PersistentCollection collection) add an (initialized) collection that was created by another session and passed into update() (ie.
void	addNewCollection(CollectionPersister persister, PersistentCollection collection) Add a new collection (ie.
void	addNonLazyCollection(PersistentCollection collection) Register a collection for non-lazy loading at the end of the two-phase load
void	addNullProperty(EntityKey ownerKey, java.lang.String propertyName) Record the fact that the association belonging to the keyed entity is null.
void	addProxy(EntityKey key, java.lang.Object proxy) Add a proxy to the session cache
void	addUninitializedCollection(CollectionPersister persister, PersistentCollection collection, java.io.Serializable id) add a collection we just loaded up (still needs initializing)
void	addUninitializedDetachedCollection(CollectionPersister persister, PersistentCollection collection) add a detached uninitialized collection
void	addUnownedCollection(CollectionKey key, PersistentCollection collection) Add a collection which has no owner loaded
void	afterLoad() Call this after finishing a two-phase load
void	afterTransactionCompletion() Called after transactions end
void	beforeLoad() Call this before begining a two-phase load
void	checkUniqueness(EntityKey key, java.lang.Object object) Attempts to check whether the given key represents an entity already loaded within the current session.
void	clear() Clear the state of the persistence context
boolean	containsCollection(PersistentCollection collection) Is the given collection associated with this persistence context?
boolean	containsEntity(EntityKey key) Is there an entity with the given key in the persistence context
boolean	containsProxy(java.lang.Object entity) Is the given proxy associated with this persistence context?
int	decrementCascadeLevel() Called after cascading
static StatefulPersistenceContext	deserialize(java.io.ObjectInputStream ois, SessionImplementor session)
BatchFetchQueue	getBatchFetchQueue() Get the BatchFetchQueue, instantiating one if necessary.
java.lang.Object[]	getCachedDatabaseSnapshot(EntityKey key) Retrieve the cached database snapshot for the requested entity key.
int	getCascadeLevel() Do we already know that the entity does not exist in the database?
PersistentCollection	getCollection(CollectionKey collectionKey) Get the collection instance associated with the CollectionKey
java.util.Map	getCollectionEntries() Get the mapping from collection instance to collection entry
CollectionEntry	getCollectionEntry(PersistentCollection coll) Get the collection entry for a persistent collection
CollectionEntry	getCollectionEntryOrNull(java.lang.Object collection) Get the collection entry for a collection passed to filter, which might be a collection wrapper, an array, or an unwrapped collection.
PersistentCollection	getCollectionHolder(java.lang.Object array) Get the PersistentCollection object for an array
java.lang.Object	getCollectionOwner(java.io.Serializable key, CollectionPersister collectionPersister) Get the entity that owns this persistent collection
java.util.Map	getCollectionsByKey() Get the mapping from collection key to collection instance
java.lang.Object[]	getDatabaseSnapshot(java.io.Serializable id, EntityPersister persister) Get the current state of the entity as known to the underlying database, or null if there is no corresponding row
java.util.Map	getEntitiesByKey() Get the mapping from key value to entity instance
java.lang.Object	getEntity(EntityKey key) Get the entity instance associated with the given EntityKey
java.lang.Object	getEntity(EntityUniqueKey euk) Get an entity cached by unique key
java.util.Map	getEntityEntries() Get the mapping from entity instance to entity entry
EntityEntry	getEntry(java.lang.Object entity) Retreive the EntityEntry representation of the given entity.
java.lang.Object	getIndexInOwner(java.lang.String entity, java.lang.String property, java.lang.Object childEntity, java.util.Map mergeMap) Search the persistence context for an index of the child object, given a collection role
LoadContexts	getLoadContexts() Retrieve this persistence context's managed load context.
java.io.Serializable	getLoadedCollectionOwnerIdOrNull(PersistentCollection collection) Get the ID for the entity that owned this persistent collection when it was loaded
java.lang.Object	getLoadedCollectionOwnerOrNull(PersistentCollection collection) Get the entity that owned this persistent collection when it was loaded
java.lang.Object[]	getNaturalIdSnapshot(java.io.Serializable id, EntityPersister persister) Get the values of the natural id fields as known to the underlying database, or null if the entity has no natural id or there is no corresponding row.
java.util.HashSet	getNullifiableEntityKeys() Retrieve the set of EntityKeys representing nullifiable references
java.io.Serializable	getOwnerId(java.lang.String entityName, java.lang.String propertyName, java.lang.Object childEntity, java.util.Map mergeMap) Search this persistence context for an associated entity instance which is considered the "owner" of the given childEntity, and return that owner's id value.
java.util.Map	getProxiesByKey()
java.lang.Object	getProxy(EntityKey key) Get an existing proxy by key
SessionImplementor	getSession() Get the session to which this persistence context is bound.
java.io.Serializable	getSnapshot(PersistentCollection coll) Get the snapshot of the pre-flush collection state
boolean	hasNonReadOnlyEntities()
int	incrementCascadeLevel() Called before cascading
void	initializeNonLazyCollections() Force initialization of all non-lazy collections encountered during the current two-phase load (actually, this is a no-op, unless this is the "outermost" load)
boolean	isDefaultReadOnly() Will entities and proxies that are loaded into this persistence context be made read-only by default? To determine the read-only/modifiable setting for a particular entity or proxy:
boolean	isEntryFor(java.lang.Object entity) Is there an EntityEntry for this instance?
boolean	isFlushing() Is a flush cycle currently in process?
boolean	isLoadFinished() Is in a two-phase load?
boolean	isPropertyNull(EntityKey ownerKey, java.lang.String propertyName) Is the association property belonging to the keyed entity null?
boolean	isReadOnly(java.lang.Object entityOrProxy) Is the 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	isStateless()
java.lang.Object	narrowProxy(java.lang.Object proxy, EntityPersister persister, EntityKey key, java.lang.Object object) If the existing proxy is insufficiently "narrow" (derived), instantiate a new proxy and overwrite the registration of the old one.
java.lang.Object	proxyFor(EntityPersister persister, EntityKey key, java.lang.Object impl) Return the existing proxy associated with the given EntityKey, or the third argument (the entity associated with the key) if no proxy exists.
java.lang.Object	proxyFor(java.lang.Object impl) Return the existing proxy associated with the given EntityKey, or the argument (the entity associated with the key) if no proxy exists.
boolean	reassociateIfUninitializedProxy(java.lang.Object value) Takes the given object and, if it represents a proxy, reassociates it with this event source.
void	reassociateProxy(java.lang.Object value, java.io.Serializable id) If a deleted entity instance is re-saved, and it has a proxy, we need to reset the identifier of the proxy
void	registerInsertedKey(EntityPersister persister, java.io.Serializable id) Register keys inserted during the current transaction
void	removeChildParent(java.lang.Object child) Remove child/parent relation from cache
PersistentCollection	removeCollectionHolder(java.lang.Object array) Remove the mapping of collection to holder during eviction of the owning entity
java.lang.Object	removeEntity(EntityKey key) Remove an entity from the session cache, also clear up other state associated with the entity, all except for the EntityEntry
EntityEntry	removeEntry(java.lang.Object entity) Remove an entity entry from the session cache
java.lang.Object	removeProxy(EntityKey key) Remove a proxy from the session cache.
void	replaceDelayedEntityIdentityInsertKeys(EntityKey oldKey, java.io.Serializable generatedId)
void	serialize(java.io.ObjectOutputStream oos) Used by the owning session to explicitly control serialization of the persistence context.
void	setDefaultReadOnly(boolean defaultReadOnly) Change the default for entities and proxies loaded into this persistence context from modifiable to read-only mode, or from modifiable to read-only mode.
void	setEntryStatus(EntityEntry entry, Status status) Set the status of an entry
void	setFlushing(boolean flushing) Called before and after the flushcycle
void	setReadOnly(java.lang.Object object, boolean readOnly) Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode.
java.lang.String	toString() Returns a string representation of the object.
java.lang.Object	unproxy(java.lang.Object maybeProxy) Get the entity instance underlying the given proxy, throwing an exception if the proxy is uninitialized.
java.lang.Object	unproxyAndReassociate(java.lang.Object maybeProxy) Possibly unproxy the given reference and reassociate it with the current session.
PersistentCollection	useUnownedCollection(CollectionKey key) Get and remove a collection whose owner is not yet loaded, when its owner is being loaded
boolean	wasInsertedDuringTransaction(EntityPersister persister, java.io.Serializable id) Allows callers to check to see if the identified entity was inserted during the current transaction.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ROW

public static final java.lang.Object NO_ROW

Constructor Detail

StatefulPersistenceContext

public StatefulPersistenceContext(SessionImplementor session)

Constructs a PersistentContext, bound to the given session.

Parameters:

session - The session "owning" this context.

Method Detail

isStateless

public boolean isStateless()

Specified by:

isStateless in interface PersistenceContext

getSession

public SessionImplementor getSession()

Description copied from interface: PersistenceContext

Get the session to which this persistence context is bound.

Specified by:

getSession in interface PersistenceContext

Returns:

The session.

getLoadContexts

public LoadContexts getLoadContexts()

Description copied from interface: PersistenceContext

Retrieve this persistence context's managed load context.

Specified by:

getLoadContexts in interface PersistenceContext

Returns:

The load context

addUnownedCollection

public void addUnownedCollection(CollectionKey key,
                        PersistentCollection collection)

Description copied from interface: PersistenceContext

Add a collection which has no owner loaded

Specified by:

addUnownedCollection in interface PersistenceContext

useUnownedCollection

public PersistentCollection useUnownedCollection(CollectionKey key)

Description copied from interface: PersistenceContext

Get and remove a collection whose owner is not yet loaded, when its owner is being loaded

Specified by:

useUnownedCollection in interface PersistenceContext

getBatchFetchQueue

public BatchFetchQueue getBatchFetchQueue()

Get the BatchFetchQueue, instantiating one if necessary.

Specified by:

getBatchFetchQueue in interface PersistenceContext

clear

public void clear()

Description copied from interface: PersistenceContext

Clear the state of the persistence context

Specified by:

clear in interface PersistenceContext

isDefaultReadOnly

public boolean isDefaultReadOnly()

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

Specified by:

isDefaultReadOnly in interface PersistenceContext

Returns:

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

See Also:

PersistenceContext.isReadOnly(Object), Session.isReadOnly(Object), Session.isDefaultReadOnly()

setDefaultReadOnly

public void setDefaultReadOnly(boolean defaultReadOnly)

Change the default for entities and proxies loaded into this persistence context 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 persistence context's current setting. To change the read-only/modifiable setting for a particular entity or proxy that is already in this session: + * @see PersistenceContext#setReadOnly(Object,boolean)

Specified by:

setDefaultReadOnly in interface PersistenceContext

Parameters:

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

See Also:

To override this session's read-only/modifiable setting for entities and proxies loaded by a Query:, Query.setReadOnly(boolean), Session.setDefaultReadOnly(boolean)

hasNonReadOnlyEntities

public boolean hasNonReadOnlyEntities()

Specified by:

hasNonReadOnlyEntities in interface PersistenceContext

Returns:

false if we know for certain that all the entities are read-only

setEntryStatus

public void setEntryStatus(EntityEntry entry,
                  Status status)

Description copied from interface: PersistenceContext

Set the status of an entry

Specified by:

setEntryStatus in interface PersistenceContext

afterTransactionCompletion

public void afterTransactionCompletion()

Description copied from interface: PersistenceContext

Called after transactions end

Specified by:

afterTransactionCompletion in interface PersistenceContext

getDatabaseSnapshot

public java.lang.Object[] getDatabaseSnapshot(java.io.Serializable id,
                                     EntityPersister persister)
                                       throws HibernateException

Get the current state of the entity as known to the underlying database, or null if there is no corresponding row

Specified by:

getDatabaseSnapshot in interface PersistenceContext

Throws:

HibernateException

getNaturalIdSnapshot

public java.lang.Object[] getNaturalIdSnapshot(java.io.Serializable id,
                                      EntityPersister persister)
                                        throws HibernateException

Description copied from interface: PersistenceContext

Get the values of the natural id fields as known to the underlying database, or null if the entity has no natural id or there is no corresponding row.

Specified by:

getNaturalIdSnapshot in interface PersistenceContext

Throws:

HibernateException

getCachedDatabaseSnapshot

public java.lang.Object[] getCachedDatabaseSnapshot(EntityKey key)

Retrieve the cached database snapshot for the requested entity key.

This differs from getDatabaseSnapshot(java.io.Serializable, org.hibernate.persister.entity.EntityPersister) is two important respects:

1. no snapshot is obtained from the database if not already cached
2. an entry of NO_ROW here is interpretet as an exception

Specified by:

getCachedDatabaseSnapshot in interface PersistenceContext

Parameters:

key - The entity key for which to retrieve the cached snapshot

Returns:

The cached snapshot

Throws:

java.lang.IllegalStateException - if the cached snapshot was == NO_ROW.

addEntity

public void addEntity(EntityKey key,
             java.lang.Object entity)

Description copied from interface: PersistenceContext

Add a canonical mapping from entity key to entity instance

Specified by:

addEntity in interface PersistenceContext

getEntity

public java.lang.Object getEntity(EntityKey key)

Get the entity instance associated with the given EntityKey

Specified by:

getEntity in interface PersistenceContext

containsEntity

public boolean containsEntity(EntityKey key)

Description copied from interface: PersistenceContext

Is there an entity with the given key in the persistence context

Specified by:

containsEntity in interface PersistenceContext

removeEntity

public java.lang.Object removeEntity(EntityKey key)

Remove an entity from the session cache, also clear up other state associated with the entity, all except for the EntityEntry

Specified by:

removeEntity in interface PersistenceContext

getEntity

public java.lang.Object getEntity(EntityUniqueKey euk)

Get an entity cached by unique key

Specified by:

getEntity in interface PersistenceContext

addEntity

public void addEntity(EntityUniqueKey euk,
             java.lang.Object entity)

Add an entity to the cache by unique key

Specified by:

addEntity in interface PersistenceContext

getEntry

public EntityEntry getEntry(java.lang.Object entity)

Retreive the EntityEntry representation of the given entity.

Specified by:

getEntry in interface PersistenceContext

Parameters:

entity - The entity for which to locate the EntityEntry.

Returns:

The EntityEntry for the given entity.

removeEntry

public EntityEntry removeEntry(java.lang.Object entity)

Remove an entity entry from the session cache

Specified by:

removeEntry in interface PersistenceContext

isEntryFor

public boolean isEntryFor(java.lang.Object entity)

Is there an EntityEntry for this instance?

Specified by:

isEntryFor in interface PersistenceContext

getCollectionEntry

public CollectionEntry getCollectionEntry(PersistentCollection coll)

Get the collection entry for a persistent collection

Specified by:

getCollectionEntry in interface PersistenceContext

addEntity

public EntityEntry addEntity(java.lang.Object entity,
                    Status status,
                    java.lang.Object[] loadedState,
                    EntityKey entityKey,
                    java.lang.Object version,
                    LockMode lockMode,
                    boolean existsInDatabase,
                    EntityPersister persister,
                    boolean disableVersionIncrement,
                    boolean lazyPropertiesAreUnfetched)

Adds an entity to the internal caches.

Specified by:

addEntity in interface PersistenceContext

addEntry

public EntityEntry addEntry(java.lang.Object entity,
                   Status status,
                   java.lang.Object[] loadedState,
                   java.lang.Object rowId,
                   java.io.Serializable id,
                   java.lang.Object version,
                   LockMode lockMode,
                   boolean existsInDatabase,
                   EntityPersister persister,
                   boolean disableVersionIncrement,
                   boolean lazyPropertiesAreUnfetched)

Generates an appropriate EntityEntry instance and adds it to the event source's internal caches.

Specified by:

addEntry in interface PersistenceContext

containsCollection

public boolean containsCollection(PersistentCollection collection)

Description copied from interface: PersistenceContext

Is the given collection associated with this persistence context?

Specified by:

containsCollection in interface PersistenceContext

containsProxy

public boolean containsProxy(java.lang.Object entity)

Description copied from interface: PersistenceContext

Is the given proxy associated with this persistence context?

Specified by:

containsProxy in interface PersistenceContext

reassociateIfUninitializedProxy

public boolean reassociateIfUninitializedProxy(java.lang.Object value)
                                        throws MappingException

Takes the given object and, if it represents a proxy, reassociates it with this event source.

Specified by:

reassociateIfUninitializedProxy in interface PersistenceContext

Parameters:

value - The possible proxy to be reassociated.

Returns:

Whether the passed value represented an actual proxy which got initialized.

Throws:

MappingException

reassociateProxy

public void reassociateProxy(java.lang.Object value,
                    java.io.Serializable id)
                      throws MappingException

If a deleted entity instance is re-saved, and it has a proxy, we need to reset the identifier of the proxy

Specified by:

reassociateProxy in interface PersistenceContext

Throws:

MappingException

unproxy

public java.lang.Object unproxy(java.lang.Object maybeProxy)
                         throws HibernateException

Get the entity instance underlying the given proxy, throwing an exception if the proxy is uninitialized. If the given object is not a proxy, simply return the argument.

Specified by:

unproxy in interface PersistenceContext

Throws:

HibernateException

unproxyAndReassociate

public java.lang.Object unproxyAndReassociate(java.lang.Object maybeProxy)
                                       throws HibernateException

Possibly unproxy the given reference and reassociate it with the current session.

Specified by:

unproxyAndReassociate in interface PersistenceContext

Parameters:

maybeProxy - The reference to be unproxied if it currently represents a proxy.

Returns:

The unproxied instance.

Throws:

HibernateException

checkUniqueness

public void checkUniqueness(EntityKey key,
                   java.lang.Object object)
                     throws HibernateException

Attempts to check whether the given key represents an entity already loaded within the current session.

Specified by:

checkUniqueness in interface PersistenceContext

Parameters:

object - The entity reference against which to perform the uniqueness check.

Throws:

HibernateException

narrowProxy

public java.lang.Object narrowProxy(java.lang.Object proxy,
                           EntityPersister persister,
                           EntityKey key,
                           java.lang.Object object)
                             throws HibernateException

If the existing proxy is insufficiently "narrow" (derived), instantiate a new proxy and overwrite the registration of the old one. This breaks == and occurs only for "class" proxies rather than "interface" proxies. Also init the proxy to point to the given target implementation if necessary.

Specified by:

narrowProxy in interface PersistenceContext

Parameters:

proxy - The proxy instance to be narrowed.

persister - The persister for the proxied entity.

key - The internal cache key for the proxied entity.

object - (optional) the actual proxied entity instance.

Returns:

An appropriately narrowed instance.

Throws:

HibernateException

proxyFor

public java.lang.Object proxyFor(EntityPersister persister,
                        EntityKey key,
                        java.lang.Object impl)
                          throws HibernateException

Return the existing proxy associated with the given EntityKey, or the third argument (the entity associated with the key) if no proxy exists. Init the proxy to the target implementation, if necessary.

Specified by:

proxyFor in interface PersistenceContext

Throws:

HibernateException

proxyFor

public java.lang.Object proxyFor(java.lang.Object impl)
                          throws HibernateException

Return the existing proxy associated with the given EntityKey, or the argument (the entity associated with the key) if no proxy exists. (slower than the form above)

Specified by:

proxyFor in interface PersistenceContext

Throws:

HibernateException

getCollectionOwner

public java.lang.Object getCollectionOwner(java.io.Serializable key,
                                  CollectionPersister collectionPersister)
                                    throws MappingException

Get the entity that owns this persistent collection

Specified by:

getCollectionOwner in interface PersistenceContext

Throws:

MappingException

getLoadedCollectionOwnerOrNull

public java.lang.Object getLoadedCollectionOwnerOrNull(PersistentCollection collection)

Get the entity that owned this persistent collection when it was loaded

Specified by:

getLoadedCollectionOwnerOrNull in interface PersistenceContext

Parameters:

collection - The persistent collection

Returns:

the owner, if its entity ID is available from the collection's loaded key and the owner entity is in the persistence context; otherwise, returns null

getLoadedCollectionOwnerIdOrNull

public java.io.Serializable getLoadedCollectionOwnerIdOrNull(PersistentCollection collection)

Get the ID for the entity that owned this persistent collection when it was loaded

Specified by:

getLoadedCollectionOwnerIdOrNull in interface PersistenceContext

Parameters:

collection - The persistent collection

Returns:

the owner ID if available from the collection's loaded key; otherwise, returns null

addUninitializedCollection

public void addUninitializedCollection(CollectionPersister persister,
                              PersistentCollection collection,
                              java.io.Serializable id)

add a collection we just loaded up (still needs initializing)

Specified by:

addUninitializedCollection in interface PersistenceContext

addUninitializedDetachedCollection

public void addUninitializedDetachedCollection(CollectionPersister persister,
                                      PersistentCollection collection)

add a detached uninitialized collection

Specified by:

addUninitializedDetachedCollection in interface PersistenceContext

addNewCollection

public void addNewCollection(CollectionPersister persister,
                    PersistentCollection collection)
                      throws HibernateException

Add a new collection (ie. a newly created one, just instantiated by the application, with no database state or snapshot)

Specified by:

addNewCollection in interface PersistenceContext

Parameters:

collection - The collection to be associated with the persistence context

Throws:

HibernateException

addInitializedDetachedCollection

public void addInitializedDetachedCollection(CollectionPersister collectionPersister,
                                    PersistentCollection collection)
                                      throws HibernateException

add an (initialized) collection that was created by another session and passed into update() (ie. one with a snapshot and existing state on the database)

Specified by:

addInitializedDetachedCollection in interface PersistenceContext

Throws:

HibernateException

addInitializedCollection

public CollectionEntry addInitializedCollection(CollectionPersister persister,
                                       PersistentCollection collection,
                                       java.io.Serializable id)
                                         throws HibernateException

add a collection we just pulled out of the cache (does not need initializing)

Specified by:

addInitializedCollection in interface PersistenceContext

Throws:

HibernateException

getCollection

public PersistentCollection getCollection(CollectionKey collectionKey)

Get the collection instance associated with the CollectionKey

Specified by:

getCollection in interface PersistenceContext

addNonLazyCollection

public void addNonLazyCollection(PersistentCollection collection)

Register a collection for non-lazy loading at the end of the two-phase load

Specified by:

addNonLazyCollection in interface PersistenceContext

initializeNonLazyCollections

public void initializeNonLazyCollections()
                                  throws HibernateException

Force initialization of all non-lazy collections encountered during the current two-phase load (actually, this is a no-op, unless this is the "outermost" load)

Specified by:

initializeNonLazyCollections in interface PersistenceContext

Throws:

HibernateException

getCollectionHolder

public PersistentCollection getCollectionHolder(java.lang.Object array)

Get the PersistentCollection object for an array

Specified by:

getCollectionHolder in interface PersistenceContext

addCollectionHolder

public void addCollectionHolder(PersistentCollection holder)

Register a PersistentCollection object for an array. Associates a holder with an array - MUST be called after loading array, since the array instance is not created until endLoad().

Specified by:

addCollectionHolder in interface PersistenceContext

removeCollectionHolder

public PersistentCollection removeCollectionHolder(java.lang.Object array)

Description copied from interface: PersistenceContext

Remove the mapping of collection to holder during eviction of the owning entity

Specified by:

removeCollectionHolder in interface PersistenceContext

getSnapshot

public java.io.Serializable getSnapshot(PersistentCollection coll)

Get the snapshot of the pre-flush collection state

Specified by:

getSnapshot in interface PersistenceContext

getCollectionEntryOrNull

public CollectionEntry getCollectionEntryOrNull(java.lang.Object collection)

Get the collection entry for a collection passed to filter, which might be a collection wrapper, an array, or an unwrapped collection. Return null if there is no entry.

Specified by:

getCollectionEntryOrNull in interface PersistenceContext

getProxy

public java.lang.Object getProxy(EntityKey key)

Get an existing proxy by key

Specified by:

getProxy in interface PersistenceContext

addProxy

public void addProxy(EntityKey key,
            java.lang.Object proxy)

Add a proxy to the session cache

Specified by:

addProxy in interface PersistenceContext

removeProxy

public java.lang.Object removeProxy(EntityKey key)

Remove a proxy from the session cache.

Additionally, ensure that any load optimization references such as batch or subselect loading get cleaned up as well.

Specified by:

removeProxy in interface PersistenceContext

Parameters:

key - The key of the entity proxy to be removed

Returns:

The proxy reference.

getNullifiableEntityKeys

public java.util.HashSet getNullifiableEntityKeys()

Retrieve the set of EntityKeys representing nullifiable references

Specified by:

getNullifiableEntityKeys in interface PersistenceContext

getEntitiesByKey

public java.util.Map getEntitiesByKey()

Description copied from interface: PersistenceContext

Get the mapping from key value to entity instance

Specified by:

getEntitiesByKey in interface PersistenceContext

getProxiesByKey

public java.util.Map getProxiesByKey()

getEntityEntries

public java.util.Map getEntityEntries()

Description copied from interface: PersistenceContext

Get the mapping from entity instance to entity entry

Specified by:

getEntityEntries in interface PersistenceContext

getCollectionEntries

public java.util.Map getCollectionEntries()

Description copied from interface: PersistenceContext

Get the mapping from collection instance to collection entry

Specified by:

getCollectionEntries in interface PersistenceContext

getCollectionsByKey

public java.util.Map getCollectionsByKey()

Description copied from interface: PersistenceContext

Get the mapping from collection key to collection instance

Specified by:

getCollectionsByKey in interface PersistenceContext

getCascadeLevel

public int getCascadeLevel()

Do we already know that the entity does not exist in the database?

Specified by:

getCascadeLevel in interface PersistenceContext

incrementCascadeLevel

public int incrementCascadeLevel()

Description copied from interface: PersistenceContext

Called before cascading

Specified by:

incrementCascadeLevel in interface PersistenceContext

decrementCascadeLevel

public int decrementCascadeLevel()

Description copied from interface: PersistenceContext

Called after cascading

Specified by:

decrementCascadeLevel in interface PersistenceContext

isFlushing

public boolean isFlushing()

Description copied from interface: PersistenceContext

Is a flush cycle currently in process?

Specified by:

isFlushing in interface PersistenceContext

setFlushing

public void setFlushing(boolean flushing)

Description copied from interface: PersistenceContext

Called before and after the flushcycle

Specified by:

setFlushing in interface PersistenceContext

beforeLoad

public void beforeLoad()

Call this before begining a two-phase load

Specified by:

beforeLoad in interface PersistenceContext

afterLoad

public void afterLoad()

Call this after finishing a two-phase load

Specified by:

afterLoad in interface PersistenceContext

isLoadFinished

public boolean isLoadFinished()

Description copied from interface: PersistenceContext

Is in a two-phase load?

Specified by:

isLoadFinished in interface PersistenceContext

toString

public java.lang.String toString()

Returns a string representation of the object.

Specified by:

toString in interface PersistenceContext

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

getOwnerId

public java.io.Serializable getOwnerId(java.lang.String entityName,
                              java.lang.String propertyName,
                              java.lang.Object childEntity,
                              java.util.Map mergeMap)

Search this persistence context for an associated entity instance which is considered the "owner" of the given childEntity, and return that owner's id value. This is performed in the scenario of a uni-directional, non-inverse one-to-many collection (which means that the collection elements do not maintain a direct reference to the owner).

As such, the processing here is basically to loop over every entity currently associated with this persistence context and for those of the correct entity (sub) type to extract its collection role property value and see if the child is contained within that collection. If so, we have found the owner; if not, we go on.

Also need to account for mergeMap which acts as a local copy cache managed for the duration of a merge operation. It represents a map of the detached entity instances pointing to the corresponding managed instance.

Specified by:

getOwnerId in interface PersistenceContext

Parameters:

entityName - The entity name for the entity type which would own the child

propertyName - The name of the property on the owning entity type which would name this child association.

childEntity - The child entity instance for which to locate the owner instance id.

mergeMap - A map of non-persistent instances from an on-going merge operation (possibly null).

Returns:

The id of the entityName instance which is said to own the child; null if an appropriate owner not located.

getIndexInOwner

public java.lang.Object getIndexInOwner(java.lang.String entity,
                               java.lang.String property,
                               java.lang.Object childEntity,
                               java.util.Map mergeMap)

Search the persistence context for an index of the child object, given a collection role

Specified by:

getIndexInOwner in interface PersistenceContext

addNullProperty

public void addNullProperty(EntityKey ownerKey,
                   java.lang.String propertyName)

Record the fact that the association belonging to the keyed entity is null.

Specified by:

addNullProperty in interface PersistenceContext

isPropertyNull

public boolean isPropertyNull(EntityKey ownerKey,
                     java.lang.String propertyName)

Is the association property belonging to the keyed entity null?

Specified by:

isPropertyNull in interface PersistenceContext

isReadOnly

public boolean isReadOnly(java.lang.Object entityOrProxy)

Description copied from interface: PersistenceContext

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

Specified by:

isReadOnly in interface PersistenceContext

Returns:

true, the object is read-only; false, the object is modifiable.

See Also:

Session.isDefaultReadOnly()

setReadOnly

public void setReadOnly(java.lang.Object object,
               boolean readOnly)

Description copied from interface: PersistenceContext

Set an unmodified persistent object to read-only mode, or a read-only object to modifiable 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. 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 this persistence context:

Specified by:

setReadOnly in interface PersistenceContext

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

See Also:

PersistenceContext.setDefaultReadOnly(boolean), To override this persistence context's read-only/modifiable setting for entities and proxies loaded by a Query:, Query.setReadOnly(boolean), Session.setReadOnly(Object, boolean)

replaceDelayedEntityIdentityInsertKeys

public void replaceDelayedEntityIdentityInsertKeys(EntityKey oldKey,
                                          java.io.Serializable generatedId)

Specified by:

replaceDelayedEntityIdentityInsertKeys in interface PersistenceContext

serialize

public void serialize(java.io.ObjectOutputStream oos)
               throws java.io.IOException

Used by the owning session to explicitly control serialization of the persistence context.

Parameters:

oos - The stream to which the persistence context should get written

Throws:

java.io.IOException - serialization errors.

deserialize

public static StatefulPersistenceContext deserialize(java.io.ObjectInputStream ois,
                                     SessionImplementor session)
                                              throws java.io.IOException,
                                                     java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

addChildParent

public void addChildParent(java.lang.Object child,
                  java.lang.Object parent)

Description copied from interface: PersistenceContext

Put child/parent relation to cache for cascading op

Specified by:

addChildParent in interface PersistenceContext

See Also:

PersistenceContext.addChildParent(java.lang.Object, java.lang.Object)

removeChildParent

public void removeChildParent(java.lang.Object child)

Description copied from interface: PersistenceContext

Remove child/parent relation from cache

Specified by:

removeChildParent in interface PersistenceContext

See Also:

PersistenceContext.removeChildParent(java.lang.Object)

registerInsertedKey

public void registerInsertedKey(EntityPersister persister,
                       java.io.Serializable id)

Register keys inserted during the current transaction

Specified by:

registerInsertedKey in interface PersistenceContext

Parameters:

persister - The entity persister

id - The id

wasInsertedDuringTransaction

public boolean wasInsertedDuringTransaction(EntityPersister persister,
                                   java.io.Serializable id)

Allows callers to check to see if the identified entity was inserted during the current transaction.

Specified by:

wasInsertedDuringTransaction in interface PersistenceContext

Parameters:

persister - The entity persister

id - The id

Returns:

True if inserted during this transaction, false otherwise.