Update PlacesProvider to allow choosing an algorithm and setting discovery parameters

Author: VikiPeeva

src/org/processmining/placebasedlpmdiscovery/prom/FromLogPlacesProvider.java

@@ -2,10 +2,10 @@
 
 import org.deckfour.xes.model.XLog;
 import org.processmining.placebasedlpmdiscovery.model.Place;
+import org.processmining.placebasedlpmdiscovery.prom.placediscovery.PlaceDiscoveryAlgorithmId;
 import org.processmining.placebasedlpmdiscovery.prom.placediscovery.algorithms.PlaceDiscoveryAlgorithm;
 import org.processmining.placebasedlpmdiscovery.prom.placediscovery.algorithms.PlaceDiscoveryAlgorithmFactory;
-import org.processmining.placebasedlpmdiscovery.prom.placediscovery.parameters.EstMinerPlaceDiscoveryParameters;
-import org.processmining.placebasedlpmdiscovery.prom.placediscovery.parameters.SPECppPlaceDiscoveryParameters;
+import org.processmining.placebasedlpmdiscovery.prom.placediscovery.parameters.*;
 
 import java.util.Set;
 
@@ -19,6 +19,36 @@ public FromLogPlacesProvider(XLog log, PlaceDiscoveryAlgorithm<?, ?> algorithm)
         this.algorithm = algorithm;
     }
 
+    /**
+     * Creates a PlacesProvider that discovers places using the specified algorithm.
+     * @param log the XLog to discover places from
+     * @param algorithmId the algorithm to use for place discovery
+     * @return a PlacesProvider that discovers places using the specified algorithm
+     */
+    public static PlacesProvider getInstance(XLog log, PlaceDiscoveryAlgorithmId algorithmId) {
+        if (algorithmId == PlaceDiscoveryAlgorithmId.ESTMiner) {
+            return est(log);
+        } else if (algorithmId == PlaceDiscoveryAlgorithmId.SPECpp) {
+            return specpp(log);
+        } else if (algorithmId == PlaceDiscoveryAlgorithmId.HeuristicMiner) {
+            return heuristicMiner(log);
+        } else if (algorithmId == PlaceDiscoveryAlgorithmId.InductiveMiner) {
+            return inductiveMiner(log);
+        }
+        throw new IllegalArgumentException("Unsupported PlaceDiscoveryAlgorithmId: " + algorithmId);
+    }
+
+    /**
+     * Creates a PlacesProvider that discovers places using the specified parameters.
+     * @param log the XLog to discover places from
+     * @param placeDiscoveryParameters the parameters to use for place discovery
+     * @return a PlacesProvider that discovers places using the specified parameters
+     */
+    public static PlacesProvider getInstance(XLog log, PlaceDiscoveryParameters placeDiscoveryParameters) {
+        PlaceDiscoveryAlgorithmFactory factory = PlaceDiscoveryAlgorithmFactory.getInstance();
+        return new FromLogPlacesProvider(log, placeDiscoveryParameters.getAlgorithm(factory));
+    }
+
     @Override
     public Set<Place> provide() {
         return algorithm.getPlaces(this.log).getPlaces();
@@ -39,9 +69,8 @@ public static PlacesProvider recommended(XLog log) {
      * @return a PlacesProvider that discovers places using the EST-Miner algorithm
      */
     public static PlacesProvider est(XLog log) {
-        PlaceDiscoveryAlgorithmFactory factory = new PlaceDiscoveryAlgorithmFactory();
         EstMinerPlaceDiscoveryParameters parameters = new EstMinerPlaceDiscoveryParameters();
-        return new FromLogPlacesProvider(log, parameters.getAlgorithm(factory));
+        return getInstance(log, parameters);
     }
 
     /**
@@ -50,9 +79,27 @@ public static PlacesProvider est(XLog log) {
      * @return a PlacesProvider that discovers places using the SPECpp algorithm
      */
     public static PlacesProvider specpp(XLog log) {
-        PlaceDiscoveryAlgorithmFactory factory = new PlaceDiscoveryAlgorithmFactory();
         SPECppPlaceDiscoveryParameters parameters = new SPECppPlaceDiscoveryParameters();
-        return new FromLogPlacesProvider(log, parameters.getAlgorithm(factory));
+        return getInstance(log, parameters);
     }
 
+    /**
+     * Creates a PlacesProvider that discovers places using the Heuristic Miner algorithm.
+     * @param log the XLog to discover places from
+     * @return a PlacesProvider that discovers places using the Heuristic Miner algorithm
+     */
+    public static PlacesProvider heuristicMiner(XLog log) {
+        HeuristicMinerPlaceDiscoveryParameters parameters = new HeuristicMinerPlaceDiscoveryParameters();
+        return getInstance(log, parameters);
+    }
+
+    /**
+     * Creates a PlacesProvider that discovers places using the Inductive Miner algorithm.
+     * @param log the XLog to discover places from
+     * @return a PlacesProvider that discovers places using the Inductive Miner algorithm
+     */
+    public static PlacesProvider inductiveMiner(XLog log) {
+        InductiveMinerPlaceDiscoveryParameters parameters = new InductiveMinerPlaceDiscoveryParameters();
+        return getInstance(log, parameters);
+    }
 }

src/org/processmining/placebasedlpmdiscovery/prom/PlacesProvider.java

@@ -2,6 +2,8 @@
 
 import org.deckfour.xes.model.XLog;
 import org.processmining.placebasedlpmdiscovery.model.Place;
+import org.processmining.placebasedlpmdiscovery.prom.placediscovery.PlaceDiscoveryAlgorithmId;
+import org.processmining.placebasedlpmdiscovery.prom.placediscovery.parameters.PlaceDiscoveryParameters;
 
 import java.util.Set;
 
@@ -38,6 +40,26 @@ static PlacesProvider fromLog(XLog log) {
         return FromLogPlacesProvider.recommended(log);
     }
 
+    /**
+     * Creates a PlacesProvider that discovers places using the specified algorithm.
+     * @param log the XLog to discover places from
+     * @param placeDiscoveryAlgorithmId the algorithm to use for place discovery
+     * @return a PlacesProvider that discovers places using the specified algorithm
+     */
+    static PlacesProvider fromLog(XLog log, PlaceDiscoveryAlgorithmId placeDiscoveryAlgorithmId) {
+        return FromLogPlacesProvider.getInstance(log, placeDiscoveryAlgorithmId);
+    }
+
+    /**
+     * Creates a PlacesProvider that discovers places using the specified parameters.
+     * @param log the XLog to discover places from
+     * @param placeDiscoveryParameters the parameters to use for place discovery
+     * @return a PlacesProvider that discovers places using the specified parameters
+     */
+    static PlacesProvider fromLog(XLog log, PlaceDiscoveryParameters placeDiscoveryParameters) {
+        return FromLogPlacesProvider.getInstance(log, placeDiscoveryParameters);
+    }
+
     /**
      * Provides a set of places.
      * @return a set of places

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/PlaceDiscoveryAlgorithmId.java

@@ -3,5 +3,6 @@
 public enum PlaceDiscoveryAlgorithmId {
     ESTMiner,
     InductiveMiner,
+    SPECpp,
     HeuristicMiner
 }

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/StandardPlaceDiscovery.java

@@ -16,7 +16,8 @@ public StandardPlaceDiscovery(XLog log, PlaceDiscoveryParameters parameters){
         this.parameters = parameters;
     }
     public PlaceDiscoveryResult getPlaces() {
-        PlaceDiscoveryAlgorithmFactory factory = new PlaceDiscoveryAlgorithmFactory(); // TODO: Why not using the factory directly?
+        // TODO: Why not using the factory directly?
+        PlaceDiscoveryAlgorithmFactory factory = PlaceDiscoveryAlgorithmFactory.getInstance();
         PlaceDiscoveryAlgorithm<? extends PlaceDiscoveryParameters, ?> algorithm = parameters.getAlgorithm(factory);
         return algorithm.getPlaces(log);
     }

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/algorithms/PlaceDiscoveryAlgorithmFactory.java

@@ -8,6 +8,10 @@
 
 public class PlaceDiscoveryAlgorithmFactory {
 
+    public static PlaceDiscoveryAlgorithmFactory getInstance() {
+        return new PlaceDiscoveryAlgorithmFactory();
+    }
+
     public EstMinerPlaceDiscoveryAlgorithm createPlaceDiscoveryAlgorithm(EstMinerPlaceDiscoveryParameters parameters) {
         return new EstMinerPlaceDiscoveryAlgorithm(new PetriNetPlaceConverter(), parameters);
     }

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/parameters/EstMinerPlaceDiscoveryParameters.java

@@ -7,7 +7,7 @@
 import org.processmining.v7.postproc_after_tc.MyParameters;
 //import org.processmining.v8.eSTMinerGIT.Parameters;
 
-public class EstMinerPlaceDiscoveryParameters extends PlaceDiscoveryParameters {
+public class EstMinerPlaceDiscoveryParameters implements PlaceDiscoveryParameters {
     private MyParameters wrappedParameters;
 
     public EstMinerPlaceDiscoveryParameters() {

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/parameters/HeuristicMinerPlaceDiscoveryParameters.java

@@ -5,7 +5,7 @@
 import org.processmining.placebasedlpmdiscovery.prom.placediscovery.algorithms.PlaceDiscoveryAlgorithmFactory;
 import org.processmining.plugins.heuristicsnet.miner.heuristics.miner.settings.HeuristicsMinerSettings;
 
-public class HeuristicMinerPlaceDiscoveryParameters extends PlaceDiscoveryParameters {
+public class HeuristicMinerPlaceDiscoveryParameters implements PlaceDiscoveryParameters {
 
     private HeuristicsMinerSettings settings;
 

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/parameters/InductiveMinerPlaceDiscoveryParameters.java

@@ -7,7 +7,7 @@
 import org.processmining.plugins.InductiveMiner.mining.MiningParametersIM;
 import org.processmining.plugins.InductiveMiner.plugins.dialogs.IMMiningDialog;
 
-public class InductiveMinerPlaceDiscoveryParameters extends PlaceDiscoveryParameters {
+public class InductiveMinerPlaceDiscoveryParameters implements PlaceDiscoveryParameters {
     private MiningParameters miningParameters;
     private IMMiningDialog.Variant variant;
 

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/parameters/PlaceDiscoveryParameters.java

@@ -3,7 +3,7 @@
 import org.processmining.placebasedlpmdiscovery.prom.placediscovery.algorithms.PlaceDiscoveryAlgorithm;
 import org.processmining.placebasedlpmdiscovery.prom.placediscovery.algorithms.PlaceDiscoveryAlgorithmFactory;
 
-public abstract class PlaceDiscoveryParameters {
+public interface PlaceDiscoveryParameters {
 
-    public abstract PlaceDiscoveryAlgorithm<? extends PlaceDiscoveryParameters, ?> getAlgorithm(PlaceDiscoveryAlgorithmFactory factory);
+    PlaceDiscoveryAlgorithm<? extends PlaceDiscoveryParameters, ?> getAlgorithm(PlaceDiscoveryAlgorithmFactory factory);
 }

src/org/processmining/placebasedlpmdiscovery/prom/placediscovery/parameters/SPECppPlaceDiscoveryParameters.java

@@ -11,7 +11,7 @@
 import org.processmining.specpp.config.presets.PlaceOracleComponentConfig;
 import org.processmining.specpp.config.presets.PlaceOracleParameters;
 
-public class SPECppPlaceDiscoveryParameters extends PlaceDiscoveryParameters {
+public class SPECppPlaceDiscoveryParameters implements PlaceDiscoveryParameters {
     private final SPECppConfigBundle configBundle;
 
     public SPECppPlaceDiscoveryParameters() {