org.processmining.mining.dwsmining
Class DWSMiner

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

public class DWSMiner
extends java.lang.Object
implements MiningPlugin

This is the main class implementing the DWS (Disjunctive Workflow Schema) mining plugin.

Version:
1.0
Author:
Gianluigi Greco, Antonella Guzzo, Luigi Pontieri
See Also:
HeuristicsNet

Constructor Summary
DWSMiner()
           
 
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 arg)
          Returns the option panel associated with this mining algorithm or null if it has no options panel.
 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
 

Constructor Detail

DWSMiner

public DWSMiner()
Method Detail

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

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

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

getOptionsPanel

public javax.swing.JPanel getOptionsPanel(LogSummary arg)
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:
arg - 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