org.processmining.mining.dmcscanning
Class BufferedDmcScanner

java.lang.Object
  extended by org.processmining.mining.dmcscanning.BufferedDmcScanner

public class BufferedDmcScanner
extends java.lang.Object

BufferedDMCScanner This class provides static facilities for extracting DMCs from a log. Next to integrating event buffering (for implementing the shifting scan window overlay) it encapsulates complete DMC extraction and handling, returning all DMCs within the provided log within a dedicated DMCSet instance for further processing. Notice: Consider moving these static method(s) to another class to clean up design.

Author:
Christian W. Guenther (christian at deckfour dot org)

Constructor Summary
BufferedDmcScanner()
           
 
Method Summary
static DmcSet scanInitialDmcs(LogReader reader, Progress progress, long maxProximity, long maxEvents, boolean enforceOriginator, boolean enforceEventType, ObjectEquivalence equivalence)
          Scans a log for all DMCs, extracts them and returns them in a DMCSet collection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BufferedDmcScanner

public BufferedDmcScanner()
Method Detail

scanInitialDmcs

public static DmcSet scanInitialDmcs(LogReader reader,
                                     Progress progress,
                                     long maxProximity,
                                     long maxEvents,
                                     boolean enforceOriginator,
                                     boolean enforceEventType,
                                     ObjectEquivalence equivalence)
Scans a log for all DMCs, extracts them and returns them in a DMCSet collection. The scanning pass is implemented as follows: The log is scanned event-wise, 'looking ahead' a subset of events as specified by maximum proximity and event count. Within that subset, all events that satisfy the specified conditions (equal originator or event type) are added to the currently scanned DMC.

Parameters:
reader - the LogReader to be used for extracting the log in question
progress - a Progress window to display status information
maxProximity - the temporal extension (in milliseconds) of the scan window (i.e. the maximum time between the first and last events within a DMC) - ignored if <=0.
maxEvents - maximum number of events to be contained within a DMC - ignored if <=0.
enforceOriginator - only events with the same originator are contained within one DMC
enforceEventType - only events with the same type are contained within one DMC
Returns:
a DMCSet instance containing the scanning result, i.e. all extracted DMCs