- Adding documentation and renaming from IWindowInfo.java to SlidingWindowInfo

VikiPeeva · VikiPeeva · commit ff0eb10099ff · 2025-09-07T21:53:04.000+02:00
- Adding added and removed elements compared to previous window
- Removed subwindow and build for window without storage from previous window
diff --git a/src/org/processmining/eventlogs/window/EventLogWindowIterator.java b/src/org/processmining/eventlogs/window/EventLogWindowIterator.java
@@ -1,14 +1,14 @@
 package org.processmining.eventlogs.window;
 
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.model.logs.EventLog;
 
 import java.util.Iterator;
 
 /**
  * The classes of this type are used to traverse an event log using a sliding window.
  */
-interface EventLogWindowIterator extends Iterator<IWindowInfo> {
+interface EventLogWindowIterator extends Iterator<SlidingWindowInfo> {
     /**
      * Returns a default window traversal instance.
      * @param eventLog - the event log that should be traversed
diff --git a/src/org/processmining/eventlogs/window/EventLogWindowIteratorImpl.java b/src/org/processmining/eventlogs/window/EventLogWindowIteratorImpl.java
@@ -1,6 +1,6 @@
 package org.processmining.eventlogs.window;
 
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.WindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfoImpl;
 import org.processmining.placebasedlpmdiscovery.model.logs.EventLog;
 import org.processmining.placebasedlpmdiscovery.model.logs.activities.Activity;
 import org.processmining.placebasedlpmdiscovery.model.logs.tracevariants.ActivityBasedTotallyOrderedEventLogTraceVariant;
@@ -44,7 +44,9 @@ public boolean hasNext() {
                 || !this.remainingTraceVariants.isEmpty();
     }
 
-    public WindowInfo next() {
+    public SlidingWindowInfoImpl next() {
+        ArrayList<Activity> addedActivities = new ArrayList<>();
+        ArrayList<Activity> removedActivities = new ArrayList<>();
         boolean startNewVariant = traceVariant == null // hasn't started traversing
                 || position >= traceVariant.size() && window.size() == 1; // finishing a trace variant
         if (startNewVariant) {
@@ -53,15 +55,19 @@ public WindowInfo next() {
 
         // remove first event if no space in the window or at the end of the trace
         if (window.size() >= maxWindowSize || position >= traceVariant.size()) {
-            window.removeFirst();
+            Activity first = window.removeFirst();
+            removedActivities.add(first);
         }
 
         // add next event
         if (position < traceVariant.size()) {
-            window.add(traceVariant.get(position++));
+            window.add(traceVariant.get(position));
+            addedActivities.add(traceVariant.get(position));
+            position++;
         }
 
-        return new WindowInfo(new ArrayList<>(window), windowCount, position - window.size(), position - 1, traceVariant);
+        return new SlidingWindowInfoImpl(new ArrayList<>(window), windowCount,position - window.size(),position - 1
+                , traceVariant, addedActivities, removedActivities);
     }
 
     private void startTraversingNewTraceVariant() {
diff --git a/src/org/processmining/eventlogs/window/WindowBasedEventLog.java b/src/org/processmining/eventlogs/window/WindowBasedEventLog.java
@@ -1,21 +1,21 @@
 package org.processmining.eventlogs.window;
 
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.model.logs.EventLog;
 
 import java.util.Iterator;
 
 /**
  * The window based event log iterates the event log using a sliding window. However, the iteration is made throughout
- * the trace variants and not the traces itself in order to avoid duplication. The {@link IWindowInfo} keeps
+ * the trace variants and not the traces itself in order to avoid duplication. The {@link SlidingWindowInfo} keeps
  * information in how many traces of that variant the window occurs. Additionally, the sliding window assumes there
  * is a padding at the beginning and end of each trace variant so that each element is represented in equal number of
  * windows.
  * <p>
  * Example: Let us assume that the sliding window is of size 3 and the event log has one trace variant [a, b, c, b].
  * The sliding window used for iteration would generate 6 windows: [a], [a, b], [a, b, c], [b, c, b], [c, b], and [b].
  */
-public class WindowBasedEventLog implements Iterable<IWindowInfo> {
+public class WindowBasedEventLog implements Iterable<SlidingWindowInfo> {
     private final EventLog eventLog;
     private final int windowSize;
 
@@ -24,7 +24,7 @@ public WindowBasedEventLog(EventLog eventLog, int windowSize) {
         this.windowSize = windowSize;
     }
     @Override
-    public Iterator<IWindowInfo> iterator() {
+    public Iterator<SlidingWindowInfo> iterator() {
         return EventLogWindowIterator.getInstance(eventLog, windowSize);
     }
 
diff --git a/src/org/processmining/lpms/discovery/builders/LADASingleWindowLPMBuilder.java b/src/org/processmining/lpms/discovery/builders/LADASingleWindowLPMBuilder.java
@@ -1,21 +1,12 @@
 package org.processmining.lpms.discovery.builders;
 
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowLPMStorage;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 
 public class LADASingleWindowLPMBuilder implements SingleWindowLPMBuilder {
 
     @Override
-    public WindowLPMStorage build(IWindowInfo windowInfo) {
-        WindowLPMStorage windowStorage = WindowLPMStorage.lada();
-        for (int i = 1; i < windowInfo.getWindow().size(); ++i) {
-            windowStorage = build(windowInfo.subWindow(0, i), windowStorage);
-        }
-        return windowStorage;
-    }
-
-    @Override
-    public WindowLPMStorage build(IWindowInfo windowInfo, WindowLPMStorage prevWindowResult) {
+    public WindowLPMStorage build(SlidingWindowInfo windowInfo, WindowLPMStorage prevWindowResult) {
 //        Activity newAct = windowInfo.getWindow().get(windowInfo.getWindow().size()-1);
 //        prevWindowResult.extend(newAct);
         return null;
diff --git a/src/org/processmining/lpms/discovery/builders/SingleWindowLPMBuilder.java b/src/org/processmining/lpms/discovery/builders/SingleWindowLPMBuilder.java
@@ -1,7 +1,7 @@
 package org.processmining.lpms.discovery.builders;
 
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowLPMStorage;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 
 /**
  * Builds LPMs for a single window.
@@ -12,18 +12,11 @@ static SingleWindowLPMBuilder getInstance() {
         return new LADASingleWindowLPMBuilder();
     }
 
-    /**
-     * Builds LPMs for a single window independently of the rest.
-     * @param windowInfo - the window info for which we want to build LPMs
-     * @return a window storage that contains LPMs for the provided window
-     */
-    WindowLPMStorage build(IWindowInfo windowInfo);
-
     /**
      * Builds LPMs for a single window, but if possible, reuses overlapping LPMs from the result of the previous window.
      * @param windowInfo - the window info for which we want to build LPMs
      * @param prevWindowResult -  the previous window result to reuse overlapping LPMs
      * @return a window storage that contains LPMs for the provided window
      */
-    WindowLPMStorage build(IWindowInfo windowInfo, WindowLPMStorage prevWindowResult);
+    WindowLPMStorage build(SlidingWindowInfo windowInfo, WindowLPMStorage prevWindowResult);
 }
diff --git a/src/org/processmining/lpms/discovery/lada/LADA.java b/src/org/processmining/lpms/discovery/lada/LADA.java
@@ -7,7 +7,7 @@
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowLPMStorage;
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowToGlobalLPMStorageTransporter;
 import org.processmining.placebasedlpmdiscovery.lpmdiscovery.LPMDiscovery;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.model.discovery.LPMDiscoveryResult;
 import org.processmining.placebasedlpmdiscovery.model.discovery.StandardLPMDiscoveryResult;
 import org.processmining.placebasedlpmdiscovery.model.logs.EventLog;
@@ -37,7 +37,7 @@ public LPMDiscoveryResult from(XLog log) {
         WindowBasedEventLog windowBasedEventLog = WindowBasedEventLog.getInstance(eventLog, this.proximity);
         WindowLPMStorage windowStorage = null;
         SingleWindowLPMBuilder singleWindowLPMBuilder = SingleWindowLPMBuilder.getInstance();
-        for (IWindowInfo windowInfo : windowBasedEventLog) {
+        for (SlidingWindowInfo windowInfo : windowBasedEventLog) {
             windowStorage = singleWindowLPMBuilder.build(windowInfo, windowStorage);
             storageTransporter.move(windowStorage, lpmStorage);
         }
diff --git a/src/org/processmining/placebasedlpmdiscovery/lpmbuilding/algorithms/fpgrowth/placecombination/FPGrowthForPlacesLPMBuildingAlg.java b/src/org/processmining/placebasedlpmdiscovery/lpmbuilding/algorithms/fpgrowth/placecombination/FPGrowthForPlacesLPMBuildingAlg.java
@@ -15,7 +15,7 @@
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.results.LPMBuildingResult;
 import org.processmining.placebasedlpmdiscovery.lpmdiscovery.combination.LPMCombinationParameters;
 import org.processmining.placebasedlpmdiscovery.lpmevaluation.LPMEvaluationController;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.enhanced.IntegerMappedLog;
 import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.enhanced.extra.AbstractActivityMapping;
 import org.processmining.placebasedlpmdiscovery.lpmevaluation.results.helpers.WindowTotalCounter;
@@ -90,7 +90,7 @@ private MainFPGrowthLPMTree build(EventLog log, Set<Place> places, LPMCombinatio
         int maxWindowSize = parameters.getLpmProximity(); // max window size
         WindowBasedEventLog windowBasedEventLog = WindowBasedEventLog.getInstance(log, maxWindowSize);
         WindowLPMTree localTree = new WindowLPMTree(maxWindowSize); // window tree
-        for (IWindowInfo windowInfo : windowBasedEventLog) {
+        for (SlidingWindowInfo windowInfo : windowBasedEventLog) {
             windowTotalCounter.update(windowInfo.getIntWindow(), windowInfo.getWindowCount()); // update window counter
 
             if (windowInfo.getStartPos() == 0 && windowInfo.getEndPos() == 0) { // new trace variant new WindowLPMTree
diff --git a/src/org/processmining/placebasedlpmdiscovery/lpmbuilding/algorithms/windowbased/WindowBasedLPMBuildingAlg.java b/src/org/processmining/placebasedlpmdiscovery/lpmbuilding/algorithms/windowbased/WindowBasedLPMBuildingAlg.java
@@ -11,7 +11,7 @@
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.results.LPMBuildingResult;
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowLPMStorage;
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowToGlobalLPMStorageTransporter;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.model.lpmstorage.GlobalLPMStorage;
 
 public class WindowBasedLPMBuildingAlg implements LPMBuildingAlg {
@@ -47,7 +47,7 @@ private LPMBuildingResult build(WindowBasedLPMBuildingInput input, WindowBasedLP
         WindowBasedEventLog windowBasedEventLog = WindowBasedEventLog
                 .getInstance(input.getEventLog(), parameters.getWindowSize());
         WindowLPMStorage windowStorage = null;
-        for (IWindowInfo windowInfo : windowBasedEventLog) {
+        for (SlidingWindowInfo windowInfo : windowBasedEventLog) {
             windowStorage = singleWindowLPMBuilder.build(windowInfo, windowStorage);
             storageTransporter.move(windowStorage, lpmStorage);
         }
diff --git a/src/org/processmining/placebasedlpmdiscovery/lpmbuilding/algorithms/windowbased/singlewindowbuilders/PTSingleWindowLPMBuilder.java b/src/org/processmining/placebasedlpmdiscovery/lpmbuilding/algorithms/windowbased/singlewindowbuilders/PTSingleWindowLPMBuilder.java
@@ -2,17 +2,13 @@
 
 import org.processmining.lpms.discovery.builders.SingleWindowLPMBuilder;
 import org.processmining.placebasedlpmdiscovery.lpmbuilding.storage.WindowLPMStorage;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.model.lpmmodels.processtree.ProcessTree;
 
 public class PTSingleWindowLPMBuilder implements SingleWindowLPMBuilder {
-    @Override
-    public WindowLPMStorage build(IWindowInfo windowInfo) {
-        return null;
-    }
 
     @Override
-    public WindowLPMStorage build(IWindowInfo windowInfo, WindowLPMStorage prevWindowResult) {
+    public WindowLPMStorage build(SlidingWindowInfo windowInfo, WindowLPMStorage prevWindowResult) {
 
         ProcessTree pt = new ProcessTree(windowInfo.getWindow().get(windowInfo.getEndPos()));
         return null;
diff --git a/src/org/processmining/placebasedlpmdiscovery/lpmevaluation/logs/SlidingWindowInfo.java b/src/org/processmining/placebasedlpmdiscovery/lpmevaluation/logs/SlidingWindowInfo.java
@@ -5,10 +5,24 @@
 
 import java.util.List;
 
-public interface IWindowInfo {
+/**
+ * There are three different ways in which a current sliding window differs from the previous.
+ * (1) Only adding an element: [a] -> [a b], [a b] -> [a b c]; This occurs when the sliding window capacity is not
+ * completely filled, i.e., at the beginning of a sequence. To see which activities have been added use
+ * {@link #getAddedActivities()}.
+ * (2) Removing and adding an element: [a b c] ->  [b c b]; This occurs when the sliding window capacity is filled, so
+ * first an element has to be removed and then added.
+ * (3) Only removing an element: [b c b] -> [c b], [c b] -> [b]; This occurs when the sliding window is at the end of
+ * a sequence. To see which activities have been removed use {@link #getRemovedActivities()}.
+ */
+public interface SlidingWindowInfo {
 
     List<Activity> getWindow();
 
+    List<Activity> getAddedActivities();
+
+    List<Activity> getRemovedActivities();
+
     /**
      * Returns the start position of the window in the trace (inclusive)
      * @return startPos - the start position of the window in the trace
@@ -34,14 +48,4 @@ public interface IWindowInfo {
     List<Integer> getIntWindow();
 
     ActivityBasedTotallyOrderedEventLogTraceVariant getParentTraceVariant();
-
-    /**
-     * Creates a new window that is a subwindow of the current one and returns it.
-     * @param fromIndex low endpoint (inclusive) of the subwindow
-     * @param toIndex high endpoint (exclusive) of the subwindow
-     * @return a new instance of {@link IWindowInfo}
-     * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > size)
-     * @throws IllegalArgumentException for fromIndex > toIndex
-     */
-    IWindowInfo subWindow(int fromIndex, int toIndex);
 }
diff --git a/src/org/processmining/placebasedlpmdiscovery/lpmevaluation/logs/SlidingWindowInfoImpl.java b/src/org/processmining/placebasedlpmdiscovery/lpmevaluation/logs/SlidingWindowInfoImpl.java
@@ -9,25 +9,41 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
-public class WindowInfo implements IWindowInfo {
+public class SlidingWindowInfoImpl implements SlidingWindowInfo {
     private final ArrayList<Activity> window;
     private final int windowCount;
     private final int startPos; // inclusive
     private final int endPos; // inclusive
     private final ActivityBasedTotallyOrderedEventLogTraceVariant traceVariant;
+    private final ArrayList<Activity> addedActivities;
+    private final ArrayList<Activity> removedActivities;
 
-    public WindowInfo(ArrayList<Activity> window, int windowCount, int startPos, int endPos, ActivityBasedTotallyOrderedEventLogTraceVariant traceVariant) {
+    public SlidingWindowInfoImpl(ArrayList<Activity> window, int windowCount, int startPos, int endPos,
+                                 ActivityBasedTotallyOrderedEventLogTraceVariant traceVariant,
+                                 ArrayList<Activity> addedActivities, ArrayList<Activity> removedActivities) {
         this.window = window;
         this.windowCount = windowCount;
         this.startPos = startPos;
         this.endPos = endPos;
         this.traceVariant = traceVariant;
+        this.addedActivities = addedActivities;
+        this.removedActivities = removedActivities;
     }
 
     public List<Activity> getWindow() {
         return this.window;
     }
 
+    @Override
+    public List<Activity> getAddedActivities() {
+        return this.addedActivities;
+    }
+
+    @Override
+    public List<Activity> getRemovedActivities() {
+        return this.removedActivities;
+    }
+
     /**
      * Returns the start position of the window in the trace
      * @return startPos - the start position of the window in the trace
@@ -57,7 +73,7 @@ public int getWindowCount() {
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
-        WindowInfo that = (WindowInfo) o;
+        SlidingWindowInfoImpl that = (SlidingWindowInfoImpl) o;
         return windowCount == that.windowCount && startPos == that.startPos && endPos == that.endPos && Objects.equals(window, that.window);
     }
 
@@ -85,17 +101,4 @@ public List<Integer> getIntWindow() {
     public ActivityBasedTotallyOrderedEventLogTraceVariant getParentTraceVariant() {
         return this.traceVariant;
     }
-
-    @Override
-    public IWindowInfo subWindow(int fromIndex, int toIndex) {
-        if (fromIndex > toIndex) {
-            throw new IllegalArgumentException("fromIndex > toIndex");
-        } else if (fromIndex < 0) {
-            throw new IllegalArgumentException("fromIndex < 0");
-        } else if (toIndex > window.size()) {
-            throw new IllegalArgumentException("toIndex > window.size()");
-        }
-        return new WindowInfo(new ArrayList<>(this.window.subList(fromIndex, toIndex)), this.windowCount,
-                this.startPos + fromIndex, this.startPos + toIndex - 1, this.traceVariant);
-    }
 }
diff --git a/src/org/processmining/placebasedlpmdiscovery/model/fpgrowth/LPMTemporaryWindowInfoCreator.java b/src/org/processmining/placebasedlpmdiscovery/model/fpgrowth/LPMTemporaryWindowInfoCreator.java
@@ -2,7 +2,7 @@
 
 import org.apache.commons.math3.util.Pair;
 import org.deckfour.xes.model.XTrace;
-import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.IWindowInfo;
+import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.SlidingWindowInfo;
 import org.processmining.placebasedlpmdiscovery.lpmevaluation.logs.enhanced.IntegerMappedLog;
 import org.processmining.placebasedlpmdiscovery.model.SimplePlace;
 import org.processmining.placebasedlpmdiscovery.model.logs.activities.Activity;
@@ -19,10 +19,10 @@
 public class LPMTemporaryWindowInfoCreator {
 
     private final IntegerMappedLog log;
-    private final IWindowInfo windowInfo;
+    private final SlidingWindowInfo windowInfo;
     private final ActivityBasedTotallyOrderedEventLogTraceVariant parentSequence;
 
-    public LPMTemporaryWindowInfoCreator(IWindowInfo windowInfo, IntegerMappedLog log,
+    public LPMTemporaryWindowInfoCreator(SlidingWindowInfo windowInfo, IntegerMappedLog log,
                                          ActivityBasedTotallyOrderedEventLogTraceVariant parentSequence) {
         this.windowInfo = windowInfo;
         this.log = log;
diff --git a/tests/src/org/processmining/placebasedlpmdiscovery/lpmevaluation/logs/WindowLogTraversalTest.java b/tests/src/org/processmining/placebasedlpmdiscovery/lpmevaluation/logs/WindowLogTraversalTest.java
