net.sf.eBus.feed

Class MatchEvent

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

net.sf.eBus.feed.MatchEvent

All Implemented Interfaces:

Serializable

@ELocalOnly
public final class MatchEvent
extends ENotificationMessage
implements Serializable

A match event reports an event pattern match. Contains the capturing group map and the user-defined data cache.

Author:

Charles W. Rapp

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.eBus.messages.ENotificationMessage

ENotificationMessage.Builder<M extends ENotificationMessage,B extends ENotificationMessage.Builder<M,?>>

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,List<ENotificationMessage>>	groups The collected events for each pattern group.
Map<Object,Object>	userCache This map contains the user-defined data stored when MatchConditions were executed.

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Constructor Summary

Constructors

Constructor and Description
MatchEvent(String subject, long timestamp) Creates a new match event for the given subject and timestamp.
MatchEvent(String subject, long timestamp, Map<String,List<ENotificationMessage>> groups, Map<Object,Object> userCache) Creates a new match event for the given subject, timestamp, and pattern groups.
MatchEvent(String subject, Map<String,List<ENotificationMessage>> groups, Map<Object,Object> userCache) Create a new match event for the given pattern groups.

Method Summary

Modifier and Type	Method and Description
List<ENotificationMessage>	group(String name) Returns the notification list associated with the given group name.
String	toString() Returns a string containing each of the groups and the group event.

Methods inherited from class net.sf.eBus.messages.EMessage

equals, hashCode, isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

groups

public final Map<String,List<ENotificationMessage>> groups

The collected events for each pattern group. Pattern group EventPattern.ALL_EVENTS contains all matched events. The remaining map keys (if any) are from the user-defined EventPattern. The groups map and the notification list values are both read-only.

userCache

public final Map<Object,Object> userCache

This map contains the user-defined data stored when MatchConditions were executed. This map is not null but may be empty.

Constructor Detail

MatchEvent

public MatchEvent(String subject,
                  Map<String,List<ENotificationMessage>> groups,
                  Map<Object,Object> userCache)

Create a new match event for the given pattern groups. The timestamp is set the current millisecond epoch time.

Parameters:

subject - subject used to open pattern feed.

groups - matched pattern groups.

userCache - map containing user-defined data. This map is never null but may be empty.

MatchEvent

public MatchEvent(String subject,
                  long timestamp)

Creates a new match event for the given subject and timestamp. This event has an empty groups map.

Parameters:

subject - notification subject.

timestamp - millisecond epoch time for event.

MatchEvent

public MatchEvent(String subject,
                  long timestamp,
                  Map<String,List<ENotificationMessage>> groups,
                  Map<Object,Object> userCache)

Creates a new match event for the given subject, timestamp, and pattern groups.

Parameters:

subject - notification subject. Set by user when opening EPatternFeed.

timestamp - millisecond epoch time for event.

groups - pattern groups containing zero or more matched events.

userCache - map containing user-defined data. This map is never null but may be empty.

Method Detail

toString

public String toString()

Returns a string containing each of the groups and the group event.

Overrides:

toString in class EMessage

Returns:

textual representation of the match event.

group

public List<ENotificationMessage> group(String name)

Returns the notification list associated with the given group name. May return null if there is not group with the given name.

Parameters:

name - group name.

Returns:

group event list.