org.processmining.framework.plugin
Interface Plugin

All Known Subinterfaces:
AnalysisPlugin, ConvertingPlugin, ExportPlugin, ImportPlugin, LogReaderConnectionImportPlugin, MiningPlugin, ProcessInstanceScale
All Known Implementing Classes:
ActivityScale, AggregationGraphToEPC, AgnaExport, AlphaProcessMiner, AmlExport, amlImport, ARMiner, BPELExport, BPELImport, BPELTooWFN, BPELToTPN, CalculateBehavioralPrecisionRecall, CalculateDuplicatesPrecisionRecall, CalculateFitness, CalculateStructuralPrecisionRecall, CaseDataExtractor, CausalFootprintSimilarity, CausalityStructureAnalysisPlugin, CausalityStructureExtractor, ChangeMiner, CloudChamberMiner, CommaSeparatedValuesExportPlugin, ConformanceAnalysisPlugin, CpnExport, CpnExport20, DecisionPointAnalysisPlugin, DgdExport, DiffPartition, DmcMiner, DmcProximitySensing, DotExport, DottedChartPlugin, DTGeneticMiner, DummyMiningPlugin, DurationScale, DWSAnalysis, DWSMiner, EPCCorrectnessChecker, EPCHierarchyFlattenerPlugin, EPCReductionPlugin, EPCToPetriNetConverterPlugin, EpcToTransitionSystem, EpmlExport, epmlImport, EventModelMergePlugin, FrequencyAbstractionMiner, FSMImport, FuzzyMiner, GroupedLogScale, GroupingSNAPlugin, GroupPIsBasedEventNameEventType, GroupPIsBasedOnFollowsRelation, HeuristicsMiner, HNetLogReaderConnectionPlugin, HNetToPetriNetConverter, HnExport, HnImport, HNNetToEPCConverter, HNStructuralPropertySummary, LanguageRegionMiner, LogBasedContributor, LogBasedRecommendation, LogClusteringPlugin, LogFilterExportPlugin, LogFilterImportPlugin, LogReaderBenchmark, LogReaderComparator, LogRelationBasedAlgorithm, LogStatisticsPlugin, LogSummaryPlugin, MergeSimModelsPlugin, MultiPhaseMiner, MultiSetRecommendationContributor, NetMinerExport, NumberOfEventsScale, OrgMiner, OrgModelExport, OrgModelImport, OriginatorPlugin, OTMatrixExport, oWFNetToPetriNet, oWFNetToWFNet, oWFNImport, PartialOrderAggregationPlugin, PartialOrderGeneratorPlugin, PartialPrefixRecommendationContributor, PDMAnalysis, PDMExport, PDMImport, PDMModelToPetriNetPlugin, PDMToSimplePetriNet, PDMtoYAWL, PerformanceAnalysisPlugin, PerformanceSequenceDiagramPlugin, Petrify2PetriNet, PetriNetAnalysis, PetriNetLogReaderConnectionPlugin, PetriNetReduction, PetriNetToHeuristicNetConverter, PetriNetTooWFNet, PetriNetToWFNet, PNKernelExport, PnmlExport, PnmlImport, PostProcessOfUML2SequenceChartImport, PPMGraphFormatExportPlugin, PPMGraphFormatImport, PPMInstancesExport, PrefixRecommendationContributor, ProcessInstanceToEPCConverter, ProcessInstanceToPetriNetConverter, ProtosExport, ProtosImport, PruneNoisyArcs, RealGeneticMiner, RecommendationContributor, RegionMiner, RegionsToPetriNet, SetRecommendationContributor, SingleProcessAcceptor, SocialNetworkAnalysisPlugin, SocialNetworkMiner, StateSpaceExportToFSM, StateSpaceRegionCalculator, TpnExport, TpnImport, TraceClusteringMiner, TransitiveReduction, TS2Petrify, TSGenerator, vdxImport, WFNetToEPC, WFNetToPetriNet, WFNetToYAWL, WoflanAnalysis, WorkflowNet2BPEL4WS, WorkflowNet2BPEL4WS, WorkflowNetStructurednessAnalysis, WorkflowPatternsMiner, XMLLogExport, YAWLExport, YAWLImport, YAWLToEPC

public interface Plugin

Defines the interface of a plugin.

Implementing classes need to specify their name. A simple return "My name"; is sufficient.

Furthermore, documentation of a plugin can be returned by the getHtmlDescription method. This documentation is displayed in the help system.

Version:
1.0
Author:
Peter van den Brand

Method Summary
 java.lang.String getHtmlDescription()
          Gets a description of this plugin in HTML.
 java.lang.String getName()
          Gets the name of this plugin.
 

Method Detail

getName

java.lang.String getName()
Gets the name of this plugin. Implementing classes should use this method to return their own name.

Returns:
the name of this plugin

getHtmlDescription

java.lang.String getHtmlDescription()
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)

Returns:
a description of this plugin in HTML