org.dmd.dmp.server.extended

Class DMPEvent

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmp.server.generated.dmw.DMPMessageDMW

org.dmd.dmp.server.extended.DMPMessage

org.dmd.dmp.server.generated.dmw.DMPEventDMW

org.dmd.dmp.server.extended.DMPEvent

All Implemented Interfaces:

DmcContainerIF

public class DMPEvent
extends DMPEventDMW

Field Summary

Fields inherited from class org.dmd.dmp.server.extended.DMPMessage

request

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Constructor and Description
DMPEvent()
DMPEvent(DMPEventDMO obj)
DMPEvent(DMPEventTypeEnum et, DmwWrapper w)
DMPEvent(SetRequest request) A convenience constructor that creates a MODIFIED event based on the contents of the SetRequest passed as argument.

Method Summary

Modifier and Type	Method and Description
DMPEvent	clone() Returns a clone of this DMPEvent.
DmcTypeModifierMV	getModifier()
DmcTypeModifierMV	getModifyAttribute() A convenience method to directly access the modify attribute which must be passed to the DmcObject.applyModifier() method.
DMPEvent	getPersistentForm() This method will return either, the current event (if all information is PERSISTENT) or a trimmed down clone of the event with non-PERSISTENT information removed.
DMPEvent	getSlice(DmcSliceInfo dsi) This method will slice the event appropriately, depending on the type of event and the specified slice.
DmcSliceInfo	getSliceInfo()
DmcObjectName	getSourceName()
DmwWrapper	getSourceObjectWrapped() If the event object has generated/extended DMW code, this method will return the DMO wrapped in its associated DMW object.
boolean	hasPersistentData() Checks to see if the event contains information about persistent objects/attributes.
void	setModify(DmcTypeModifierMV mods) A convenience function to set the modify attribute directly on the underlying EventDMO object.
boolean	thisAttributeModified(DmcAttributeInfo ai) This convenience method can be used on MODIFIED events to determine whether or not the specified attribute is alterred by the modifier.

Methods inherited from class org.dmd.dmp.server.generated.dmw.DMPEventDMW

addModify, addModify, cloneIt, delModify, delModify, getDMO, getEventTypeDMP, getHandlerID, getListenerID, getModificationRecorder, getModifyCopy, getModifyHasValue, getModifyIsEmpty, getModifyIterable, getModifySize, getOriginatorID, getSlice, getSource, getSourceObject, getSourceObjectClass, isMyOwnEvent, isNotifyOriginator, modifyContains, remEventTypeDMP, remHandlerID, remListenerID, remModify, remMyOwnEvent, remNotifyOriginator, remOriginatorID, remSlice, remSource, remSourceObject, remSourceObjectClass, setEventTypeDMP, setEventTypeDMP, setHandlerID, setHandlerID, setListenerID, setListenerID, setMyOwnEvent, setMyOwnEvent, setNotifyOriginator, setNotifyOriginator, setOriginatorID, setOriginatorID, setSlice, setSlice, setSource, setSource, setSource, setSourceObject, setSourceObject, setSourceObjectClass, setSourceObjectClass

Methods inherited from class org.dmd.dmp.server.extended.DMPMessage

getLastRequestID, getServletRequest, removeLastRequestID

Methods inherited from class org.dmd.dmp.server.generated.dmw.DMPMessageDMW

addNvp, addNvp, addRequestID, addRequestID, delNvp, delNvp, delRequestID, delRequestID, getNvpCopy, getNvpHasValue, getNvpIsEmpty, getNvpIterable, getNvpSize, getRequestIDCopy, getRequestIDHasValue, getRequestIDIsEmpty, getRequestIDIterable, getRequestIDSize, getTimeMS, isTrackingEnabled, nvpContains, remNvp, remRequestID, remTimeMS, remTrackingEnabled, requestIDContains, setTimeMS, setTimeMS, setTrackingEnabled, setTrackingEnabled

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, setDeleted, setModifier

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DMPEvent

public DMPEvent()

DMPEvent

public DMPEvent(DMPEventDMO obj)

DMPEvent

public DMPEvent(DMPEventTypeEnum et,
                DmwWrapper w)

DMPEvent

public DMPEvent(SetRequest request)

A convenience constructor that creates a MODIFIED event based on the contents of the SetRequest passed as argument. The source will be the target of the request.

Parameters:

request -

Method Detail

clone

public DMPEvent clone()

Returns a clone of this DMPEvent.

Overrides:

clone in class Object

hasPersistentData

public boolean hasPersistentData()

Checks to see if the event contains information about persistent objects/attributes. A variety of checks are performed, depending on the type of the event.

If the source object class is not PERSISTENT, we return false.

If it's a CREATE event, we check to see if any of the attributes (beyond the objectClass) are PERSISTENT, if so, we return true.

If it's a DELETE event, we return true.

If it's a MODIFIED event, we check the modify attribute. If it refers to any PERSISTENT attribute, we return true.

Returns:

true if there's persistent data and false otherwise.

getPersistentForm

public DMPEvent getPersistentForm()

This method will return either, the current event (if all information is PERSISTENT) or a trimmed down clone of the event with non-PERSISTENT information removed.

If none of the data is PERSISTENT, null is returned.

If the source object class is not PERSISTENT, we return null.

If it's a CREATED/LOADED event, we check to see if any of the attributes are non-PERSISTENT, if so, we strip those attributes from the source object and return a clone of the event with the source object replaced with a new source object WITHOUT the non-PERSISTENT attributes.

If it's a DELETE event, we just return the event (since it only has the name of the object being deleted).

If it's a MODIFIED event, we check the modify attribute. If it refers to any PERSISTENT attribute, we return true.

Returns:

a clone of the DMPEvent with only the PERSISTENT information and null if there's no PERSISTENT data.

getModifier

public DmcTypeModifierMV getModifier()

Overrides:

getModifier in class DmcContainer

Returns:

The modifier if one has been set.

getSourceName

public DmcObjectName getSourceName()

setModify

public void setModify(DmcTypeModifierMV mods)

A convenience function to set the modify attribute directly on the underlying EventDMO object.

Parameters:

mods -

getModifyAttribute

public DmcTypeModifierMV getModifyAttribute()

A convenience method to directly access the modify attribute which must be passed to the DmcObject.applyModifier() method.

Returns:

The modify attribute.

getSourceObjectWrapped

public DmwWrapper getSourceObjectWrapped()
                                  throws DmcNameClashException,
                                         DmcValueException

If the event object has generated/extended DMW code, this method will return the DMO wrapped in its associated DMW object.

Returns:

The wrapped DMO.

Throws:

DmcNameClashException

DmcValueException

getSliceInfo

public DmcSliceInfo getSliceInfo()

Returns:

The DmcSliceInfo if the slice is defined on this event.

getSlice

public DMPEvent getSlice(DmcSliceInfo dsi)

This method will slice the event appropriately, depending on the type of event and the specified slice.

If this is a MODIFIED event, we will check to see if any of the attributes in the modifier are associated with the specified slice. If so, a new DMPEvent is returned that has the modifier sliced to contain only changes associated with the slice. If not, null is returned.

If this is a CREATED/LOADED event, we slice the object for the required attributes and return a new DMPEvent with that information. NOTE: we always return a new event, even if all we have is the name of the object.

Parameters:

dsi -

Returns:

a sliced event with the appropriate attributes.

thisAttributeModified

public boolean thisAttributeModified(DmcAttributeInfo ai)

This convenience method can be used on MODIFIED events to determine whether or not the specified attribute is alterred by the modifier.

Parameters:

ai -

Returns: