Merge pull request #192 from ie3-institute/ck/improveCodeQuality

Improve code quality

Author: ckittl

src/main/java/edu/ie3/datamodel/io/factory/EntityFactory.java

@@ -25,7 +25,7 @@
  * @since 28.01.20
  */
 public abstract class EntityFactory<T extends UniqueEntity, D extends EntityData> {
-  public final Logger log = LogManager.getLogger(this.getClass());
+  public static final Logger log = LogManager.getLogger(EntityFactory.class);
 
   protected final List<Class<? extends T>> classes;
 

src/main/java/edu/ie3/datamodel/io/factory/input/LineInputFactory.java

@@ -49,7 +49,7 @@ protected LineInput buildModel(
     final ComparableQuantity<Length> length = data.getQuantity(LENGTH, StandardUnits.LINE_LENGTH);
     final LineString geoPosition =
         data.getLineString(GEO_POSITION)
-            .orElse(GridAndGeoUtils.buildLineStringBetweenNodes(nodeA, nodeB));
+            .orElse(GridAndGeoUtils.buildSafeLineStringBetweenNodes(nodeA, nodeB));
     final OlmCharacteristicInput olmCharacteristic;
     try {
       olmCharacteristic =

src/main/java/edu/ie3/datamodel/io/factory/input/ThermalUnitInputEntityData.java

@@ -9,6 +9,7 @@
 import edu.ie3.datamodel.models.input.OperatorInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import java.util.Map;
+import java.util.Objects;
 
 public class ThermalUnitInputEntityData extends AssetInputEntityData {
   private final ThermalBusInput busInput;
@@ -33,4 +34,18 @@ public ThermalUnitInputEntityData(
   public ThermalBusInput getBusInput() {
     return busInput;
   }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof ThermalUnitInputEntityData)) return false;
+    if (!super.equals(o)) return false;
+    ThermalUnitInputEntityData that = (ThermalUnitInputEntityData) o;
+    return busInput.equals(that.busInput);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), busInput);
+  }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/participant/ChpInputEntityData.java

@@ -12,6 +12,7 @@
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalStorageInput;
 import java.util.Map;
+import java.util.Objects;
 
 public class ChpInputEntityData extends SystemParticipantTypedEntityData<ChpTypeInput> {
   private final ThermalBusInput thermalBusInput;
@@ -47,4 +48,19 @@ public ThermalBusInput getThermalBusInput() {
   public ThermalStorageInput getThermalStorageInput() {
     return thermalStorageInput;
   }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof ChpInputEntityData)) return false;
+    if (!super.equals(o)) return false;
+    ChpInputEntityData that = (ChpInputEntityData) o;
+    return thermalBusInput.equals(that.thermalBusInput)
+        && thermalStorageInput.equals(that.thermalStorageInput);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), thermalBusInput, thermalStorageInput);
+  }
 }

src/main/java/edu/ie3/datamodel/io/processor/EntityProcessor.java

@@ -6,9 +6,13 @@
 package edu.ie3.datamodel.io.processor;
 
 import edu.ie3.datamodel.exceptions.EntityProcessorException;
+import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.UniqueEntity;
 import java.lang.reflect.Method;
 import java.util.*;
+import javax.measure.Quantity;
+import javax.measure.quantity.Energy;
+import javax.measure.quantity.Power;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -22,7 +26,7 @@
  */
 public abstract class EntityProcessor<T extends UniqueEntity> extends Processor<T> {
 
-  public final Logger log = LogManager.getLogger(this.getClass());
+  public static final Logger log = LogManager.getLogger(EntityProcessor.class);
   protected final String[] headerElements;
   private final SortedMap<String, Method> fieldNameToMethod;
 
@@ -66,6 +70,40 @@ public Optional<LinkedHashMap<String, String>> handleEntity(T entity) {
     }
   }
 
+  @Override
+  protected Optional<String> handleProcessorSpecificQuantity(
+      Quantity<?> quantity, String fieldName) {
+    Optional<String> normalizedQuantityValue = Optional.empty();
+    switch (fieldName) {
+      case "energy":
+      case "eConsAnnual":
+      case "eStorage":
+        normalizedQuantityValue =
+            quantityValToOptionalString(quantity.asType(Energy.class).to(StandardUnits.ENERGY_IN));
+        break;
+      case "q":
+        normalizedQuantityValue =
+            quantityValToOptionalString(
+                quantity.asType(Power.class).to(StandardUnits.REACTIVE_POWER_IN));
+        break;
+      case "p":
+      case "pMax":
+      case "pOwn":
+      case "pThermal":
+        normalizedQuantityValue =
+            quantityValToOptionalString(
+                quantity.asType(Power.class).to(StandardUnits.ACTIVE_POWER_IN));
+        break;
+      default:
+        log.error(
+            "Cannot process quantity with value '{}' for field with name {} in input entity processing!",
+            quantity,
+            fieldName);
+        break;
+    }
+    return normalizedQuantityValue;
+  }
+
   @Override
   public String[] getHeaderElements() {
     return headerElements;

src/main/java/edu/ie3/datamodel/io/processor/input/InputEntityProcessor.java

@@ -6,7 +6,6 @@
 package edu.ie3.datamodel.io.processor.input;
 
 import edu.ie3.datamodel.io.processor.EntityProcessor;
-import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.input.*;
 import edu.ie3.datamodel.models.input.connector.*;
 import edu.ie3.datamodel.models.input.connector.type.LineTypeInput;
@@ -22,8 +21,6 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
-import java.util.Optional;
-import javax.measure.Quantity;
 import javax.measure.quantity.*;
 
 /**
@@ -81,40 +78,6 @@ public InputEntityProcessor(Class<? extends InputEntity> registeredClass) {
     super(registeredClass);
   }
 
-  @Override
-  protected Optional<String> handleProcessorSpecificQuantity(
-      Quantity<?> quantity, String fieldName) {
-    Optional<String> normalizedQuantityValue = Optional.empty();
-    switch (fieldName) {
-      case "energy":
-      case "eConsAnnual":
-      case "eStorage":
-        normalizedQuantityValue =
-            quantityValToOptionalString(quantity.asType(Energy.class).to(StandardUnits.ENERGY_IN));
-        break;
-      case "q":
-        normalizedQuantityValue =
-            quantityValToOptionalString(
-                quantity.asType(Power.class).to(StandardUnits.REACTIVE_POWER_IN));
-        break;
-      case "p":
-      case "pMax":
-      case "pOwn":
-      case "pThermal":
-        normalizedQuantityValue =
-            quantityValToOptionalString(
-                quantity.asType(Power.class).to(StandardUnits.ACTIVE_POWER_IN));
-        break;
-      default:
-        log.error(
-            "Cannot process quantity with value '{}' for field with name {} in input entity processing!",
-            quantity,
-            fieldName);
-        break;
-    }
-    return normalizedQuantityValue;
-  }
-
   @Override
   protected List<Class<? extends InputEntity>> getEligibleEntityClasses() {
     return eligibleEntityClasses;

src/main/java/edu/ie3/datamodel/io/processor/timeseries/TimeSeriesProcessor.java

@@ -9,7 +9,6 @@
 
 import edu.ie3.datamodel.exceptions.EntityProcessorException;
 import edu.ie3.datamodel.io.processor.EntityProcessor;
-import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.timeseries.TimeSeries;
 import edu.ie3.datamodel.models.timeseries.TimeSeriesEntry;
 import edu.ie3.datamodel.models.timeseries.individual.IndividualTimeSeries;
@@ -21,9 +20,6 @@
 import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import javax.measure.Quantity;
-import javax.measure.quantity.Energy;
-import javax.measure.quantity.Power;
 
 public class TimeSeriesProcessor<
         T extends TimeSeries<E, V>, E extends TimeSeriesEntry<V>, V extends Value>
@@ -269,40 +265,6 @@ private Map<String, Method> extractFieldToMethod(FieldSourceToMethod.FieldSource
         .collect(Collectors.toMap(Map.Entry::getKey, entry -> entry.getValue().getMethod()));
   }
 
-  @Override
-  protected Optional<String> handleProcessorSpecificQuantity(
-      Quantity<?> quantity, String fieldName) {
-    Optional<String> normalizedQuantityValue = Optional.empty();
-    switch (fieldName) {
-      case "energy":
-      case "eConsAnnual":
-      case "eStorage":
-        normalizedQuantityValue =
-            quantityValToOptionalString(quantity.asType(Energy.class).to(StandardUnits.ENERGY_IN));
-        break;
-      case "q":
-        normalizedQuantityValue =
-            quantityValToOptionalString(
-                quantity.asType(Power.class).to(StandardUnits.REACTIVE_POWER_IN));
-        break;
-      case "p":
-      case "pMax":
-      case "pOwn":
-      case "pThermal":
-        normalizedQuantityValue =
-            quantityValToOptionalString(
-                quantity.asType(Power.class).to(StandardUnits.ACTIVE_POWER_IN));
-        break;
-      default:
-        log.error(
-            "Cannot process quantity with value '{}' for field with name {} in input entity processing!",
-            quantity,
-            fieldName);
-        break;
-    }
-    return normalizedQuantityValue;
-  }
-
   @Override
   public String[] getHeaderElements() {
     return flattenedHeaderElements;