Package ch.tocco.nice2.persist.core.api.util

Class CollectingAfterFlushEntityListener

java.lang.Object

ch.tocco.nice2.persist.core.api.util.CollectingAfterFlushEntityListener

All Implemented Interfaces:

EntityFacadeListener, CommitListener, EventListener

Direct Known Subclasses:

ClearAddressFieldsEntityListener, DuplicateListener, DuplicatesMergeListener, DuplicatesSplitUpListener, EntityHistoryFieldEntityListener, EntityHistoryRelationEntityListener, GenericResourcePublishEntityListener

public abstract class CollectingAfterFlushEntityListener
extends Object
implements EntityFacadeListener, CommitListener

An EntityFacadeListener that collects all events during a transaction. The collected information is available from the CollectingAfterFlushEntityListener.EntityContext when onAfterFlush(Transaction) is called. onAfterFlush(Transaction) is triggered by CommitListener.afterFlush(Transaction) and must be implemented by subclasses and still runs inside the original transaction, but after the INSERT, DELETE and UPDATE statements have been executed. The priority() must be carefully evaluated to make sure that other CollectingAfterFlushEntityListener are not affected by this listener. createEntityContext() can be overridden to use a custom context if it is necessary to store additional data that would be no longer available after the session is flushed.

See Also:

• CollectingEntityListener
• CollectingAfterCommitListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectingAfterFlushEntityListener.EntityContext

Constructor Summary

Constructors

Constructor	Description
CollectingAfterFlushEntityListener()

Method Summary

Modifier and Type	Method	Description
void	afterCommit(Context context)	Notifies about the point where the transaction has been fully committed.
final boolean	afterFlush(Transaction tx)	Gets called after the changes of this transaction have been inserted into the database, but before the transaction is committed.
final void	beforeCommit(Transaction tx)	Notifies about the point where the transaction is about to be committed.
protected CollectingAfterFlushEntityListener.EntityContext	createEntityContext()
final void	entityChanging(EntityChangedEvent event)	Fired when any changes are made to an entity.
final void	entityCreating(EntityFacadeEvent event)	Fired when an entity is being created.
final void	entityDeleting(EntityFacadeEvent event)	Fired when an entity is being deleted.
final void	entityRelationChanging(EntityRelationChangedEvent event)	Fired when a relation of an entity has been changed.
protected CollectingAfterFlushEntityListener.EntityContext	getEntityContext(Context context)
abstract boolean	onAfterFlush(Transaction tx)
protected void	onEntityChanging(EntityChangedEvent event)
protected void	onEntityCreating(EntityFacadeEvent event)
protected void	onEntityDeleting(EntityFacadeEvent event)
protected void	onEntityRelationChanging(EntityRelationChangedEvent event)
abstract int	priority()	Defines execution order of all CollectingAfterFlushEntityListener.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.persist.core.api.entity.events.EntityFacadeListener

entityReceivedValues, handleSessionOnlyEntity

Constructor Details

CollectingAfterFlushEntityListener

public CollectingAfterFlushEntityListener()

Method Details

beforeCommit

public final void beforeCommit(Transaction tx)

Description copied from interface: CommitListener

Notifies about the point where the transaction is about to be committed.

This allows further modification of involved entities.

Specified by:

beforeCommit in interface CommitListener

Parameters:

tx - the transaction in question

afterFlush

public final boolean afterFlush(Transaction tx)

Description copied from interface: CommitListener

Gets called after the changes of this transaction have been inserted into the database, but before the transaction is committed.

Specified by:

afterFlush in interface CommitListener

Returns:

true if this method has modified the database

onAfterFlush

public abstract boolean onAfterFlush(Transaction tx)

Returns:

true if this listeners has made any changes to the database

priority

public abstract int priority()

Defines execution order of all CollectingAfterFlushEntityListener. It is important to make sure that other listeners are not affected.

Specified by:

priority in interface CommitListener

entityCreating

public final void entityCreating(EntityFacadeEvent event)

Description copied from interface: EntityFacadeListener

Fired when an entity is being created.

Specified by:

entityCreating in interface EntityFacadeListener

Parameters:

event - The event object.

onEntityCreating

protected void onEntityCreating(EntityFacadeEvent event)

entityDeleting

public final void entityDeleting(EntityFacadeEvent event)

Description copied from interface: EntityFacadeListener

Fired when an entity is being deleted.

Specified by:

entityDeleting in interface EntityFacadeListener

Parameters:

event - The event Object

onEntityDeleting

protected void onEntityDeleting(EntityFacadeEvent event)

entityChanging

public final void entityChanging(EntityChangedEvent event)

Description copied from interface: EntityFacadeListener

Fired when any changes are made to an entity.

Specified by:

entityChanging in interface EntityFacadeListener

Parameters:

event - The event object.

onEntityChanging

protected void onEntityChanging(EntityChangedEvent event)

entityRelationChanging

public final void entityRelationChanging(EntityRelationChangedEvent event)

Description copied from interface: EntityFacadeListener

Fired when a relation of an entity has been changed.

Specified by:

entityRelationChanging in interface EntityFacadeListener

Parameters:

event - The event object.

onEntityRelationChanging

protected void onEntityRelationChanging(EntityRelationChangedEvent event)

afterCommit

public void afterCommit(Context context)

Description copied from interface: CommitListener

Notifies about the point where the transaction has been fully committed.

This allows post processing of the entities involved in the previous commit.

Specified by:

afterCommit in interface CommitListener

getEntityContext

protected CollectingAfterFlushEntityListener.EntityContext getEntityContext(Context context)

createEntityContext

protected CollectingAfterFlushEntityListener.EntityContext createEntityContext()