oracle.toplink.essentials.internal.ejb.cmp3.metadata.listeners

Class MetadataEntityListener

java.lang.Object

oracle.toplink.essentials.descriptors.DescriptorEventAdapter

oracle.toplink.essentials.internal.ejb.cmp3.metadata.listeners.MetadataEntityListener

All Implemented Interfaces:

EventListener, DescriptorEventListener

Direct Known Subclasses:

MetadataEntityClassListener, XMLEntityListener

public class MetadataEntityListener
extends DescriptorEventAdapter

A MetadataEntityListener and is placed on the owning entity's descriptor. Callback methods from an EntityListener require a signature on the method. Namely, they must have an Object parameter.

Since:

TopLink 10.1.3/EJB 3.0 Preview

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field and Description
static String	POST_BUILD
static String	POST_CLONE
static String	POST_DELETE
static String	POST_INSERT
static String	POST_REFRESH
static String	POST_UPDATE
static String	PRE_PERSIST
static String	PRE_REMOVE
static String	PRE_UPDATE_WITH_CHANGES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataEntityListener() INTERNAL: The default constructor should not be used.
protected	MetadataEntityListener(Class entityClass) INTERNAL:
	MetadataEntityListener(Class listenerClass, Class entityClass) INTERNAL:

Method Summary

Modifier and Type	Method and Description
void	addEventMethod(String event, Method method) INTERNAL:
Class	getEntityClass() INTERNAL:
protected Method	getEventMethod(int eventCode) INTERNAL:
protected Method	getEventMethod(String event) INTERNAL:
protected String	getEventMethodName(String eventName) INTERNAL:
Class	getListenerClass() INTERNAL:
Hashtable	getMethods() INTERNAL:
String	getPostBuildMethodName() INTERNAL:
String	getPostCloneMethodName() INTERNAL:
String	getPostDeleteMethodName() INTERNAL:
String	getPostInsertMethodName() INTERNAL:
String	getPostRefreshMethodName() INTERNAL:
String	getPostUpdateMethodName() INTERNAL:
String	getPrePersistMethodName() INTERNAL:
String	getPreRemoveMethodName() INTERNAL:
String	getPreUpdateWithChangesMethodName() INTERNAL:
boolean	hasCallbackMethods() INTERNAL:
boolean	hasOverriddenEventMethod(Method eventMethod, int eventCode) INTERNAL:
protected boolean	hasOverriddenEventMethod(Method eventMethod1, Method eventMethod2) INTERNAL:
boolean	hasOverriddenEventMethod(Method eventMethod, String eventCode) INTERNAL:
void	initializeCallbackMethods(ClassLoader classLoader) INTERNAL: Sub-classes should implement where necessary.
protected void	invokeMethod(Method method, Object onObject, Object[] objectList, DescriptorEvent event) INTERNAL:
protected void	invokeMethod(String event, DescriptorEvent descriptorEvent) INTERNAL:
boolean	isEntityClassListener() INTERNAL:
boolean	isOverriddenEvent(DescriptorEvent event, Vector eventManagers) INTERNAL: Return true is listener has a lifecycle callback method that is overridden in a subclass.
protected boolean	isSessionPostBuildEvent(DescriptorEvent event) INTERNAL:
protected boolean	noCallbackMethodAlreadySetFor(String event, Method method) INTERNAL: Checks if the user already set this call back method via XML.
void	postBuild(DescriptorEvent event) INTERNAL:
void	postClone(DescriptorEvent event) INTERNAL:
void	postDelete(DescriptorEvent event) INTERNAL:
void	postInsert(DescriptorEvent event) INTERNAL:
void	postRefresh(DescriptorEvent event) INTERNAL:
void	postUpdate(DescriptorEvent event) INTERNAL:
void	prePersist(DescriptorEvent event) INTERNAL:
void	preRemove(DescriptorEvent event) INTERNAL:
void	preUpdateWithChanges(DescriptorEvent event) INTERNAL:
void	setEntityClass(Class entityClass) INTERNAL:
void	setListener(Object listener) INTERNAL:
void	setPostBuildMethod(Method method) INTERNAL:
void	setPostCloneMethod(Method method) INTERNAL:
void	setPostDeleteMethod(Method method) INTERNAL:
void	setPostInsertMethod(Method method) INTERNAL:
void	setPostRefreshMethod(Method method) INTERNAL:
void	setPostUpdateMethod(Method method) INTERNAL:
void	setPrePersistMethod(Method method) INTERNAL:
void	setPreRemoveMethod(Method method) INTERNAL:
void	setPreUpdateWithChangesMethod(Method method) INTERNAL:
protected void	validateMethod(Method method) INTERNAL:
protected void	validateMethodModifiers(Method method) INTERNAL:

Methods inherited from class oracle.toplink.essentials.descriptors.DescriptorEventAdapter

aboutToDelete, aboutToInsert, aboutToUpdate, postMerge, postWrite, preDelete, preInsert, preUpdate, preWrite

Methods inherited from class java.lang.Object

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

Field Detail

POST_BUILD

public static final String POST_BUILD

See Also:

Constant Field Values

POST_CLONE

public static final String POST_CLONE

See Also:

Constant Field Values

POST_DELETE

public static final String POST_DELETE

See Also:

Constant Field Values

POST_INSERT

public static final String POST_INSERT

See Also:

Constant Field Values

POST_REFRESH

public static final String POST_REFRESH

See Also:

Constant Field Values

POST_UPDATE

public static final String POST_UPDATE

See Also:

Constant Field Values

PRE_PERSIST

public static final String PRE_PERSIST

See Also:

Constant Field Values

PRE_REMOVE

public static final String PRE_REMOVE

See Also:

Constant Field Values

PRE_UPDATE_WITH_CHANGES

public static final String PRE_UPDATE_WITH_CHANGES

See Also:

Constant Field Values

Constructor Detail

MetadataEntityListener

protected MetadataEntityListener()

INTERNAL: The default constructor should not be used.

MetadataEntityListener

protected MetadataEntityListener(Class entityClass)

INTERNAL:

MetadataEntityListener

public MetadataEntityListener(Class listenerClass,
                              Class entityClass)

INTERNAL:

Method Detail

addEventMethod

public void addEventMethod(String event,
                           Method method)

INTERNAL:

getEntityClass

public Class getEntityClass()

INTERNAL:

getEventMethod

protected Method getEventMethod(int eventCode)

INTERNAL:

getEventMethod

protected Method getEventMethod(String event)

INTERNAL:

getEventMethodName

protected String getEventMethodName(String eventName)

INTERNAL:

getListenerClass

public Class getListenerClass()

INTERNAL:

getMethods

public Hashtable getMethods()

INTERNAL:

getPostBuildMethodName

public String getPostBuildMethodName()

INTERNAL:

getPostCloneMethodName

public String getPostCloneMethodName()

INTERNAL:

getPostDeleteMethodName

public String getPostDeleteMethodName()

INTERNAL:

getPostInsertMethodName

public String getPostInsertMethodName()

INTERNAL:

getPostRefreshMethodName

public String getPostRefreshMethodName()

INTERNAL:

getPostUpdateMethodName

public String getPostUpdateMethodName()

INTERNAL:

getPrePersistMethodName

public String getPrePersistMethodName()

INTERNAL:

getPreRemoveMethodName

public String getPreRemoveMethodName()

INTERNAL:

getPreUpdateWithChangesMethodName

public String getPreUpdateWithChangesMethodName()

INTERNAL:

hasCallbackMethods

public boolean hasCallbackMethods()

INTERNAL:

hasOverriddenEventMethod

public boolean hasOverriddenEventMethod(Method eventMethod,
                                        int eventCode)

INTERNAL:

hasOverriddenEventMethod

protected boolean hasOverriddenEventMethod(Method eventMethod1,
                                           Method eventMethod2)

INTERNAL:

hasOverriddenEventMethod

public boolean hasOverriddenEventMethod(Method eventMethod,
                                        String eventCode)

INTERNAL:

initializeCallbackMethods

public void initializeCallbackMethods(ClassLoader classLoader)

INTERNAL: Sub-classes should implement where necessary.

invokeMethod

protected void invokeMethod(Method method,
                            Object onObject,
                            Object[] objectList,
                            DescriptorEvent event)

INTERNAL:

invokeMethod

protected void invokeMethod(String event,
                            DescriptorEvent descriptorEvent)

INTERNAL:

isEntityClassListener

public boolean isEntityClassListener()

INTERNAL:

isOverriddenEvent

public boolean isOverriddenEvent(DescriptorEvent event,
                                 Vector eventManagers)

INTERNAL: Return true is listener has a lifecycle callback method that is overridden in a subclass.

Specified by:

isOverriddenEvent in interface DescriptorEventListener

Overrides:

isOverriddenEvent in class DescriptorEventAdapter

isSessionPostBuildEvent

protected boolean isSessionPostBuildEvent(DescriptorEvent event)

INTERNAL:

noCallbackMethodAlreadySetFor

protected boolean noCallbackMethodAlreadySetFor(String event,
                                                Method method)

INTERNAL: Checks if the user already set this call back method via XML. We need to check because the set methods on the superclass will throw an exception when multiple methods are added for the callback.

postBuild

public void postBuild(DescriptorEvent event)

INTERNAL:

Specified by:

postBuild in interface DescriptorEventListener

Overrides:

postBuild in class DescriptorEventAdapter

postClone

public void postClone(DescriptorEvent event)

INTERNAL:

Specified by:

postClone in interface DescriptorEventListener

Overrides:

postClone in class DescriptorEventAdapter

postDelete

public void postDelete(DescriptorEvent event)

INTERNAL:

Specified by:

postDelete in interface DescriptorEventListener

Overrides:

postDelete in class DescriptorEventAdapter

postInsert

public void postInsert(DescriptorEvent event)

INTERNAL:

Specified by:

postInsert in interface DescriptorEventListener

Overrides:

postInsert in class DescriptorEventAdapter

postRefresh

public void postRefresh(DescriptorEvent event)

INTERNAL:

Specified by:

postRefresh in interface DescriptorEventListener

Overrides:

postRefresh in class DescriptorEventAdapter

postUpdate

public void postUpdate(DescriptorEvent event)

INTERNAL:

Specified by:

postUpdate in interface DescriptorEventListener

Overrides:

postUpdate in class DescriptorEventAdapter

prePersist

public void prePersist(DescriptorEvent event)

INTERNAL:

Specified by:

prePersist in interface DescriptorEventListener

Overrides:

prePersist in class DescriptorEventAdapter

preRemove

public void preRemove(DescriptorEvent event)

INTERNAL:

Specified by:

preRemove in interface DescriptorEventListener

Overrides:

preRemove in class DescriptorEventAdapter

preUpdateWithChanges

public void preUpdateWithChanges(DescriptorEvent event)

INTERNAL:

Specified by:

preUpdateWithChanges in interface DescriptorEventListener

Overrides:

preUpdateWithChanges in class DescriptorEventAdapter

setEntityClass

public void setEntityClass(Class entityClass)

INTERNAL:

setListener

public void setListener(Object listener)

INTERNAL:

setPostBuildMethod

public void setPostBuildMethod(Method method)

INTERNAL:

setPostCloneMethod

public void setPostCloneMethod(Method method)

INTERNAL:

setPostDeleteMethod

public void setPostDeleteMethod(Method method)

INTERNAL:

setPostInsertMethod

public void setPostInsertMethod(Method method)

INTERNAL:

setPostRefreshMethod

public void setPostRefreshMethod(Method method)

INTERNAL:

setPostUpdateMethod

public void setPostUpdateMethod(Method method)

INTERNAL:

setPrePersistMethod

public void setPrePersistMethod(Method method)

INTERNAL:

setPreRemoveMethod

public void setPreRemoveMethod(Method method)

INTERNAL:

setPreUpdateWithChangesMethod

public void setPreUpdateWithChangesMethod(Method method)

INTERNAL:

validateMethod

protected void validateMethod(Method method)

INTERNAL:

validateMethodModifiers

protected void validateMethodModifiers(Method method)

INTERNAL: