com.espertech.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

Modifier and Type	Method and Description
void	add(int tag, Object theEvent) Add an event to the collection identified by the given tag.
EventBean	getMatchingEvent(int tag) Returns a single event instance given the tag identifier, or null if the tag could not be located.
Object	getMatchingEventAsObject(int tag) Returns the object for the matching event, be it the event bean array or the event bean.
Object	getMatchingEventAsObjectByTag(String key)
EventBean	getMatchingEventByTag(String resultEventAsName)
Object[]	getMatchingEvents() Returns a map containing the events where the key is the event tag string and the value is the event instance.
Map<String,Object>	getMatchingEventsAsMap()
MatchedEventMapMeta	getMeta()
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(int tag,
         Object theEvent)

Add an event to the collection identified by the given tag.

Parameters:

tag - is an identifier to retrieve the event from

theEvent - is the event object or array of event object to be added

getMatchingEvents

Object[] 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(int 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

getMatchingEventAsObject

Object getMatchingEventAsObject(int tag)

Returns the object for the matching event, be it the event bean array or the event bean.

Parameters:

tag - is the tag to return the object for

Returns:

event bean or event bean array

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.

getMatchingEventsAsMap

Map<String,Object> getMatchingEventsAsMap()

getMatchingEventByTag

EventBean getMatchingEventByTag(String resultEventAsName)

getMatchingEventAsObjectByTag

Object getMatchingEventAsObjectByTag(String key)

getMeta

MatchedEventMapMeta getMeta()