org.processmining.mining.cloudchamber
Class CloudChamberMiner

java.lang.Object
  extended by org.processmining.mining.cloudchamber.CloudChamberMiner
All Implemented Interfaces:
Plugin, MiningPlugin, MiningResult

public class CloudChamberMiner
extends java.lang.Object
implements MiningPlugin, MiningResult

Author:
christian

Nested Class Summary
protected  class CloudChamberMiner.UpdateWorker
           
 
Field Summary
protected  CloudChamberPanel ccPanel
           
protected static java.awt.Color COLOR_BG
           
protected static java.awt.Color COLOR_FG
           
protected static java.text.DecimalFormat format
           
protected  javax.swing.JButton helpButton
           
protected  javax.swing.JComboBox instanceJumpCombo
           
protected  javax.swing.JList instancesList
           
protected  LogReader logReader
           
protected  javax.swing.JScrollPane scrollPane
           
protected  int[] selectedInstances
           
protected  javax.swing.JSlider slider
           
protected  javax.swing.JLabel viewLabel
           
protected  CloudChamberMiner.UpdateWorker worker
           
 
Constructor Summary
CloudChamberMiner()
           
 
Method Summary
 java.lang.String getHtmlDescription()
          Gets a description of this plugin in HTML.
 LogReader getLogReader()
          Returns the LogReader object that was used to generate this mining result.
 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.
 javax.swing.JComponent getVisualization()
          Returns a component that contains the visualization of this mining result.
 MiningResult mine(LogReader log)
          Execute this mining algorithm on the given log file.
protected  void redrawSelection()
           
protected  void scrollToInstance(int index)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logReader

protected LogReader logReader

slider

protected javax.swing.JSlider slider

ccPanel

protected CloudChamberPanel ccPanel

scrollPane

protected javax.swing.JScrollPane scrollPane

viewLabel

protected javax.swing.JLabel viewLabel

instancesList

protected javax.swing.JList instancesList

selectedInstances

protected int[] selectedInstances

instanceJumpCombo

protected javax.swing.JComboBox instanceJumpCombo

helpButton

protected javax.swing.JButton helpButton

format

protected static java.text.DecimalFormat format

COLOR_BG

protected static java.awt.Color COLOR_BG

COLOR_FG

protected static java.awt.Color COLOR_FG

worker

protected CloudChamberMiner.UpdateWorker worker
Constructor Detail

CloudChamberMiner

public CloudChamberMiner()
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

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

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

getLogReader

public LogReader getLogReader()
Description copied from interface: MiningResult
Returns the LogReader object that was used to generate this mining result. This function may return null.

Specified by:
getLogReader in interface MiningResult
Returns:
the LogReader object that was used to generate this mining result or null.

getVisualization

public javax.swing.JComponent getVisualization()
Description copied from interface: MiningResult
Returns a component that contains the visualization of this mining result. This function should return null if this result cannot be visualized.

Specified by:
getVisualization in interface MiningResult
Returns:
a component that contains the visualization of this mining result or null if this result cannot be visualized

redrawSelection

protected void redrawSelection()

scrollToInstance

protected void scrollToInstance(int index)