Save This Page
Home » hibernate-distribution-3.3.1.GA-dist » org.hibernate » engine » [javadoc | source]
org.hibernate.engine
public interface: PersistenceContext [javadoc | source]

All Known Implementing Classes:
    StatefulPersistenceContext

Holds the state of the persistence context, including the first-level cache, entries, snapshots, proxies, etc.
Method from org.hibernate.engine.PersistenceContext Summary:
addCollectionHolder,   addEntity,   addEntity,   addEntity,   addEntry,   addInitializedCollection,   addInitializedDetachedCollection,   addNewCollection,   addNonLazyCollection,   addNullProperty,   addProxy,   addUninitializedCollection,   addUninitializedDetachedCollection,   addUnownedCollection,   afterLoad,   afterTransactionCompletion,   beforeLoad,   checkUniqueness,   clear,   containsCollection,   containsEntity,   containsProxy,   decrementCascadeLevel,   getBatchFetchQueue,   getCachedDatabaseSnapshot,   getCascadeLevel,   getCollection,   getCollectionEntries,   getCollectionEntry,   getCollectionEntryOrNull,   getCollectionHolder,   getCollectionOwner,   getCollectionsByKey,   getDatabaseSnapshot,   getEntitiesByKey,   getEntity,   getEntity,   getEntityEntries,   getEntry,   getIndexInOwner,   getLoadContexts,   getLoadedCollectionOwnerIdOrNull,   getLoadedCollectionOwnerOrNull,   getNaturalIdSnapshot,   getNullifiableEntityKeys,   getOwnerId,   getProxy,   getSession,   getSnapshot,   hasNonReadOnlyEntities,   incrementCascadeLevel,   initializeNonLazyCollections,   isEntryFor,   isFlushing,   isPropertyNull,   isStateless,   narrowProxy,   proxyFor,   proxyFor,   reassociateIfUninitializedProxy,   reassociateProxy,   removeCollectionHolder,   removeEntity,   removeEntry,   removeProxy,   replaceDelayedEntityIdentityInsertKeys,   setEntryStatus,   setFlushing,   setReadOnly,   toString,   unproxy,   unproxyAndReassociate,   useUnownedCollection
Method from org.hibernate.engine.PersistenceContext Detail:
 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().
 public  void addEntity(EntityKey key,
    Object entity)
    Add a canonical mapping from entity key to entity instance
 public  void addEntity(EntityUniqueKey euk,
    Object entity)
    Add an entity to the cache by unique key
 public EntityEntry addEntity(Object entity,
    Status status,
    Object[] loadedState,
    EntityKey entityKey,
    Object version,
    LockMode lockMode,
    boolean existsInDatabase,
    EntityPersister persister,
    boolean disableVersionIncrement,
    boolean lazyPropertiesAreUnfetched)
    Adds an entity to the internal caches.
 public EntityEntry addEntry(Object entity,
    Status status,
    Object[] loadedState,
    Object rowId,
    Serializable id,
    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.
 public CollectionEntry addInitializedCollection(CollectionPersister persister,
    PersistentCollection collection,
    Serializable id) throws HibernateException
    add a collection we just pulled out of the cache (does not need initializing)
 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)
 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)
 public  void addNonLazyCollection(PersistentCollection collection)
    Register a collection for non-lazy loading at the end of the two-phase load
 public  void addNullProperty(EntityKey ownerKey,
    String propertyName)
    Record the fact that the association belonging to the keyed entity is null.
 public  void addProxy(EntityKey key,
    Object proxy)
    Add a proxy to the session cache
 public  void addUninitializedCollection(CollectionPersister persister,
    PersistentCollection collection,
    Serializable id)
    add a collection we just loaded up (still needs initializing)
 public  void addUninitializedDetachedCollection(CollectionPersister persister,
    PersistentCollection collection)
    add a detached uninitialized collection
 public  void addUnownedCollection(CollectionKey key,
    PersistentCollection collection)
    Add a collection which has no owner loaded
 public  void afterLoad()
    Call this after finishing a two-phase load
 public  void afterTransactionCompletion()
    Called after transactions end
 public  void beforeLoad()
    Call this before begining a two-phase load
 public  void checkUniqueness(EntityKey key,
    Object object) throws HibernateException
    Attempts to check whether the given key represents an entity already loaded within the current session.
 public  void clear()
    Clear the state of the persistence context
 public boolean containsCollection(PersistentCollection collection)
    Is the given collection associated with this persistence context?
 public boolean containsEntity(EntityKey key)
    Is there an entity with the given key in the persistence context
 public boolean containsProxy(Object proxy)
    Is the given proxy associated with this persistence context?
 public int decrementCascadeLevel()
    Called after cascading
 public BatchFetchQueue getBatchFetchQueue()
    Get the BatchFetchQueue, instantiating one if necessary.
 public Object[] getCachedDatabaseSnapshot(EntityKey key)
 public int getCascadeLevel()
    How deep are we cascaded?
 public PersistentCollection getCollection(CollectionKey collectionKey)
    Get the collection instance associated with the CollectionKey
 public Map getCollectionEntries()
    Get the mapping from collection instance to collection entry
 public CollectionEntry getCollectionEntry(PersistentCollection coll)
    Get the collection entry for a persistent collection
 public CollectionEntry getCollectionEntryOrNull(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.
 public PersistentCollection getCollectionHolder(Object array)
    Get the PersistentCollection object for an array
 public Object getCollectionOwner(Serializable key,
    CollectionPersister collectionPersister) throws MappingException
    Get the entity that owns this persistent collection
 public Map getCollectionsByKey()
    Get the mapping from collection key to collection instance
 public Object[] getDatabaseSnapshot(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
 public Map getEntitiesByKey()
    Get the mapping from key value to entity instance
 public Object getEntity(EntityKey key)
    Get the entity instance associated with the given EntityKey
 public Object getEntity(EntityUniqueKey euk)
    Get an entity cached by unique key
 public Map getEntityEntries()
    Get the mapping from entity instance to entity entry
 public EntityEntry getEntry(Object entity)
    Retreive the EntityEntry representation of the given entity.
 public Object getIndexInOwner(String entity,
    String property,
    Object childObject,
    Map mergeMap)
    Search the persistence context for an index of the child object, given a collection role
 public LoadContexts getLoadContexts()
    Retrieve this persistence context's managed load context.
 public Serializable getLoadedCollectionOwnerIdOrNull(PersistentCollection collection)
    Get the ID for the entity that owned this persistent collection when it was loaded
 public Object getLoadedCollectionOwnerOrNull(PersistentCollection collection)
    Get the entity that owned this persistent collection when it was loaded
 public Object[] getNaturalIdSnapshot(Serializable id,
    EntityPersister persister) throws HibernateException
    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.
 public HashSet getNullifiableEntityKeys()
    Retrieve the set of EntityKeys representing nullifiable references
 public Serializable getOwnerId(String entity,
    String property,
    Object childObject,
    Map mergeMap)
    Search the persistence context for an owner for the child object, given a collection role
 public Object getProxy(EntityKey key)
    Get an existing proxy by key
 public SessionImplementor getSession()
    Get the session to which this persistence context is bound.
 public Serializable getSnapshot(PersistentCollection coll)
    Get the snapshot of the pre-flush collection state
 public boolean hasNonReadOnlyEntities()
 public int incrementCascadeLevel()
    Called before cascading
 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)
 public boolean isEntryFor(Object entity)
    Is there an EntityEntry for this instance?
 public boolean isFlushing()
    Is a flush cycle currently in process?
 public boolean isPropertyNull(EntityKey ownerKey,
    String propertyName)
    Is the association property belonging to the keyed entity null?
 public boolean isStateless()
 public Object narrowProxy(Object proxy,
    EntityPersister persister,
    EntityKey key,
    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.
 public Object proxyFor(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)
 public Object proxyFor(EntityPersister persister,
    EntityKey key,
    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.
 public boolean reassociateIfUninitializedProxy(Object value) throws MappingException
    Takes the given object and, if it represents a proxy, reassociates it with this event source.
 public  void reassociateProxy(Object value,
    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
 public PersistentCollection removeCollectionHolder(Object array)
    Remove the mapping of collection to holder during eviction of the owning entity
 public 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
 public EntityEntry removeEntry(Object entity)
    Remove an entity entry from the session cache
 public Object removeProxy(EntityKey key)
    Remove a proxy from the session cache
 public  void replaceDelayedEntityIdentityInsertKeys(EntityKey oldKey,
    Serializable generatedId)
 public  void setEntryStatus(EntityEntry entry,
    Status status)
    Set the status of an entry
 public  void setFlushing(boolean flushing)
    Called before and after the flushcycle
 public  void setReadOnly(Object entity,
    boolean readOnly)
    Set the object to read only and discard it's snapshot
 public String toString()
    Returns a string representation of the object.
 public Object unproxy(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.
 public Object unproxyAndReassociate(Object maybeProxy) throws HibernateException
    Possibly unproxy the given reference and reassociate it with the current session.
 public PersistentCollection useUnownedCollection(CollectionKey key)
    Get and remove a collection whose owner is not yet loaded, when its owner is being loaded