Package org.deckfour.xes.classification

Class XEventAttributeClassifier

java.lang.Object

org.deckfour.xes.classification.XEventAttributeClassifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XEventAttributeClassifier>, XEventClassifier

Direct Known Subclasses:

XEventAndClassifier, XEventLifeTransClassifier, XEventNameClassifier, XEventResourceClassifier

public class XEventAttributeClassifier
extends java.lang.Object
implements XEventClassifier, java.lang.Comparable<XEventAttributeClassifier>, java.io.Serializable

Event classifier which considers two events as equal, if, for a set of given (configurable) attributes, they have the same values.

Author:

Christian W. Guenther (christian@deckfour.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String[]	keys	Keys of the attributes used for event comparison.
protected java.lang.String	name	Name of the classifier

Constructor Summary

Constructors

Constructor	Description
XEventAttributeClassifier(java.lang.String name, java.lang.String... keys)	Creates a new instance, configured by the given attribute.

Method Summary

Modifier and Type	Method	Description
void	accept(XVisitor visitor, XLog log)	Runs the given visitor for the given log on this classifier.
int	compareTo(XEventAttributeClassifier o)
boolean	equals(java.lang.Object o)
java.lang.String	getClassIdentity(XEvent event)	Retrieves the unique class identity string of a given event.
java.lang.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).
int	hashCode()
java.lang.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(java.lang.String name)	Assigns a custom name to this classifier
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

keys

protected java.lang.String[] keys

Keys of the attributes used for event comparison.

name

protected java.lang.String name

Name of the classifier

Constructor Detail

XEventAttributeClassifier

public XEventAttributeClassifier(java.lang.String name,
                                 java.lang.String... keys)

Creates a new instance, configured by the given attribute.

Parameters:

name - Name of the classifier.

attribute - Attribute to be used for event classification.

Method Detail

getClassIdentity

public java.lang.String getClassIdentity(XEvent event)

Description copied from interface: XEventClassifier

Retrieves the unique class identity string of a given event.

Specified by:

getClassIdentity in interface XEventClassifier

setName

public void setName(java.lang.String name)

Assigns a custom name to this classifier

Specified by:

setName in interface XEventClassifier

Parameters:

name - Name to be assigned to this classifier.

name

public java.lang.String name()

Description copied from interface: XEventClassifier

Returns the name of this comparator

Specified by:

name in interface XEventClassifier

sameEventClass

public boolean sameEventClass(XEvent eventA,
                              XEvent eventB)

Description copied from interface: XEventClassifier

Checks whether two event instances correspond to the same event class, i.e. are equal in that sense.

Specified by:

sameEventClass in interface XEventClassifier

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDefiningAttributeKeys

public java.lang.String[] getDefiningAttributeKeys()

Description copied from interface: XEventClassifier

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).

Specified by:

getDefiningAttributeKeys in interface XEventClassifier

Returns:

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

compareTo

public int compareTo(XEventAttributeClassifier o)

Specified by:

compareTo in interface java.lang.Comparable<XEventAttributeClassifier>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

accept

public void accept(XVisitor visitor,
                   XLog log)

Description copied from interface: XEventClassifier

Runs the given visitor for the given log on this classifier.

Specified by:

accept in interface XEventClassifier