Skip navigation links

oracle.toplink.descriptors
Class DescriptorEventManager

java.lang.Object
oracle.toplink.publicinterface.DescriptorEventManager
oracle.toplink.descriptors.DescriptorEventManager

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class DescriptorEventManager

extends DescriptorEventManager

Purpose: The event manager allows for a descriptor to specify that an object should be notified when a TopLink event occurs. It also determines how the object will be notified. To specify an event a method name can be registered to be called on the object when the event occurs. Events can be used to extend the TopLink reading and writing behavior.

These events include:

• pre/postWrite - occurs when an object is written (occurs even if no changes to the object).
• pre/postInsert - occurs when an object is inserted.
• pre/postUpdate - occurs when an object is updated (occurs even if no changes to the object).
• pre/postDeleted - occurs when an object is deleted.
• postBuild/postRefresh - occurs after a object has been built/refreshed from its database row.
• aboutTo/Insert/Update - occurs when an object is about to be inserted/update allows for row modification.
• postClone - occurs when an object is registered/cloned in a unit of work.
• postMerge - occurs when an object is merged with its original in a unit of work.

See Also:

ClassDescriptor, Serialized Form

Field Summary

Fields inherited from class oracle.toplink.publicinterface.DescriptorEventManager

AboutToDeleteEvent, AboutToInsertEvent, AboutToUpdateEvent, PostBuildEvent, PostCloneEvent, PostDeleteEvent, PostInsertEvent, PostMergeEvent, PostRefreshEvent, PostUpdateEvent, PostWriteEvent, PreDeleteEvent, PreInsertEvent, PrePersistEvent, PreRemoveEvent, PreUpdateEvent, PreUpdateWithChangesEvent, PreWriteEvent

Method Summary

void	addListener(DescriptorEventListener listener) PUBLIC: Listener objects can be registered with the event manager to be notified when an event occurs on any instance of the descriptor's class.
java.lang.String	getAboutToInsertSelector() PUBLIC: The name of the method called when an object is inserted.
java.lang.String	getAboutToUpdateSelector() PUBLIC: The name of the method called when an object is updated.
java.util.Vector	getEventListeners() PUBLIC: Returns the Listener objects that have been added.
java.lang.String	getPostBuildSelector() PUBLIC: The name of the method called after an object is built.
java.lang.String	getPostCloneSelector() PUBLIC: The name of the method called after an object is cloned.
java.lang.String	getPostDeleteSelector() PUBLIC: The name of the method called after an object is deleted.
java.lang.String	getPostInsertSelector() PUBLIC: The name of the method called after an object is inserted.
java.lang.String	getPostMergeSelector() PUBLIC: The name of the method called after an object is merged.
java.lang.String	getPostRefreshSelector() PUBLIC: The name of the method called after an object is refreshed.
java.lang.String	getPostUpdateSelector() PUBLIC: The name of the method called after an object is updated.
java.lang.String	getPostWriteSelector() PUBLIC: The name of the method called after an object is written.
java.lang.String	getPreDeleteSelector() PUBLIC: The name of the method called before an object is deleted.
java.lang.String	getPreInsertSelector() PUBLIC: The name of the method called before an object is inserted.
java.lang.String	getPreUpdateSelector() PUBLIC: The name of the method called before an object is updated.
java.lang.String	getPreWriteSelector() PUBLIC: The name of the method called before an object is written.
void	removeListener(DescriptorEventListener listener) PUBLIC: Remove a event listener.
void	setAboutToInsertSelector(java.lang.String aboutToInsertSelector) PUBLIC: A method can be registered to be called when an object's row it about to be inserted.
void	setAboutToUpdateSelector(java.lang.String aboutToUpdateSelector) PUBLIC: A method can be registered to be called when an object's row it about to be updated.
void	setPostBuildSelector(java.lang.String postBuildSelector) PUBLIC: A method can be registered to be called on a object that has just been built from the database.
void	setPostCloneSelector(java.lang.String postCloneSelector) PUBLIC: A method can be registered to be called on a object that has just been cloned into a unit of work.
void	setPostDeleteSelector(java.lang.String postDeleteSelector) PUBLIC: A method can be registered to be called on a object that has just been deleted from the database.
void	setPostInsertSelector(java.lang.String postInsertSelector) PUBLIC: A method can be registered to be called on a object that has just been inserted into the database.
void	setPostMergeSelector(java.lang.String postMergeSelector) PUBLIC: A method can be registered to be called on a object that has just been merge from a unit of work.
void	setPostRefreshSelector(java.lang.String postRefreshSelector) PUBLIC: A method can be registered to be called on a object that has just been refreshed from the database.
void	setPostUpdateSelector(java.lang.String postUpdateSelector) PUBLIC: A method can be registered to be called on a object that has just been updated into the database.
void	setPostWriteSelector(java.lang.String postWriteSelector) PUBLIC: A method can be registered to be called on a object that has just been written to the database.
void	setPreDeleteSelector(java.lang.String preDeleteSelector) PUBLIC: A method can be registered to be called on a object that is going to be deleted from the database.
void	setPreInsertSelector(java.lang.String preInsertSelector) PUBLIC: A method can be registered to be called on a object that is going to be inserted into the database.
void	setPreUpdateSelector(java.lang.String preUpdateSelector) PUBLIC: A method can be registered to be called on a object that is going to be updated into the database.
void	setPreWriteSelector(java.lang.String preWriteSelector) PUBLIC: A method can be registered to be called on a object that is going to be written to the database.

Methods inherited from class oracle.toplink.publicinterface.DescriptorEventManager

addListener, getPrePersistSelector, getPreRemoveSelector, removeListener, setPrePersistSelector, setPreRemoveSelector

Methods inherited from class java.lang.Object

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

Method Detail

addListener

public void addListener(DescriptorEventListener listener)

PUBLIC: Listener objects can be registered with the event manager to be notified when an event occurs on any instance of the descriptor's class.

Overrides:

addListener in class DescriptorEventManager

getEventListeners

public java.util.Vector getEventListeners()

PUBLIC: Returns the Listener objects that have been added.

Overrides:

getEventListeners in class DescriptorEventManager

See Also:

addListener(DescriptorEventListener)

getAboutToInsertSelector

public java.lang.String getAboutToInsertSelector()

PUBLIC: The name of the method called when an object is inserted.

Overrides:

getAboutToInsertSelector in class DescriptorEventManager

getAboutToUpdateSelector

public java.lang.String getAboutToUpdateSelector()

PUBLIC: The name of the method called when an object is updated.

Overrides:

getAboutToUpdateSelector in class DescriptorEventManager

getPostBuildSelector

public java.lang.String getPostBuildSelector()

PUBLIC: The name of the method called after an object is built.

Overrides:

getPostBuildSelector in class DescriptorEventManager

getPostCloneSelector

public java.lang.String getPostCloneSelector()

PUBLIC: The name of the method called after an object is cloned.

Overrides:

getPostCloneSelector in class DescriptorEventManager

getPostDeleteSelector

public java.lang.String getPostDeleteSelector()

PUBLIC: The name of the method called after an object is deleted.

Overrides:

getPostDeleteSelector in class DescriptorEventManager

getPostInsertSelector

public java.lang.String getPostInsertSelector()

PUBLIC: The name of the method called after an object is inserted.

Overrides:

getPostInsertSelector in class DescriptorEventManager

getPostMergeSelector

public java.lang.String getPostMergeSelector()

PUBLIC: The name of the method called after an object is merged.

Overrides:

getPostMergeSelector in class DescriptorEventManager

getPostRefreshSelector

public java.lang.String getPostRefreshSelector()

PUBLIC: The name of the method called after an object is refreshed.

Overrides:

getPostRefreshSelector in class DescriptorEventManager

getPostUpdateSelector

public java.lang.String getPostUpdateSelector()

PUBLIC: The name of the method called after an object is updated.

Overrides:

getPostUpdateSelector in class DescriptorEventManager

getPostWriteSelector

public java.lang.String getPostWriteSelector()

PUBLIC: The name of the method called after an object is written.

Overrides:

getPostWriteSelector in class DescriptorEventManager

getPreDeleteSelector

public java.lang.String getPreDeleteSelector()

PUBLIC: The name of the method called before an object is deleted.

Overrides:

getPreDeleteSelector in class DescriptorEventManager

getPreInsertSelector

public java.lang.String getPreInsertSelector()

PUBLIC: The name of the method called before an object is inserted.

Overrides:

getPreInsertSelector in class DescriptorEventManager

getPreUpdateSelector

public java.lang.String getPreUpdateSelector()

PUBLIC: The name of the method called before an object is updated.

Overrides:

getPreUpdateSelector in class DescriptorEventManager

getPreWriteSelector

public java.lang.String getPreWriteSelector()

PUBLIC: The name of the method called before an object is written.

Overrides:

getPreWriteSelector in class DescriptorEventManager

removeListener

public void removeListener(DescriptorEventListener listener)

PUBLIC: Remove a event listener.

Overrides:

removeListener in class DescriptorEventManager

setAboutToInsertSelector

public void setAboutToInsertSelector(java.lang.String aboutToInsertSelector)

PUBLIC: A method can be registered to be called when an object's row it about to be inserted. This uses the optional event argument of the DatabaseRow. This is different from pre/postInsert because it occurs after the row has already been built. This event can be used to modify the row before insert, such as adding a user inserted by.

Overrides:

setAboutToInsertSelector in class DescriptorEventManager

setAboutToUpdateSelector

public void setAboutToUpdateSelector(java.lang.String aboutToUpdateSelector)

PUBLIC: A method can be registered to be called when an object's row it about to be updated. This uses the optional event argument of the DatabaseRow. This is different from pre/postUpdate because it occurs after the row has already been built, and it ONLY called if the update is required (changed within a unit of work), as the other occur ALWAYS. This event can be used to modify the row before insert, such as adding a user inserted by.

Overrides:

setAboutToUpdateSelector in class DescriptorEventManager

setPostBuildSelector

public void setPostBuildSelector(java.lang.String postBuildSelector)

PUBLIC: A method can be registered to be called on a object that has just been built from the database. This uses the optional event argument of the DatabaseRow. This event can be used to correctly initialize an object's non-persistent attributes or to perform complex optimizations or mappings. This event is called whenever an object is built.

Overrides:

setPostBuildSelector in class DescriptorEventManager

setPostCloneSelector

public void setPostCloneSelector(java.lang.String postCloneSelector)

PUBLIC: A method can be registered to be called on a object that has just been cloned into a unit of work. This uses the optional event argument of the orignial object (the source object it the clone). This event can be used to correctly initialize an object's non-persistent attributes.

Overrides:

setPostCloneSelector in class DescriptorEventManager

setPostDeleteSelector

public void setPostDeleteSelector(java.lang.String postDeleteSelector)

PUBLIC: A method can be registered to be called on a object that has just been deleted from the database. This event can notify/remove any dependents on the object.

Overrides:

setPostDeleteSelector in class DescriptorEventManager

setPostInsertSelector

public void setPostInsertSelector(java.lang.String postInsertSelector)

PUBLIC: A method can be registered to be called on a object that has just been inserted into the database. This event can be used to notify any dependent on the object, or to update information not accessible until the object has been inserted.

Overrides:

setPostInsertSelector in class DescriptorEventManager

setPostMergeSelector

public void setPostMergeSelector(java.lang.String postMergeSelector)

PUBLIC: A method can be registered to be called on a object that has just been merge from a unit of work. This uses the optional event argument of the orignial object which is the object being merged from, the source object is the object being merged into. This event can be used to correctly initialize an object's non-persistent attributes.

Overrides:

setPostMergeSelector in class DescriptorEventManager

setPostRefreshSelector

public void setPostRefreshSelector(java.lang.String postRefreshSelector)

PUBLIC: A method can be registered to be called on a object that has just been refreshed from the database. This uses the optional event argument of the DatabaseRow. This event can be used to correctly initialize an object's non-persistent attributes or to perform complex optimizations or mappings. This event is only called on refreshes of existing objects.

Overrides:

setPostRefreshSelector in class DescriptorEventManager

setPostUpdateSelector

public void setPostUpdateSelector(java.lang.String postUpdateSelector)

PUBLIC: A method can be registered to be called on a object that has just been updated into the database.

Overrides:

setPostUpdateSelector in class DescriptorEventManager

setPostWriteSelector

public void setPostWriteSelector(java.lang.String postWriteSelector)

PUBLIC: A method can be registered to be called on a object that has just been written to the database. This event is raised on any registered object in a unit of work, even if it has not changed, refer to the "aboutToUpdate" selector if it is required for the event to be raised only when the object has been changed. This will be called on all inserts and updates, after the "postInsert/Update" event has been raised. This event can be used to notify any dependent on the object.

Overrides:

setPostWriteSelector in class DescriptorEventManager

setPreDeleteSelector

public void setPreDeleteSelector(java.lang.String preDeleteSelector)

PUBLIC: A method can be registered to be called on a object that is going to be deleted from the database. This event can notify/remove any dependents on the object.

Overrides:

setPreDeleteSelector in class DescriptorEventManager

setPreInsertSelector

public void setPreInsertSelector(java.lang.String preInsertSelector)

PUBLIC: A method can be registered to be called on a object that is going to be inserted into the database. This event can be used to notify any dependent on the object or acquire the object's id through a custom mechanism.

Overrides:

setPreInsertSelector in class DescriptorEventManager

setPreUpdateSelector

public void setPreUpdateSelector(java.lang.String preUpdateSelector)

PUBLIC: A method can be registered to be called on a object that is going to be updated into the database. This event is raised on any registered object in a unit of work, even if it has not changed, refer to the "aboutToUpdate" selector if it is required for the event to be raised only when the object has been changed. This event can be used to notify any dependent on the object.

Overrides:

setPreUpdateSelector in class DescriptorEventManager

setPreWriteSelector

public void setPreWriteSelector(java.lang.String preWriteSelector)

PUBLIC: A method can be registered to be called on a object that is going to be written to the database. This event is raised on any registered object in a unit of work, even if it has not changed, refer to the "aboutToUpdate" selector if it is required for the event to be raised only when the object has been changed. This will be called on all inserts and updates, before the "preInsert/Update" event has been raised. This event can be used to notify any dependent on the object.

Overrides:

setPreWriteSelector in class DescriptorEventManager

Skip navigation links