casa.event

Class MessageObserverEvent

java.lang.Object

java.util.Observable

casa.event.AbstractEvent

casa.event.TriggerEvent

casa.event.MessageObserverEvent

All Implemented Interfaces:

Event, Describable, Cloneable, Comparable<AbstractEvent>, Observer

public class MessageObserverEvent
extends TriggerEvent
implements Observer

Defines an Event that will be triggered when the owner agent receives a message matching the patternPairs given in this constructor. Don't forget to call the TriggerEvent.start() method to enable the trigger.

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) MessageEventDescriptor[]	descriptor
protected MLMessage	message
(package private) boolean	observing

Fields inherited from class casa.event.AbstractEvent

agent, fired, id, priority, queueTime

Fields inherited from interface casa.event.Event

DEFAULT_PRIORITY, FIRE_EVENT, HIGHEST_PRIORITY

Constructor Summary

Constructors

Constructor and Description
MessageObserverEvent(boolean recurring, PolicyAgentInterface agent, MessageEventDescriptor... descriptor) Construct a new Event that will be triggered when the owner agent receives a message matching the patterhPairs given in this constructor.

Method Summary

Modifier and Type	Method and Description
void	cancel() Signals that this event should actually be deleted and not repeated after the next call to TriggerEvent.delete().
void	delete() Deletes the event from the internal list of all Events.
void	fireEvent() Overrides AbstractEvent.fireEvent() by checking to see if this event has been TriggerEvent.cancel()'ed.
MLMessage	getMessage()
void	update(Observable o, Object arg) Override the update() template method to call the TriggerEvent.trigger() method iff the update was for a ML.EVENT_MESSAGE_RECEIVED event and the received message matches the pattern given in the constructor.

Methods inherited from class casa.event.TriggerEvent

hasBeenQueued, hasStarted, hasTriggered, isRecurring, start, trigger

Methods inherited from class casa.event.AbstractEvent

clone, compareTo, getEventType, getID, getOwnerConversationID, getParameter, getPriority, getQueueTime, hasFired, keySet, setOwnerConversationID, setParameter, setParameters, setPriority, setQueueTime, toString

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface casa.event.Event

addObserver, countObservers, deleteObserver

Field Detail

message

protected MLMessage message

descriptor

MessageEventDescriptor[] descriptor

observing

boolean observing

Constructor Detail

MessageObserverEvent

public MessageObserverEvent(boolean recurring,
                            PolicyAgentInterface agent,
                            MessageEventDescriptor... descriptor)

Construct a new Event that will be triggered when the owner agent receives a message matching the patterhPairs given in this constructor. Don't forget to call the TriggerEvent.start() method to enable the trigger.

Parameters:

recurring - set to true to make this a recurring event that doesn't disappear after one activation (see Event.isRecurring())

agent - The agent that owns this Event and will be watched for the matching received message

patternPairs - A even-cardinality list interpreted as key/value pairs that will be used to match on the received message

See Also:

update(Observable, Object)

Method Detail

getMessage

public MLMessage getMessage()

Returns:

the message that triggered this event (will be null before it's triggered).

update

public void update(Observable o,
                   Object arg)

Override the update() template method to call the TriggerEvent.trigger() method iff the update was for a ML.EVENT_MESSAGE_RECEIVED event and the received message matches the pattern given in the constructor. By matches we mean that each key in the pattern exists in the message and the value of the key in the pattern subsumes the value of the key in the message.

Specified by:

update in interface Observer

See Also:

Observer.update(java.util.Observable, java.lang.Object)

cancel

public void cancel()

Description copied from class: TriggerEvent

Signals that this event should actually be deleted and not repeated after the next call to TriggerEvent.delete().

Overrides:

cancel in class TriggerEvent

fireEvent

public void fireEvent()

Description copied from class: TriggerEvent

Overrides AbstractEvent.fireEvent() by checking to see if this event has been TriggerEvent.cancel()'ed. If it has not been cancelled, AbstractEvent.fireEvent() is called.

Specified by:

fireEvent in interface Event

Overrides:

fireEvent in class TriggerEvent

delete

public void delete()

Description copied from class: TriggerEvent

Deletes the event from the internal list of all Events. But if this is a TriggerEvent.recurring event, it doesn't delete the event unless TriggerEvent.cancel() has been previously called.

Overrides:

delete in class TriggerEvent

See Also:

AbstractEvent.delete()