org.deckfour.xes.classification
Interface XEventClassifier

All Known Implementing Classes:
XEventAndClassifier, XEventAttributeClassifier, XEventLifeTransClassifier, XEventNameClassifier, XEventResourceClassifier

public interface XEventClassifier

This interface defines a classification of events. It assigns to each event instance a class identity, thereby imposing an equality relation on the set of events.

Author:
Christian W. Guenther (christian@deckfour.org)

Method Summary
 String getClassIdentity(XEvent event)
          Retrieves the unique class identity string of a given event.
 String[] getDefiningAttributeKeys()
          Retrieves the set of attribute keys which are used in this event classifier (May be used for the construction of events that are not part of an existing event class).
 String name()
          Returns the name of this comparator
 boolean sameEventClass(XEvent eventA, XEvent eventB)
          Checks whether two event instances correspond to the same event class, i.e.
 void setName(String name)
          Assigns a custom name to this classifier
 

Method Detail

name

String name()
Returns the name of this comparator


setName

void setName(String name)
Assigns a custom name to this classifier

Parameters:
name - Name to be assigned to this classifier.

sameEventClass

boolean sameEventClass(XEvent eventA,
                       XEvent eventB)
Checks whether two event instances correspond to the same event class, i.e. are equal in that sense.


getClassIdentity

String getClassIdentity(XEvent event)
Retrieves the unique class identity string of a given event.


getDefiningAttributeKeys

String[] getDefiningAttributeKeys()
Retrieves the set of attribute keys which are used in this event classifier (May be used for the construction of events that are not part of an existing event class).

Returns:
A set of attribute keys, which are used for defining this classifier.