net.esper.pattern
Interface MatchedEventMap

All Known Implementing Classes:
MatchedEventMapImpl

public interface MatchedEventMap

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.


Method Summary
 void add(String tag, EventBean event)
          Add an event to the collection identified by the given tag.
 EventBean getMatchingEvent(String tag)
          Returns a single event instance given the tag identifier, or null if the tag could not be located.
 Map getMatchingEvents()
          Returns a map containing the events where the key is the event tag string and the value is the event instance.
 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.
 

Method Detail

add

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

Map getMatchingEvents()
Returns a map containing the events where the key is the event tag string and the value is the event instance.

Returns:
Map containing event instances

getMatchingEvent

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

shallowCopy

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

Returns:
shallow copy

merge

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.

© 2007 EsperTech Inc.
All rights reserved.
Visit us at espertech.com