Skip navigation links

oracle.toplink.descriptors
Class DescriptorEvent

java.lang.Object
java.util.EventObject
oracle.toplink.publicinterface.DescriptorEvent
oracle.toplink.descriptors.DescriptorEvent

All Implemented Interfaces:

java.io.Serializable

public class DescriptorEvent

extends DescriptorEvent

Purpose: Encapsulate the information provided with descriptor events. This is used as the argument to any event raised by the descriptor. Events can be registered for, through two methods, the first is by providing a method to be called on the object that a paticular operation is being performed on. The second is by registering an event listener to be notified when any event occurs for that descriptor. The second method is more similar to the java beans event model and requires the registered listener to implement the DescriptorEventListener interface.

See Also:

DescriptorEventManager, DescriptorEventListener, DescriptorEventAdapter, Serialized Form

Method Summary

void	applyAttributeValuesIntoRow(java.lang.String attributeName) PUBLIC: Re-populate the database row with the values from the source object based upon the attribute's mapping.
ObjectChangeSet	getChangeSet() PUBLIC: Returns the Object changeSet if available
ClassDescriptor	getClassDescriptor() PUBLIC: The source descriptor of the event.
int	getEventCode() PUBLIC: The code of the descriptor event being raised.
java.lang.Object	getObject() PUBLIC: Synonym for source.
java.lang.Object	getOriginalObject() PUBLIC: The source object represents the object the event is being raised on, some events also require a second object, for example the original object in a postClone.
DatabaseQuery	getQuery() PUBLIC: The query causing the event.
Record	getRecord() PUBLIC: Optionally a database row may be provided on some events, (such as aboutToUpdate).
Session	getSession() PUBLIC: The session in which the event is raised.
void	updateAttributeAddObjectToCollection(java.lang.String attributeName, java.lang.Object mapKey, java.lang.Object value) ADVANCED: Use this method when updating object attribute values, with unmapped objects Integer, String or others. in events to ensure that all required objects are updated.
void	updateAttributeRemoveObjectFromCollection(java.lang.String attributeName, java.lang.Object mapKey, java.lang.Object value) ADVANCED: Use this method when updating object attribute values, with unmapped objects Integer, String or others. in events to ensure that all required objects are updated.
void	updateAttributeWithObject(java.lang.String attributeName, java.lang.Object value) ADVANCED: Use this method when updating object attribute values, with unmapped objects Integer, String or others. in events to ensure that all required objects are updated.

Methods inherited from class oracle.toplink.publicinterface.DescriptorEvent

getDescriptor, getRow

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Method Detail

applyAttributeValuesIntoRow

public void applyAttributeValuesIntoRow(java.lang.String attributeName)

PUBLIC: Re-populate the database row with the values from the source object based upon the attribute's mapping. Provided as a helper method for modifying the row during event handling.

Overrides:

applyAttributeValuesIntoRow in class DescriptorEvent

getChangeSet

public ObjectChangeSet getChangeSet()

PUBLIC: Returns the Object changeSet if available

Overrides:

getChangeSet in class DescriptorEvent

getClassDescriptor

public ClassDescriptor getClassDescriptor()

PUBLIC: The source descriptor of the event.

getEventCode

public int getEventCode()

PUBLIC: The code of the descriptor event being raised. This is an integer constant value from DescriptorEventManager.

Overrides:

getEventCode in class DescriptorEvent

getObject

public java.lang.Object getObject()

PUBLIC: Synonym for source.

Overrides:

getObject in class DescriptorEvent

getOriginalObject

public java.lang.Object getOriginalObject()

PUBLIC: The source object represents the object the event is being raised on, some events also require a second object, for example the original object in a postClone.

Overrides:

getOriginalObject in class DescriptorEvent

See Also:

EventObject.getSource()

getQuery

public DatabaseQuery getQuery()

PUBLIC: The query causing the event.

Overrides:

getQuery in class DescriptorEvent

getRecord

public Record getRecord()

PUBLIC: Optionally a database row may be provided on some events, (such as aboutToUpdate).

getSession

public Session getSession()

PUBLIC: The session in which the event is raised.

Overrides:

getSession in class DescriptorEvent

updateAttributeWithObject

public void updateAttributeWithObject(java.lang.String attributeName,
                                      java.lang.Object value)

ADVANCED: Use this method when updating object attribute values, with unmapped objects Integer, String or others. in events to ensure that all required objects are updated. TopLink will automaticaly update all objects and changesets envolved. TopLink will update the field, in the row, to have the new value for the field that this mapping maps to.

Overrides:

updateAttributeWithObject in class DescriptorEvent

updateAttributeAddObjectToCollection

public void updateAttributeAddObjectToCollection(java.lang.String attributeName,
                                                 java.lang.Object mapKey,
                                                 java.lang.Object value)

ADVANCED: Use this method when updating object attribute values, with unmapped objects Integer, String or others. in events to ensure that all required objects are updated. TopLink will automaticaly update all objects and changesets envolved. TopLink will update the field, in the row, to have the new value for the field that this mapping maps to.

Overrides:

updateAttributeAddObjectToCollection in class DescriptorEvent

updateAttributeRemoveObjectFromCollection

public void updateAttributeRemoveObjectFromCollection(java.lang.String attributeName,
                                                      java.lang.Object mapKey,
                                                      java.lang.Object value)

ADVANCED: Use this method when updating object attribute values, with unmapped objects Integer, String or others. in events to ensure that all required objects are updated. TopLink will automaticaly update all objects and changesets envolved. TopLink will update the field, in the row, to have the new value for the field that this mapping maps to.

Overrides:

updateAttributeRemoveObjectFromCollection in class DescriptorEvent

Skip navigation links