restructuring parts of the code

Author: johanneshiry

src/main/java/edu/ie3/netpad/grid/controller/GridController.java

@@ -14,14 +14,12 @@
 import edu.ie3.datamodel.models.input.connector.Transformer2WInput;
 import edu.ie3.datamodel.models.input.container.GridContainer;
 import edu.ie3.datamodel.models.input.container.JointGridContainer;
-import edu.ie3.datamodel.models.input.container.RawGridElements;
 import edu.ie3.datamodel.models.input.container.SubGridContainer;
 import edu.ie3.datamodel.models.input.system.LoadInput;
 import edu.ie3.datamodel.models.input.system.PvInput;
 import edu.ie3.datamodel.models.input.system.StorageInput;
 import edu.ie3.datamodel.models.input.system.SystemParticipantInput;
 import edu.ie3.datamodel.utils.ContainerUtils;
-import edu.ie3.datamodel.utils.GridAndGeoUtils;
 import edu.ie3.netpad.grid.GridModel;
 import edu.ie3.netpad.grid.GridModification;
 import edu.ie3.netpad.grid.ModifiedSubGridData;
@@ -31,26 +29,21 @@
 import edu.ie3.netpad.io.event.ReadGridEvent;
 import edu.ie3.netpad.io.event.SaveGridEvent;
 import edu.ie3.netpad.map.event.MapEvent;
-import edu.ie3.netpad.tool.LineLengthResolutionMode;
 import edu.ie3.netpad.tool.controller.ToolController;
-import edu.ie3.netpad.tool.controller.ToolDialogs;
 import edu.ie3.netpad.tool.event.FixLineLengthRequestEvent;
 import edu.ie3.netpad.tool.event.LayoutGridRequestEvent;
 import edu.ie3.netpad.tool.event.LayoutGridResponse;
 import edu.ie3.netpad.tool.event.ToolEvent;
-import edu.ie3.util.geo.GeoUtils;
+import edu.ie3.netpad.tool.grid.LineLengthFixer;
+import edu.ie3.netpad.tool.grid.LineLengthResolutionMode;
 import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.beans.value.ChangeListener;
-import javax.measure.quantity.Length;
-import org.locationtech.jts.geom.Coordinate;
-import org.locationtech.jts.geom.LineString;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import tech.units.indriya.ComparableQuantity;
 
 /**
  * //ToDo: Class Description
@@ -221,7 +214,8 @@ private ChangeListener<ToolEvent> toolEventListener() {
         FixLineLengthRequestEvent event = (FixLineLengthRequestEvent) newValue;
         LineLengthResolutionMode resolutionMode = event.getResolutionMode();
         Set<Integer> selectedSubnets = event.getSelectedSubnets();
-        fixLineLength(resolutionMode, selectedSubnets);
+        LineLengthFixer.execute(resolutionMode, selectedSubnets, subGrids)
+            .ifPresent(this::handleReadGridEvent);
       } else {
         throw new RuntimeException("Invalid GridContainer provided!");
       }
@@ -231,131 +225,6 @@ private ChangeListener<ToolEvent> toolEventListener() {
     };
   }
 
-  /**
-   * Fix the line length discrepancy based on the user given {@link ToolDialogs.FixLineLengthData}
-   *
-   * @param resolutionMode Selected resolution mode
-   * @param selectedSubnets Subnets to apply adjustments to
-   */
-  public void fixLineLength(LineLengthResolutionMode resolutionMode, Set<Integer> selectedSubnets) {
-    JointGridContainer updatedGrid;
-
-    /* Act depending on the chosen resolution mode */
-    switch (resolutionMode) {
-      case GEOGRAPHICAL:
-        updatedGrid = setElectricalToGeographicalLineLength(selectedSubnets);
-        break;
-      case ELECTRICAL:
-        /* TODO CK: Figure out, what to do here */
-      default:
-        log.error("Unknown resolution mode '{}'", resolutionMode);
-        return;
-    }
-
-    /* Build a new event and inform the listeners about the "new" / adapted grid model */
-    handleReadGridEvent(new ReadGridEvent(updatedGrid));
-  }
-
-  /**
-   * Sets the electrical length of all lines within the selected sub nets to the length of their
-   * geographical line string if apparent. If not, it is set to the geographical distance between
-   * start and end node.
-   *
-   * @param selectedSubnets Subnets to apply adjustments to
-   * @return A {@link JointGridContainer} with updated line models
-   */
-  private JointGridContainer setElectricalToGeographicalLineLength(Set<Integer> selectedSubnets) {
-    /* Adjust the electrical line length to be the same as the geographical distance */
-    List<SubGridContainer> subGridContainers =
-        subGrids.values().parallelStream()
-            .map(GridModel::getSubGridContainer)
-            .map(
-                subGridContainer -> {
-                  if (!selectedSubnets.contains(subGridContainer.getSubnet())) {
-                    /* If this grid isn't selected, hand it back, as it is */
-                    return subGridContainer;
-                  } else {
-                    /* Update all lines */
-                    Set<LineInput> lines =
-                        subGridContainer.getRawGrid().getLines().parallelStream()
-                            .map(GridController::setLineLengthToGeographicDistance)
-                            .collect(Collectors.toSet());
-
-                    /* Put together, what has been there before */
-                    RawGridElements rawGrid =
-                        new RawGridElements(
-                            subGridContainer.getRawGrid().getNodes(),
-                            lines,
-                            subGridContainer.getRawGrid().getTransformer2Ws(),
-                            subGridContainer.getRawGrid().getTransformer3Ws(),
-                            subGridContainer.getRawGrid().getSwitches(),
-                            subGridContainer.getRawGrid().getMeasurementUnits());
-                    return new SubGridContainer(
-                        subGridContainer.getGridName(),
-                        subGridContainer.getSubnet(),
-                        rawGrid,
-                        subGridContainer.getSystemParticipants(),
-                        subGridContainer.getGraphics());
-                  }
-                })
-            .collect(Collectors.toList());
-
-    /* Assemble all sub grids to one container */
-    return ContainerUtils.combineToJointGrid(subGridContainers);
-  }
-
-  /**
-   * Adjusts the line length to the length of their geographical line string if apparent. If not, it
-   * is set to the geographical distance between start and end node.
-   *
-   * @param line line model to adjust
-   * @return The adjusted line model
-   * @deprecated This method should be transferred to PowerSystemDataModel
-   */
-  @Deprecated
-  private static LineInput setLineLengthToGeographicDistance(LineInput line) {
-    ComparableQuantity<Length> lineLength;
-    lineLength =
-        lengthOfLineString(line.getGeoPosition())
-            .orElseGet(
-                () -> {
-                  log.warn(
-                      "Cannot determine the length of the line string of line '{}' as it only contains one coordinate."
-                          + " Take distance between it's nodes instead.",
-                      line);
-                  return GridAndGeoUtils.distanceBetweenNodes(line.getNodeA(), line.getNodeB());
-                });
-    return line.copy().length(lineLength).build();
-  }
-
-  /**
-   * Calculate the length of a line string
-   *
-   * @param lineString The line string to calculate the length of
-   * @return An option to the length, if it can be determined
-   * @deprecated This method should be transferred to PowerSystemUtils
-   */
-  @Deprecated
-  private static Optional<ComparableQuantity<Length>> lengthOfLineString(LineString lineString) {
-    Coordinate[] coordinates = lineString.getCoordinates();
-
-    if (coordinates.length == 1) {
-      return Optional.empty();
-    }
-
-    /* Go over the line piecewise and sum up the distance */
-    Coordinate a = coordinates[0];
-    Coordinate b = coordinates[1];
-    ComparableQuantity<Length> length = GeoUtils.calcHaversine(a.x, a.y, b.x, b.y);
-    for (int coordIndex = 2; coordIndex < coordinates.length; coordIndex++) {
-      a = b;
-      b = coordinates[coordIndex];
-      length = length.add(GeoUtils.calcHaversine(a.x, a.y, b.x, b.y));
-    }
-
-    return Optional.of(length);
-  }
-
   private ChangeListener<IOEvent> ioEventListener() {
     return (observable, oldValue, newValue) -> {
       if (newValue instanceof ReadGridEvent) {

src/main/java/edu/ie3/netpad/tool/controller/ToolDialogs.java

@@ -5,19 +5,18 @@
 */
 package edu.ie3.netpad.tool.controller;
 
-import static edu.ie3.netpad.tool.LineLengthResolutionMode.ELECTRICAL;
-import static edu.ie3.netpad.tool.LineLengthResolutionMode.GEOGRAPHICAL;
+import static edu.ie3.netpad.tool.grid.LineLengthResolutionMode.ELECTRICAL;
+import static edu.ie3.netpad.tool.grid.LineLengthResolutionMode.GEOGRAPHICAL;
 import static javafx.scene.control.CheckBoxTreeItem.checkBoxSelectionChangedEvent;
 
 import edu.ie3.datamodel.models.input.container.SubGridContainer;
 import edu.ie3.datamodel.models.voltagelevels.VoltageLevel;
 import edu.ie3.netpad.exception.NetPadPlusPlusException;
 import edu.ie3.netpad.grid.controller.GridController;
-import edu.ie3.netpad.tool.LineLengthResolutionMode;
+import edu.ie3.netpad.tool.grid.LineLengthResolutionMode;
 import java.util.*;
 import java.util.stream.Collectors;
 import javafx.beans.binding.Bindings;
-import javafx.event.EventHandler;
 import javafx.geometry.Insets;
 import javafx.scene.control.*;
 import javafx.scene.layout.GridPane;
@@ -153,20 +152,19 @@ private static Collection<CheckBoxTreeItem<String>> buildTreeItems(
               new CheckBoxTreeItem<>(Integer.toString(subGrid.getSubnet()));
           checkBoxTreeItem.addEventHandler(
               checkBoxSelectionChangedEvent(),
-              (EventHandler<CheckBoxTreeItem.TreeModificationEvent<String>>)
-                  event -> {
-                    CheckBoxTreeItem<String> chk = event.getTreeItem();
-                    try {
-                      int subnetNumber = Integer.parseInt(chk.getValue());
-                      if (chk.isSelected()) {
-                        selectedSubnets.add(subnetNumber);
-                      } else {
-                        selectedSubnets.remove(subnetNumber);
-                      }
-                    } catch (NumberFormatException nfe) {
-                      logger.error("Unable to parse '{}' to integer.", chk.getValue());
-                    }
-                  });
+              event -> {
+                CheckBoxTreeItem<Object> chk = event.getTreeItem();
+                try {
+                  int subnetNumber = Integer.parseInt((String) chk.getValue());
+                  if (chk.isSelected()) {
+                    selectedSubnets.add(subnetNumber);
+                  } else {
+                    selectedSubnets.remove(subnetNumber);
+                  }
+                } catch (NumberFormatException nfe) {
+                  logger.error("Unable to parse '{}' to integer.", chk.getValue());
+                }
+              });
           checkBoxTreeItem.setSelected(true);
 
           voltageLvlChkBox.getChildren().add(checkBoxTreeItem);

src/main/java/edu/ie3/netpad/tool/event/FixLineLengthRequestEvent.java

@@ -5,7 +5,7 @@
 */
 package edu.ie3.netpad.tool.event;
 
-import edu.ie3.netpad.tool.LineLengthResolutionMode;
+import edu.ie3.netpad.tool.grid.LineLengthResolutionMode;
 import java.util.Objects;
 import java.util.Set;