org.processmining.mining
Interface MiningPlugin

All Superinterfaces:
Plugin
All Known Implementing Classes:
AlphaProcessMiner, ARMiner, CaseDataExtractor, ChangeMiner, CloudChamberMiner, DmcMiner, DmcProximitySensing, DTGeneticMiner, DummyMiningPlugin, DWSMiner, FrequencyAbstractionMiner, FuzzyMiner, HeuristicsMiner, LanguageRegionMiner, LogReaderBenchmark, LogReaderComparator, LogRelationBasedAlgorithm, MultiPhaseMiner, OrgMiner, PartialOrderAggregationPlugin, PartialOrderGeneratorPlugin, RealGeneticMiner, RegionMiner, SocialNetworkMiner, TraceClusteringMiner, TSGenerator, WorkflowPatternsMiner

public interface MiningPlugin
extends Plugin

The interface implemented by all mining algorithms.

This interface is the minimum that should be implemented by a mining algorithm that is used in the process mining framework. See the documentation on how to implement mining algorithms for more information.

Version:
1.0
Author:
Peter van den Brand

Method Summary
 javax.swing.JPanel getOptionsPanel(LogSummary summary)
          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 interface org.processmining.framework.plugin.Plugin
getHtmlDescription, getName
 

Method Detail

getOptionsPanel

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

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

MiningResult mine(LogReader log)
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.

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