Merge branch 'dev' into ms/#642-find-and-add-standard-asset-types

Author: sebastian-peter

CHANGELOG.md

@@ -86,6 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Writers used to write time series are closed right away
 - Changed class name in FlexOptionsResult.toString [#693](https://github.com/ie3-institute/PowerSystemDataModel/issues/693)
+- Deleted parameter decimalPlaces and changed naming of serialization method [#710](https://github.com/ie3-institute/PowerSystemDataModel/issues/710)
 
 ## [2.0.1] - 2021-07-08
 

docs/readthedocs/io/csvfiles.rst

@@ -194,7 +194,7 @@ However, note that this hierarchy is only meant to be used in conjunction with i
 The class :code:`DefaultInputHierarchy` offers some helpful methods to validate and create a default input file
 hierarchy.
 
-De-Serialization (loading models)
+De-serialization (loading models)
 =================================
 Having an instance of :ref:`Grid Container<grid_container_model>` is most of the time the target whenever you load your
 grid. It consists of the three main blocks:

docs/uml/main/input/CharacteristicDatamodelConcept.puml

@@ -33,7 +33,7 @@ package models {
                     + {static} REQUIRED_FORMAT: String
                     - x: ComparableQuantity<A>
                     - y: ComparableQuantity<O>
-                    + deSerialize(int): String
+                    + serialize(): String
                     - {static} buildExceptionMessage(String): String
                     - {static} buildExceptionMessage(String, String): String
                 }
@@ -43,7 +43,7 @@ package models {
                     # characteristicPrefix: String
                     # decimalPlaces: int
                     # points: SortedSet<CharacteristicPoint<A,O>>
-                    + deSerialize(): String
+                    + serialize(): String
                     + {static} buildStartingRegex(String): String
                     - extractCoordinateList(String): String
                     - buildCoordinatesFromString(String, Unit<A>, Unit<O>): SortedSet<CharacteristicPoint<A, O>>

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java

@@ -333,7 +333,7 @@ CsvFileDefinition buildFileDefinition(T timeSeries, String[] headLineElements, S
   /**
    * Builds a new file definition consisting of file name and head line elements
    *
-   * @param clz Class that is meant to be de-serialized into this file
+   * @param clz Class that is meant to be serialized into this file
    * @param headLineElements Array of head line elements
    * @param csvSep Separator for csv columns
    * @return A suitable file definition

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

@@ -17,7 +17,7 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * Internal API Interface for EntityProcessors. Main purpose is to 'de-serialize' models into a
+ * Internal API Interface for EntityProcessors. Main purpose is to 'serialize' models into a
  * fieldName to value representation to allow for an easy processing into a database or file sink
  * e.g. .csv
  *
@@ -47,7 +47,7 @@ protected EntityProcessor(Class<? extends T> registeredClass) {
   /**
    * Standard call to handle an entity
    *
-   * @param entity the entity that should be 'de-serialized' into a map of fieldName to fieldValue
+   * @param entity the entity that should be 'serialized' into a map of fieldName to fieldValue
    * @return an optional Map with fieldName to fieldValue or an empty optional if an error occurred
    *     during processing
    */

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

@@ -279,7 +279,7 @@ protected String processMethodResult(Object methodReturnObject, Method method, S
           "QV",
           "ReactivePowerCharacteristic",
           "CharacteristicInput" -> resultStringBuilder.append(
-          ((CharacteristicInput<?, ?>) methodReturnObject).deSerialize());
+          ((CharacteristicInput<?, ?>) methodReturnObject).serialize());
       case "UUID[]" -> resultStringBuilder.append(processUUIDArray((UUID[]) methodReturnObject));
       case "ControlStrategy" -> resultStringBuilder.append(
           ((ControlStrategy) methodReturnObject).getKey());

src/main/java/edu/ie3/datamodel/io/processor/result/ResultEntityProcessor.java

@@ -23,8 +23,8 @@
 import javax.measure.quantity.Power;
 
 /**
- * 'De-serializer' for {@link ResultEntity}s into a fieldName to value representation to allow for
- * an easy processing into a database or file sink e.g. .csv It is important that the units used in
+ * 'Serializer' for {@link ResultEntity}s into a fieldName to value representation to allow for an
+ * easy processing into a database or file sink e.g. .csv It is important that the units used in
  * this class are equal to the units used {@link SystemParticipantResultFactory} to prevent invalid
  * interpretation of unit prefixes!
  *

src/main/java/edu/ie3/datamodel/io/sink/CsvFileSink.java

@@ -92,7 +92,7 @@ public CsvFileSink(
    * ProcessorProvider} by calling {@link ProcessorProvider#ProcessorProvider()}
    *
    * @param baseFolderPath the base folder path where the files should be put into
-   * @param processorProvider the processor provided that should be used for entity de-serialization
+   * @param processorProvider the processor provided that should be used for entity serialization
    * @param fileNamingStrategy the data sink file naming strategy that should be used
    * @param initFiles true if the files should be created during initialization (might create files,
    *     that only consist of a headline, because no data will be written into them), false

src/main/java/edu/ie3/datamodel/models/input/system/characteristic/CharacteristicInput.java

@@ -21,7 +21,6 @@
 public abstract class CharacteristicInput<A extends Quantity<A>, O extends Quantity<O>>
     implements Serializable {
   protected final String characteristicPrefix;
-  protected final int decimalPlaces;
 
   private final SortedSet<CharacteristicPoint<A, O>> points;
 
@@ -30,24 +29,17 @@ public abstract class CharacteristicInput<A extends Quantity<A>, O extends Quant
    *
    * @param points Set of points that describe the characteristic
    * @param characteristicPrefix Prefix, that prepends the actual characteristic
-   * @param decimalPlaces Desired amount of decimal places when de-serializing the characteristic
    */
   protected CharacteristicInput(
-      SortedSet<CharacteristicPoint<A, O>> points, String characteristicPrefix, int decimalPlaces) {
+      SortedSet<CharacteristicPoint<A, O>> points, String characteristicPrefix) {
     this.points = Collections.unmodifiableSortedSet(points);
     this.characteristicPrefix = characteristicPrefix;
-    this.decimalPlaces = decimalPlaces;
   }
 
   protected CharacteristicInput(
-      String input,
-      Unit<A> abscissaUnit,
-      Unit<O> ordinateUnit,
-      String characteristicPrefix,
-      int decimalPlaces)
+      String input, Unit<A> abscissaUnit, Unit<O> ordinateUnit, String characteristicPrefix)
       throws ParsingException {
     this.characteristicPrefix = characteristicPrefix;
-    this.decimalPlaces = decimalPlaces;
 
     if (!input.startsWith(characteristicPrefix + ":{") || !input.endsWith("}"))
       throw new ParsingException(
@@ -114,31 +106,28 @@ public SortedSet<CharacteristicPoint<A, O>> getPoints() {
   }
 
   /**
-   * De-serialize the characteristic to a commonly understood string
+   * Serialize the characteristic to a commonly understood string
    *
-   * @return the characteristic as de-serialized string
+   * @return the characteristic as serialized string
    */
-  public String deSerialize() {
+  public String serialize() {
     return characteristicPrefix
         + ":{"
-        + points.stream()
-            .map(point -> point.deSerialize(decimalPlaces))
-            .collect(Collectors.joining(","))
+        + points.stream().map(CharacteristicPoint::serialize).collect(Collectors.joining(","))
         + "}";
   }
 
   @Override
   public boolean equals(Object o) {
     if (this == o) return true;
     if (!(o instanceof CharacteristicInput<?, ?> that)) return false;
-    return decimalPlaces == that.decimalPlaces
-        && characteristicPrefix.equals(that.characteristicPrefix)
-        && points.equals(that.points);
+
+    return characteristicPrefix.equals(that.characteristicPrefix) && points.equals(that.points);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(characteristicPrefix, decimalPlaces, points);
+    return Objects.hash(characteristicPrefix, points);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/models/input/system/characteristic/CharacteristicPoint.java

@@ -96,15 +96,13 @@ public ComparableQuantity<O> getY() {
   }
 
   /**
-   * De-serializes the given point to a string
+   * Serializes the given point to a string
    *
-   * @param decimalPlaces Desired amount of decimal places
-   * @return The de-serialized point
+   * @return The serialized point
    */
-  public String deSerialize(int decimalPlaces) {
-    String formattingString = String.format("(%%.%sf,%%.%sf)", decimalPlaces, decimalPlaces);
+  public String serialize() {
     return String.format(
-        Locale.ENGLISH, formattingString, x.getValue().doubleValue(), y.getValue().doubleValue());
+        Locale.ENGLISH, "(%s,%s)", x.getValue().doubleValue(), y.getValue().doubleValue());
   }
 
   @Override