org.processmining.mining.change
Class ChangeMiner

java.lang.Object
  extended by org.processmining.mining.change.ChangeMiner
All Implemented Interfaces:
Plugin, MiningPlugin

public class ChangeMiner
extends java.lang.Object
implements MiningPlugin

This mining plugin uses the instance / multi-phase mining technique to build and aggregate instance graphs describing change processes. The ordering relation between change operations, i.e. events, is not solely based on occurrence of events in the log, but (partially) replaced by the defined notion of commutativity between change operations.

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

Field Summary
protected  ChangeMinerOptionsPanel optionsPanel
           
 
Constructor Summary
ChangeMiner()
           
 
Method Summary
 java.lang.String getHtmlDescription()
          Gets a description of this plugin in HTML.
 java.lang.String getName()
          Gets the name of this plugin.
 javax.swing.JPanel getOptionsPanel(LogSummary summary)
          Returns the option panel associated with this mining algorithm or null if it has no options panel.
protected  boolean isChangeLog(LogReader log)
           
 MiningResult mine(LogReader log)
          Execute this mining algorithm on the given log file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

optionsPanel

protected ChangeMinerOptionsPanel optionsPanel
Constructor Detail

ChangeMiner

public ChangeMiner()
Method Detail

getOptionsPanel

public javax.swing.JPanel getOptionsPanel(LogSummary summary)
Description copied from interface: MiningPlugin
Returns the option panel associated with this mining algorithm or null if it has no options panel. The option panel is the panel that is shown when a log file has just been opened. The user can set the options for the mining algorithm here.

Specified by:
getOptionsPanel in interface MiningPlugin
Parameters:
summary - all known information about the log that's going to be mined with this algorithm
Returns:
the option panel associated with this mining algorithm or null if it has no options panel

mine

public MiningResult mine(LogReader log)
Description copied from interface: MiningPlugin
Execute this mining algorithm on the given log file. The log parameter provides methods to extract the process instances and audit trail entries (cases) from the log file. This method is allowed to return null in case there are no results.

Specified by:
mine in interface MiningPlugin
Parameters:
log - process instances and audit trail entries
Returns:
the result of the mining algorithm, in a MininResult object

getName

public java.lang.String getName()
Description copied from interface: Plugin
Gets the name of this plugin. Implementing classes should use this method to return their own name.

Specified by:
getName in interface Plugin
Returns:
the name of this plugin

getHtmlDescription

public java.lang.String getHtmlDescription()
Description copied from interface: Plugin
Gets a description of this plugin in HTML. The string returned by this method should only contain the contents of the body of the html page, so the html, head and body tags should not be used. This HTML page is displayed in the help system or as context sensitive help. The HTML body can be stored in an external file in the /lib/documentation/ sub folder and in this case it can be obtained by calling PluginDocumentationLoader.load(this)

Specified by:
getHtmlDescription in interface Plugin
Returns:
a description of this plugin in HTML

isChangeLog

protected boolean isChangeLog(LogReader log)