Top Description Fields Constructors Methods
org.hibernate.action.internal

public abstract Class EntityAction

extends Object
implements ComparableExecutable, AfterTransactionCompletionProcess
Class Inheritance
All Implemented Interfaces
org.hibernate.action.spi.AfterTransactionCompletionProcess, org.hibernate.engine.spi.ComparableExecutable, java.io.Serializable, java.lang.Comparable, org.hibernate.action.spi.Executable
Known Direct Subclasses
org.hibernate.action.internal.EntityDeleteAction, org.hibernate.action.internal.EntityUpdateAction, org.hibernate.action.internal.AbstractEntityInsertAction
Imports
org.hibernate.AssertionFailure, org.hibernate.action.spi.AfterTransactionCompletionProcess, .BeforeTransactionCompletionProcess, org.hibernate.engine.spi.ComparableExecutable, .EntityEntry, org.hibernate.event.spi.EventSource, org.hibernate.internal.FastSessionServices, org.hibernate.internal.util.StringHelper, org.hibernate.persister.entity.EntityPersister, org.hibernate.pretty.MessageHelper
Base class for actions relating to insert/update/delete of an entity instance.
Author
Gavin King

Field Summary

Modifier and TypeField and Description
private final String
entityName

private final Object
id

private transient Object
instance

private transient EntityPersister
persister

private transient EventSource
session

private transient boolean
veto

Constructor Summary

AccessConstructor and Description
protected
EntityAction(EventSource
The session from which this action is coming.
session, Object
The id of the entity
id, Object
The entity instance
instance, EntityPersister
The entity persister
persister)

Instantiate an action.

Method Summary

Modifier and TypeMethod and Description
public void
afterDeserialize(EventSource
The session being deserialized
session)

Implements org.hibernate.action.spi.Executable.afterDeserialize.

Reconnect to session after deserialization...
public void
beforeExecutions()

Implements org.hibernate.action.spi.Executable.beforeExecutions.

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

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
protected EventSource
eventSource()

public AfterTransactionCompletionProcess
getAfterTransactionCompletionProcess()

Implements org.hibernate.action.spi.Executable.getAfterTransactionCompletionProcess.

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

Implements org.hibernate.action.spi.Executable.getBeforeTransactionCompletionProcess.

Get the before-transaction-completion process, if any, for this action.
public final DelayedPostInsertIdentifier
getDelayedId()

public String

Returns:

The entity name
getEntityName()

entity name accessor

protected FastSessionServices

Returns:

the FastSessionServices instance from the SessionFactory.
getFastSessionServices()

Convenience method for all subclasses.

public final Object

Returns:

The entity id
getId()

entity id accessor

public final Object

Returns:

The entity instance
getInstance()

entity instance accessor

public final EntityPersister

Returns:

The entity persister
getPersister()

entity persister accessor

public String
getPrimarySortClassifier()

Implements org.hibernate.engine.spi.ComparableExecutable.getPrimarySortClassifier.

This affect sorting order of the executables, when sorting is enabled.
public final String[]
getPropertySpaces()

Implements org.hibernate.action.spi.Executable.getPropertySpaces.

What spaces (tables) are affected by this action?
public Object
getSecondarySortIndex()

Implements org.hibernate.engine.spi.ComparableExecutable.getSecondarySortIndex.

This affect sorting order of the executables, when sorting is enabled.
public final EventSource

Returns:

The session from which this action originated.
getSession()

originating session accessor

protected abstract boolean
hasPostCommitEventListeners()

public boolean
isVeto()

protected boolean
needsAfterTransactionCompletion()

public void
setVeto(boolean veto)

public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

entityNameback to summary
private final String entityName
idback to summary
private final Object id
instanceback to summary
private transient Object instance
persisterback to summary
private transient EntityPersister persister
sessionback to summary
private transient EventSource session
vetoback to summary
private transient boolean veto

Constructor Detail

EntityActionback to summary
protected EntityAction(EventSource session, Object id, Object instance, EntityPersister persister)

Instantiate an action.

Parameters
session:EventSource

The session from which this action is coming.

id:Object

The id of the entity

instance:Object

The entity instance

persister:EntityPersister

The entity persister

Method Detail

afterDeserializeback to summary
public void afterDeserialize(EventSource session)

Implements org.hibernate.action.spi.Executable.afterDeserialize.

Reconnect to session after deserialization...

Parameters
session:EventSource

The session being deserialized

Annotations
@Override
beforeExecutionsback to summary
public void beforeExecutions()

Implements org.hibernate.action.spi.Executable.beforeExecutions.

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

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

Annotations
@Override
compareToback to summary
public int compareTo(ComparableExecutable o)

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
o:ComparableExecutable

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.

Annotations
@Override
eventSourceback to summary
protected EventSource eventSource()
getAfterTransactionCompletionProcessback to summary
public AfterTransactionCompletionProcess getAfterTransactionCompletionProcess()

Implements org.hibernate.action.spi.Executable.getAfterTransactionCompletionProcess.

Doc from org.hibernate.action.spi.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

Annotations
@Override
getBeforeTransactionCompletionProcessback to summary
public BeforeTransactionCompletionProcess getBeforeTransactionCompletionProcess()

Implements org.hibernate.action.spi.Executable.getBeforeTransactionCompletionProcess.

Doc from org.hibernate.action.spi.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

Annotations
@Override
getDelayedIdback to summary
public final DelayedPostInsertIdentifier getDelayedId()
getEntityNameback to summary
public String getEntityName()

entity name accessor

Returns:String

The entity name

getFastSessionServicesback to summary
protected FastSessionServices getFastSessionServices()

Convenience method for all subclasses.

Returns:FastSessionServices

the FastSessionServices instance from the SessionFactory.

getIdback to summary
public final Object getId()

entity id accessor

Returns:Object

The entity id

getInstanceback to summary
public final Object getInstance()

entity instance accessor

Returns:Object

The entity instance

getPersisterback to summary
public final EntityPersister getPersister()

entity persister accessor

Returns:EntityPersister

The entity persister

getPrimarySortClassifierback to summary
public String getPrimarySortClassifier()

Implements org.hibernate.engine.spi.ComparableExecutable.getPrimarySortClassifier.

Doc from org.hibernate.engine.spi.ComparableExecutable.getPrimarySortClassifier.

This affect sorting order of the executables, when sorting is enabled.

Returns:String

the primary sorting attribute; typically the entity name or collection role.

Annotations
@Override
getPropertySpacesback to summary
public final String[] getPropertySpaces()

Implements org.hibernate.action.spi.Executable.getPropertySpaces.

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

What spaces (tables) are affected by this action?

Returns:String[]

The spaces affected by this action.

Annotations
@Override
getSecondarySortIndexback to summary
public Object getSecondarySortIndex()

Implements org.hibernate.engine.spi.ComparableExecutable.getSecondarySortIndex.

Doc from org.hibernate.engine.spi.ComparableExecutable.getSecondarySortIndex.

This affect sorting order of the executables, when sorting is enabled.

Returns:Object

the secondary sorting attribute, applied when getPrimarySortClassifier matches during a comparison; typically the entity key or collection key.

Annotations
@Override
getSessionback to summary
public final EventSource getSession()

originating session accessor

Returns:EventSource

The session from which this action originated.

hasPostCommitEventListenersback to summary
protected abstract boolean hasPostCommitEventListeners()
isVetoback to summary
public boolean isVeto()
needsAfterTransactionCompletionback to summary
protected boolean needsAfterTransactionCompletion()
setVetoback to summary
public void setVeto(boolean veto)
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.

Annotations
@Override