org.hibernate.event

Class AbstractCollectionEvent

java.lang.Object

org.hibernate.event.AbstractEvent

org.hibernate.event.AbstractCollectionEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InitializeCollectionEvent, PostCollectionRecreateEvent, PostCollectionRemoveEvent, PostCollectionUpdateEvent, PreCollectionRecreateEvent, PreCollectionRemoveEvent, PreCollectionUpdateEvent

public abstract class AbstractCollectionEvent
extends AbstractEvent

Defines a base class for events involving collections.

Author:

Gail Badner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCollectionEvent(CollectionPersister collectionPersister, PersistentCollection collection, EventSource source, java.lang.Object affectedOwner, java.io.Serializable affectedOwnerId) Constructs an AbstractCollectionEvent object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAffectedOwnerEntityName() Get the entity name for the collection owner entity that is affected by this event.
protected static java.lang.String	getAffectedOwnerEntityName(CollectionPersister collectionPersister, java.lang.Object affectedOwner, EventSource source)
java.io.Serializable	getAffectedOwnerIdOrNull() Get the ID for the collection owner entity that is affected by this event.
java.lang.Object	getAffectedOwnerOrNull() Get the collection owner entity that is affected by this event.
PersistentCollection	getCollection()
protected static CollectionPersister	getLoadedCollectionPersister(PersistentCollection collection, EventSource source)
protected static java.io.Serializable	getLoadedOwnerIdOrNull(PersistentCollection collection, EventSource source)
protected static java.lang.Object	getLoadedOwnerOrNull(PersistentCollection collection, EventSource source)
protected static java.io.Serializable	getOwnerIdOrNull(java.lang.Object owner, EventSource source)

Methods inherited from class org.hibernate.event.AbstractEvent

getSession

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCollectionEvent

public AbstractCollectionEvent(CollectionPersister collectionPersister,
                       PersistentCollection collection,
                       EventSource source,
                       java.lang.Object affectedOwner,
                       java.io.Serializable affectedOwnerId)

Constructs an AbstractCollectionEvent object.

Parameters:

collection - - the collection

source - - the Session source

affectedOwner - - the owner that is affected by this event; can be null if unavailable

affectedOwnerId - - the ID for the owner that is affected by this event; can be null if unavailable that is affected by this event; can be null if unavailable

Method Detail

getLoadedCollectionPersister

protected static CollectionPersister getLoadedCollectionPersister(PersistentCollection collection,
                                               EventSource source)

getLoadedOwnerOrNull

protected static java.lang.Object getLoadedOwnerOrNull(PersistentCollection collection,
                                    EventSource source)

getLoadedOwnerIdOrNull

protected static java.io.Serializable getLoadedOwnerIdOrNull(PersistentCollection collection,
                                          EventSource source)

getOwnerIdOrNull

protected static java.io.Serializable getOwnerIdOrNull(java.lang.Object owner,
                                    EventSource source)

getAffectedOwnerEntityName

protected static java.lang.String getAffectedOwnerEntityName(CollectionPersister collectionPersister,
                                          java.lang.Object affectedOwner,
                                          EventSource source)

getCollection

public PersistentCollection getCollection()

getAffectedOwnerOrNull

public java.lang.Object getAffectedOwnerOrNull()

Get the collection owner entity that is affected by this event.

Returns:

the affected owner; returns null if the entity is not in the persistence context (e.g., because the collection from a detached entity was moved to a new owner)

getAffectedOwnerIdOrNull

public java.io.Serializable getAffectedOwnerIdOrNull()

Get the ID for the collection owner entity that is affected by this event.

Returns:

the affected owner ID; returns null if the ID cannot be obtained from the collection's loaded key (e.g., a property-ref is used for the collection and does not include the entity's ID)

getAffectedOwnerEntityName

public java.lang.String getAffectedOwnerEntityName()

Get the entity name for the collection owner entity that is affected by this event.

Returns:

the entity name; if the owner is not in the PersistenceContext, the returned value may be a superclass name, instead of the actual class name