Top Description Inners Fields Constructors Methods
org.hibernate.action

public abstract Class CollectionAction

extends Object
implements Executable, Serializable, Comparable
Class Inheritance
All Implemented Interfaces
java.lang.Comparable, java.io.Serializable, org.hibernate.action.Executable
Known Direct Subclasses
org.hibernate.action.CollectionRecreateAction, org.hibernate.action.CollectionRemoveAction, org.hibernate.action.CollectionUpdateAction
Imports
org.hibernate.cache.access.SoftLock, org.hibernate.cache.CacheException, .CacheKey, org.hibernate.collection.PersistentCollection, org.hibernate.engine.SessionImplementor, org.hibernate.persister.collection.CollectionPersister, org.hibernate.pretty.MessageHelper, org.hibernate.util.StringHelper, java.io.IOException, .ObjectInputStream, .Serializable
Any action relating to insert/update/delete of a collection
Author
Gavin King

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
CollectionAction.CacheCleanupProcess

Field Summary

Modifier and TypeField and Description
private AfterTransactionCompletionProcess
afterTransactionProcess

private final PersistentCollection
collection

private final String
collectionRole

private final Serializable
key

private transient CollectionPersister
persister

private final SessionImplementor
session

Constructor Summary

AccessConstructor and Description
public
CollectionAction(final CollectionPersister persister, final PersistentCollection collection, final Serializable key, final SessionImplementor session)

Method Summary

Modifier and TypeMethod and Description
public final void
beforeExecutions()

Implements org.hibernate.action.Executable.beforeExecutions.

Called before executing any actions.
public int
compareTo(Object
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
protected final void
evict()

public AfterTransactionCompletionProcess
getAfterTransactionCompletionProcess()

Implements org.hibernate.action.Executable.getAfterTransactionCompletionProcess.

Get the after-transaction-completion process, if any, for this action.
public BeforeTransactionCompletionProcess
getBeforeTransactionCompletionProcess()

Implements org.hibernate.action.Executable.getBeforeTransactionCompletionProcess.

Get the before-transaction-completion process, if any, for this action.
protected PersistentCollection
getCollection()

protected final Serializable
getKey()

protected final CollectionPersister
getPersister()

public Serializable[]
getPropertySpaces()

Implements org.hibernate.action.Executable.getPropertySpaces.

What spaces (tables) are affected by this action?
protected final SessionImplementor
getSession()

private void
readObject(ObjectInputStream ois)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

afterTransactionProcessback to summary
private AfterTransactionCompletionProcess afterTransactionProcess
collectionback to summary
private final PersistentCollection collection
collectionRoleback to summary
private final String collectionRole
keyback to summary
private final Serializable key
persisterback to summary
private transient CollectionPersister persister
sessionback to summary
private final SessionImplementor session

Constructor Detail

CollectionActionback to summary
public CollectionAction(final CollectionPersister persister, final PersistentCollection collection, final Serializable key, final SessionImplementor session) throws CacheException

Method Detail

beforeExecutionsback to summary
public final void beforeExecutions() throws CacheException

Implements org.hibernate.action.Executable.beforeExecutions.

Doc from org.hibernate.action.Executable.beforeExecutions.

Called before executing any actions. Gives actions a chance to perform any preparation.

compareToback to summary
public int compareTo(Object other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:Object

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

evictback to summary
protected final void evict() throws CacheException
getAfterTransactionCompletionProcessback to summary
public AfterTransactionCompletionProcess getAfterTransactionCompletionProcess()

Implements org.hibernate.action.Executable.getAfterTransactionCompletionProcess.

Doc from org.hibernate.action.Executable.getAfterTransactionCompletionProcess.

Get the after-transaction-completion process, if any, for this action.

Returns:AfterTransactionCompletionProcess

The after-transaction-completion process, or null if we have no after-transaction-completion process

getBeforeTransactionCompletionProcessback to summary
public BeforeTransactionCompletionProcess getBeforeTransactionCompletionProcess()

Implements org.hibernate.action.Executable.getBeforeTransactionCompletionProcess.

Doc from org.hibernate.action.Executable.getBeforeTransactionCompletionProcess.

Get the before-transaction-completion process, if any, for this action.

Returns:BeforeTransactionCompletionProcess

The before-transaction-completion process, or null if we have no before-transaction-completion process

getCollectionback to summary
protected PersistentCollection getCollection()
getKeyback to summary
protected final Serializable getKey()
getPersisterback to summary
protected final CollectionPersister getPersister()
getPropertySpacesback to summary
public Serializable[] getPropertySpaces()

Implements org.hibernate.action.Executable.getPropertySpaces.

Doc from org.hibernate.action.Executable.getPropertySpaces.

What spaces (tables) are affected by this action?

Returns:Serializable[]

The spaces affected by this action.

getSessionback to summary
protected final SessionImplementor getSession()
readObjectback to summary
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

org.hibernate.action back to summary

private Class CollectionAction.CacheCleanupProcess

extends Object
implements AfterTransactionCompletionProcess
Class Inheritance
All Implemented Interfaces
org.hibernate.action.AfterTransactionCompletionProcess

Field Summary

Modifier and TypeField and Description
private final Serializable
key

private final SoftLock
lock

private final CollectionPersister
persister

Constructor Summary

AccessConstructor and Description
private
CacheCleanupProcess(Serializable key, CollectionPersister persister, SoftLock lock)

Method Summary

Modifier and TypeMethod and Description
public void
doAfterTransactionCompletion(boolean
Did the transaction complete successfully? True means it did.
success, SessionImplementor
The session on which the transaction is completing.
session)

Implements org.hibernate.action.AfterTransactionCompletionProcess.doAfterTransactionCompletion.

Perform whatever processing is encapsulated here after completion of the transaction.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

keyback to summary
private final Serializable key
lockback to summary
private final SoftLock lock
persisterback to summary
private final CollectionPersister persister

Constructor Detail

CacheCleanupProcessback to summary
private CacheCleanupProcess(Serializable key, CollectionPersister persister, SoftLock lock)

Method Detail

doAfterTransactionCompletionback to summary
public void doAfterTransactionCompletion(boolean success, SessionImplementor session)

Implements org.hibernate.action.AfterTransactionCompletionProcess.doAfterTransactionCompletion.

Doc from org.hibernate.action.AfterTransactionCompletionProcess.doAfterTransactionCompletion.

Perform whatever processing is encapsulated here after completion of the transaction.

Parameters
success:boolean

Did the transaction complete successfully? True means it did.

session:SessionImplementor

The session on which the transaction is completing.