Package beamline.events

Class BEvent

java.lang.Object

beamline.events.BEvent

All Implemented Interfaces:

Serializable, Comparable<BEvent>

public class BEvent
extends Object
implements Serializable, Comparable<BEvent>

This class describes an event for the Beamline framework. An event is the minimal observable unit in the context of streaming process mining. Each event is expected to belong to a process instance which, in turn, belongs to a process. For this reason, when an event is created (for example using the BEvent(String, String, String) constructor).

Some level of compatibility with the OpenXES library is guaranteed by:

• using the same attribute names for internally storing the name of the attributes;
• having the capability of setting attributes using the setTraceAttribute(String, XAttribute) and setEventAttribute(String, XAttribute) which take an XAttribute as parameter.

Author:

Andrea Burattin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BEvent(String processName, String caseId, String activityName)	Creates a new BEvent referring to one event
BEvent(String processName, String caseId, String activityName, Date time)	Creates a new BEvent referring to one event
BEvent(String processName, String caseId, String activityName, Date time, Collection<org.apache.commons.lang3.tuple.Pair<String,String>> eventAttributes)	Creates a new BEvent referring to one event

Method Summary

Modifier and Type	Method	Description
int	compareTo(BEvent o)
boolean	equals(Object obj)
Map<String,Serializable>	getEventAttributes()	Gets all event level attributes
String	getEventName()	Gets the event name (a.k.a.
Date	getEventTime()	Gets the event time
Map<String,Serializable>	getProcessAttributes()	Gets all process level attributes
String	getProcessName()	Gets the process name
Map<String,Serializable>	getTraceAttributes()	Gets all trace level attributes
String	getTraceName()	Gets the trace name (a.k.a.
int	hashCode()
void	setEventAttribute(String name, Serializable value)	Sets a event level attribute
void	setEventAttribute(String name, org.deckfour.xes.model.XAttribute value)	Sets a event level attribute
void	setEventName(String name)	Sets the event name (a.k.a.
void	setProcessAttribute(String name, Serializable value)	Sets a process level attribute
void	setProcessAttribute(String name, org.deckfour.xes.model.XAttribute value)	Sets a process level attribute
void	setProcessName(String name)	Sets the process name
void	setTimestamp(Date timestamp)	Sets the event time
void	setTraceAttribute(String name, Serializable value)	Sets a trace level attribute
void	setTraceAttribute(String name, org.deckfour.xes.model.XAttribute value)	Sets a trace level attribute
void	setTraceName(String name)	Sets the trace name (a.k.a.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BEvent

public BEvent(String processName,
              String caseId,
              String activityName,
              Date time,
              Collection<org.apache.commons.lang3.tuple.Pair<String,String>> eventAttributes)
       throws EventException

Creates a new BEvent referring to one event

Parameters:

processName - the name of the process

activityName - the name of the activity

caseId - the identifier of the process instance

time - the time when the event has happened

eventAttributes - a collection of string attributes for the event

Throws:

EventException - this exception is thrown is incomplete information is provided

BEvent

public BEvent(String processName,
              String caseId,
              String activityName,
              Date time)
       throws EventException

Creates a new BEvent referring to one event

Parameters:

processName - the name of the process

activityName - the name of the activity

caseId - the identifier of the process instance

time - the time when the event has happened

Throws:

EventException - this exception is thrown is incomplete information is provided

BEvent

public BEvent(String processName,
              String caseId,
              String activityName)
       throws EventException

Creates a new BEvent referring to one event

Parameters:

processName - the name of the process

activityName - the name of the activity

caseId - the identifier of the process instance

Throws:

EventException - this exception is thrown is incomplete information is provided

Method Detail

setProcessName

public void setProcessName(String name)

Sets the process name

Parameters:

name - the process name

getProcessName

public String getProcessName()

Gets the process name

Returns:

the process name

setTraceName

public void setTraceName(String name)

Sets the trace name (a.k.a. case id)

Parameters:

name - the trace name

getTraceName

public String getTraceName()

Gets the trace name (a.k.a. case id)

Returns:

the trace name

setEventName

public void setEventName(String name)

Sets the event name (a.k.a. activity name)

Parameters:

name - the event name

getEventName

public String getEventName()

Gets the event name (a.k.a. activity name)

Returns:

the event name

setTimestamp

public void setTimestamp(Date timestamp)

Sets the event time

Parameters:

timestamp - the event time

getEventTime

public Date getEventTime()

Gets the event time

Returns:

the event time

getEventAttributes

public Map<String,Serializable> getEventAttributes()

Gets all event level attributes

Returns:

the attributes

getTraceAttributes

public Map<String,Serializable> getTraceAttributes()

Gets all trace level attributes

Returns:

the attributes

getProcessAttributes

public Map<String,Serializable> getProcessAttributes()

Gets all process level attributes

Returns:

the attributes

setEventAttribute

public void setEventAttribute(String name,
                              Serializable value)

Sets a event level attribute

Parameters:

name - the attribute name

value - the attribute value

setEventAttribute

public void setEventAttribute(String name,
                              org.deckfour.xes.model.XAttribute value)

Sets a event level attribute

Parameters:

name - the attribute name

value - the attribute value

setTraceAttribute

public void setTraceAttribute(String name,
                              Serializable value)

Sets a trace level attribute

Parameters:

name - the attribute name

value - the attribute value

setTraceAttribute

public void setTraceAttribute(String name,
                              org.deckfour.xes.model.XAttribute value)

Sets a trace level attribute

Parameters:

name - the attribute name

value - the attribute value

setProcessAttribute

public void setProcessAttribute(String name,
                                Serializable value)

Sets a process level attribute

Parameters:

name - the attribute name

value - the attribute value

setProcessAttribute

public void setProcessAttribute(String name,
                                org.deckfour.xes.model.XAttribute value)

Sets a process level attribute

Parameters:

name - the attribute name

value - the attribute value

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(BEvent o)

Specified by:

compareTo in interface Comparable<BEvent>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object