org.processmining.mining.logabstraction
Class LogRelationBasedAlgorithm

java.lang.Object
  extended by org.processmining.mining.logabstraction.LogRelationBasedAlgorithm
All Implemented Interfaces:
Plugin, MiningPlugin
Direct Known Subclasses:
AlphaProcessMiner, MultiPhaseMiner, PartialOrderGeneratorPlugin

public abstract class LogRelationBasedAlgorithm
extends java.lang.Object
implements MiningPlugin

Version:
1.0
Author:
Peter van den Brand

Constructor Summary
LogRelationBasedAlgorithm()
           
 
Method Summary
 MiningResult editRelations(LogEvent event)
           
 LogRelations getLogRelations(LogReader log, Progress progress)
           
 javax.swing.JPanel getOptionsPanel(LogSummary summary)
          Returns the option panel associated with this mining algorithm or null if it has no options panel.
 LogRelationUI getUI()
           
 MiningResult mine(LogReader log)
          Execute this mining algorithm on the given log file.
abstract  MiningResult mine(LogReader log, LogRelations relations, Progress progress)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.processmining.framework.plugin.Plugin
getHtmlDescription, getName
 

Constructor Detail

LogRelationBasedAlgorithm

public LogRelationBasedAlgorithm()
Method Detail

mine

public abstract MiningResult mine(LogReader log,
                                  LogRelations relations,
                                  Progress progress)

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

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

getUI

public LogRelationUI getUI()

getLogRelations

public LogRelations getLogRelations(LogReader log,
                                    Progress progress)

editRelations

public MiningResult editRelations(LogEvent event)