net.esper.pattern
Class MatchedEventMap

java.lang.Object
  extended by net.esper.pattern.MatchedEventMap

public final class MatchedEventMap
extends Object

Collection for internal use similar to the MatchedEventMap class in the client package that holds the one or more events that could match any defined event expressions. The optional tag value supplied when an event expression is created is used as a key for placing matching event objects into this collection.


Constructor Summary
MatchedEventMap()
          Constructor creates an empty collection of events.
 
Method Summary
 void add(String tag, EventBean event)
          Add an event to the collection identified by the given tag.
 boolean equals(Object otherObject)
           
 EventBean getMatchingEvent(String tag)
          Returns a single event instance given the tag identifier, or null if the tag could not be located.
 Hashtable<String,EventBean> getMatchingEvents()
          Returns a Hashtable containing the events where the key is the event tag string and the value is the event instance.
 int hashCode()
           
 void merge(MatchedEventMap other)
          Merge the state of an other match event structure into this one by adding all entries within the MatchedEventMap to this match event.
 MatchedEventMap shallowCopy()
          Make a shallow copy of this collection.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MatchedEventMap

public MatchedEventMap()
Constructor creates an empty collection of events.

Method Detail

add

public void add(String tag,
                EventBean event)
Add an event to the collection identified by the given tag.

Parameters:
tag - is an identifier to retrieve the event from
event - is the event object to be added

getMatchingEvents

public Hashtable<String,EventBean> getMatchingEvents()
Returns a Hashtable containing the events where the key is the event tag string and the value is the event instance.

Returns:
Hashtable containing event instances

getMatchingEvent

public EventBean getMatchingEvent(String tag)
Returns a single event instance given the tag identifier, or null if the tag could not be located.

Parameters:
tag - is the identifier to look for
Returns:
event instances for the tag

equals

public boolean equals(Object otherObject)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

shallowCopy

public MatchedEventMap shallowCopy()
Make a shallow copy of this collection.

Returns:
shallow copy

merge

public void merge(MatchedEventMap other)
Merge the state of an other match event structure into this one by adding all entries within the MatchedEventMap to this match event.

Parameters:
other - is the other instance to merge in.