org.processmining.analysis.conformance
Class DiagnosticLogEvent

java.lang.Object
  extended by org.processmining.framework.log.LogEvent
      extended by org.processmining.analysis.conformance.DiagnosticLogEvent
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class DiagnosticLogEvent
extends LogEvent

Data structure to represent a log event, i.e., the actual type of log event, such as 'A complete' (i.e., including event type and opposed to the audit trail entry, which is an occurrence of a log event).

Author:
anne
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.processmining.framework.log.LogEvent
modelElementName, modelElementType, occurenceCount
 
Constructor Summary
DiagnosticLogEvent(java.lang.String name, java.lang.String type)
          Constructor taking the model element and the event type for this log event.
 
Method Summary
 void addPostActivity(DiagnosticLogEvent event)
          Increments the post-occurrence status of the indicated log event by 1.
 void addPostActivity(DiagnosticLogEvent event, int value)
          Increments the post-occurrence status of the indicated log event by the indicated value.
 void addPreActivity(DiagnosticLogEvent event)
          Increments the pre-occurrence status of the indicated log event by 1.
 void addPreActivity(DiagnosticLogEvent event, int value)
          Increments the pre-occurrence status of the indicated log event by the indicated value.
 java.util.Set<DiagnosticLogEvent> getAlwaysRelationsBackwards(int threshold)
          Retrieves all those log events that always happened (some time) before this one.
 java.util.Set<DiagnosticLogEvent> getAlwaysRelationsForwards(int threshold)
          Retrieves all those log events that always happened (some time) after this one.
 java.util.Set<DiagnosticLogEvent> getNeverRelationsBackwards(int threshold)
          Retrieves all those log events that never happened (some time) before this one.
 java.util.Set<DiagnosticLogEvent> getNeverRelationsForwards(int threshold)
          Retrieves all those log events that never happened (some time) after this one.
 java.util.Set<DiagnosticLogEvent> getPostActivities()
          Retrieves all activities that have occurred after this one.
 int getPostActivityStatus(DiagnosticLogEvent event)
          Gets the post-occurrence status of the indicated log event.
 java.util.Set<DiagnosticLogEvent> getPreActivities()
          Retrieves all activities that have occurred before this one.
 int getPreActivityStatus(DiagnosticLogEvent event)
          Gets the pre-occurrence status of the indicated log event.
 java.util.Set<DiagnosticLogEvent> getSometimesRelationForwards(int threshold)
          Retrieves all those log events that sometimes happened (some time) after this one.
 java.util.Set<DiagnosticLogEvent> getSometimesRelationsBackwards(int threshold)
          Retrieves all those log events that sometimes happened (some time) before this one.
 
Methods inherited from class org.processmining.framework.log.LogEvent
clone, compareTo, copy, equals, equals, getEventType, getModelElementName, getOccurrenceCount, hashCode, incOccurrenceCount, incOccurrenceCount, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DiagnosticLogEvent

public DiagnosticLogEvent(java.lang.String name,
                          java.lang.String type)
Constructor taking the model element and the event type for this log event.

Parameters:
name - the name of the task in the corresponding process
type - the life-cycle stage of this log event with respect to the specified activity
Method Detail

addPreActivity

public void addPreActivity(DiagnosticLogEvent event)
Increments the pre-occurrence status of the indicated log event by 1.

Parameters:
event - the log event which has been occurred some time ago

addPreActivity

public void addPreActivity(DiagnosticLogEvent event,
                           int value)
Increments the pre-occurrence status of the indicated log event by the indicated value.

Parameters:
event - the log event which has been occurred some time ago
value - the number of times this activity newly occurred before this one

getPreActivityStatus

public int getPreActivityStatus(DiagnosticLogEvent event)
Gets the pre-occurrence status of the indicated log event.

Parameters:
event - the log event which status is requested
Returns:
the status of pre-occurrence

getPreActivities

public java.util.Set<DiagnosticLogEvent> getPreActivities()
Retrieves all activities that have occurred before this one.

Returns:
the set of activities that preceded this activity some time ago

addPostActivity

public void addPostActivity(DiagnosticLogEvent event)
Increments the post-occurrence status of the indicated log event by 1.

Parameters:
event - the log event which status is to be updated

addPostActivity

public void addPostActivity(DiagnosticLogEvent event,
                            int value)
Increments the post-occurrence status of the indicated log event by the indicated value.

Parameters:
event - the log event which status is to be updated
value - the number of times this activity newly occurred after this one

getPostActivityStatus

public int getPostActivityStatus(DiagnosticLogEvent event)
Gets the post-occurrence status of the indicated log event.

Parameters:
event - the log event which status is requested
Returns:
the status of pre-occurrence

getPostActivities

public java.util.Set<DiagnosticLogEvent> getPostActivities()
Retrieves all activities that have occurred after this one.

Returns:
the set of activities that occurred after this activity

getAlwaysRelationsForwards

public java.util.Set<DiagnosticLogEvent> getAlwaysRelationsForwards(int threshold)
Retrieves all those log events that always happened (some time) after this one.

Parameters:
threshold - the number of times that an activity may not have occurred after this one while still being considered to be in "always follows" relation
Returns:
the set of those activities that always followed. May be empty

getNeverRelationsForwards

public java.util.Set<DiagnosticLogEvent> getNeverRelationsForwards(int threshold)
Retrieves all those log events that never happened (some time) after this one.
Note that when calling this method it is assumed that 0 relations are contained explicitly (rather than being indicated via the absence of that particular pre- or post-activity).

Parameters:
threshold - the number of times that an activity may have occurred after this one while still being considered to be in "never follows" relation
Returns:
the set of those activities that never followed. May be empty

getSometimesRelationForwards

public java.util.Set<DiagnosticLogEvent> getSometimesRelationForwards(int threshold)
Retrieves all those log events that sometimes happened (some time) after this one.
Note that when calling this method it is assumed that 0 relations are contained explicitly (rather than being indicated via the absence of that particular pre- or post-activity).

Parameters:
threshold - the number of times that an activity may not have occurred after this one while still being considered to be in "always follows" relation and the number of times that an activity may have occurred after this one while still being considered to be in "never follows" relation as sometimes := all - (always + never)
Returns:
the set of those activities that sometimes followed. May be empty

getAlwaysRelationsBackwards

public java.util.Set<DiagnosticLogEvent> getAlwaysRelationsBackwards(int threshold)
Retrieves all those log events that always happened (some time) before this one.

Parameters:
threshold - the number of times that an activity may not have occurred before this one while still being considered to be in "always precedes" relation
Returns:
the set of those activities that always preceeded. May be empty

getNeverRelationsBackwards

public java.util.Set<DiagnosticLogEvent> getNeverRelationsBackwards(int threshold)
Retrieves all those log events that never happened (some time) before this one.
Note that when calling this method it is assumed that 0 relations are contained explicitly (rather than being indicated via the absence of that particular pre- or post-activity).

Parameters:
threshold - the number of times that an activity may have occurred before this one while still being considered to be in "never precedes" relation
Returns:
the set of those activities that never preceeded. May be empty

getSometimesRelationsBackwards

public java.util.Set<DiagnosticLogEvent> getSometimesRelationsBackwards(int threshold)
Retrieves all those log events that sometimes happened (some time) before this one.
Note that when calling this method it is assumed that 0 relations are contained explicitly (rather than being indicated via the absence of that particular pre- or post-activity).

Parameters:
threshold - the number of times that an activity may not have occurred before this one while still being considered to be in "always precedes" relation and the number of times that an activity may have occurred before this one while still being considered to be in "never precedes" relation as sometimes := all - (always + never)
Returns:
the set of those activities that sometimes preceeded. May be empty