Update

Author: vickybung1

docs/readthedocs/io/csvfiles.rst

@@ -15,13 +15,13 @@ Currently we offer two different, pre-defined naming strategies, which you might
    An extended version of the EntityPersistenceNamingStrategy. Additionally, the `Default directory hierarchy`_ is taken
    into account. Please note, that this directory hierarchy is only meant to be used in conjunction with input models.
 
-However, you can control the behaviour of serialization and de-serialization of models by injecting the desired naming
+However, you can control the behaviour of serialization and serialization of models by injecting the desired naming
 strategy you like into :code:`CsvDataSource` and :code:`CsvFileSink`.
 
 Default naming strategy
 =======================
 There is a default mapping from model class to naming of entities in the case you would like to use csv files for
-(de-)serialization of models.
+serialization of models.
 You may extend / alter the naming with pre- or suffix by calling :code:`new EntityPersistenceNamingStrategy("prefix","suffix")`.
 
 Input
@@ -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)
+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:

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/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

@@ -106,9 +106,9 @@ 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 serialize() {
     return characteristicPrefix

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

@@ -96,9 +96,9 @@ public ComparableQuantity<O> getY() {
   }
 
   /**
-   * De-serializes the given point to a string
+   * Serializes the given point to a string
    *
-   * @return The de-serialized point
+   * @return The serialized point
    */
   public String serialize() {
     return String.format(

src/test/groovy/edu/ie3/datamodel/io/processor/input/InputEntityProcessorTest.groovy

@@ -40,7 +40,7 @@ import static edu.ie3.util.quantities.PowerSystemUnits.PU
  */
 class InputEntityProcessorTest extends Specification {
 
-  def "A InputEntityProcessor should de-serialize a provided NodeInput correctly"() {
+  def "A InputEntityProcessor should serialize a provided NodeInput correctly"() {
     given:
     def processor = new InputEntityProcessor(NodeInput)
     def validResult = GridTestData.nodeA
@@ -67,7 +67,7 @@ class InputEntityProcessorTest extends Specification {
     processingResult.get() == expectedResults
   }
 
-  def "A InputEntityProcessor should de-serialize a provided ConnectorInput correctly"() {
+  def "A InputEntityProcessor should serialize a provided ConnectorInput correctly"() {
     given:
     def processor = new InputEntityProcessor(modelClass)
     def validInput = modelInstance
@@ -137,7 +137,7 @@ class InputEntityProcessorTest extends Specification {
     ]
   }
 
-  def "A InputEntityProcessor should de-serialize a provided SystemParticipantInput correctly"() {
+  def "A InputEntityProcessor should serialize a provided SystemParticipantInput correctly"() {
     given:
     def processor = new InputEntityProcessor(modelClass)
     def validInput = modelInstance
@@ -283,7 +283,7 @@ class InputEntityProcessorTest extends Specification {
     ]
   }
 
-  def "The InputEntityProcessor should de-serialize a provided NodeGraphicInput with point correctly"() {
+  def "The InputEntityProcessor should serialize a provided NodeGraphicInput with point correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(NodeGraphicInput)
     NodeGraphicInput validNode = GridTestData.nodeGraphicC
@@ -303,7 +303,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided NodeGraphicInput with path correctly"() {
+  def "The InputEntityProcessor should serialize a provided NodeGraphicInput with path correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(NodeGraphicInput)
     NodeGraphicInput validNode = GridTestData.nodeGraphicD
@@ -323,7 +323,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided LineGraphicInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided LineGraphicInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(LineGraphicInput)
     LineGraphicInput validNode = GridTestData.lineGraphicCtoD
@@ -342,7 +342,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided OperatorInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided OperatorInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(OperatorInput)
     OperatorInput operator = new OperatorInput(UUID.fromString("420ee39c-dd5a-4d9c-9156-23dbdef13e5e"), "Prof. Brokkoli")
@@ -359,7 +359,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided RandomLoadParameters correctly"() {
+  def "The InputEntityProcessor should serialize a provided RandomLoadParameters correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(RandomLoadParameters)
     RandomLoadParameters parameters = new RandomLoadParameters(
@@ -397,7 +397,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided WecTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided WecTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(WecTypeInput)
     WecTypeInput type = TypeTestData.wecType
@@ -422,7 +422,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided Transformer2WTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided Transformer2WTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(Transformer2WTypeInput)
     Transformer2WTypeInput type = GridTestData.transformerTypeBtoD
@@ -452,7 +452,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided Transformer3WTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided Transformer3WTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(Transformer3WTypeInput)
     Transformer3WTypeInput type = GridTestData.transformerTypeAtoBtoC
@@ -488,7 +488,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided LineTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided LineTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(LineTypeInput)
     LineTypeInput type = GridTestData.lineTypeInputCtoD
@@ -511,7 +511,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided EvTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided EvTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(EvTypeInput)
     EvTypeInput type = TypeTestData.evType
@@ -534,7 +534,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided ChpTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided ChpTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(ChpTypeInput)
     ChpTypeInput type = TypeTestData.chpType
@@ -559,7 +559,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided HpTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided HpTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(HpTypeInput)
     HpTypeInput type = TypeTestData.hpType
@@ -581,7 +581,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided BmTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided BmTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(BmTypeInput)
     BmTypeInput type = TypeTestData.bmType
@@ -604,7 +604,7 @@ class InputEntityProcessorTest extends Specification {
     actual.get() == expected
   }
 
-  def "The InputEntityProcessor should de-serialize a provided StorageTypeInput correctly"() {
+  def "The InputEntityProcessor should serialize a provided StorageTypeInput correctly"() {
     given:
     InputEntityProcessor processor = new InputEntityProcessor(StorageTypeInput)
     StorageTypeInput type = TypeTestData.storageType

src/test/groovy/edu/ie3/datamodel/io/processor/result/ResultEntityProcessorTest.groovy

@@ -64,7 +64,7 @@ class ResultEntityProcessorTest extends Specification {
     qDot      : '1.0']
 
 
-  def "A ResultEntityProcessor should de-serialize a provided SystemParticipantResult correctly"() {
+  def "A ResultEntityProcessor should serialize a provided SystemParticipantResult correctly"() {
     given:
     def sysPartResProcessor = new ResultEntityProcessor(modelClass)
     def validResult = validSystemParticipantResult
@@ -105,7 +105,7 @@ class ResultEntityProcessorTest extends Specification {
     ex.message == "Cannot process StorageResult.class with this EntityProcessor. Please either provide an element of LoadResult.class or create a new processor for StorageResult.class!"
   }
 
-  def "A ResultEntityProcessor should de-serialize a NodeResult correctly"() {
+  def "A ResultEntityProcessor should serialize a NodeResult correctly"() {
     given:
     def sysPartResProcessor = new ResultEntityProcessor(NodeResult)
 
@@ -129,7 +129,7 @@ class ResultEntityProcessorTest extends Specification {
 
   }
 
-  def "A ResultEntityProcessor should de-serialize a FlexOptionsResult correctly"() {
+  def "A ResultEntityProcessor should serialize a FlexOptionsResult correctly"() {
     given:
     def sysPartResProcessor = new ResultEntityProcessor(FlexOptionsResult)
 
@@ -219,7 +219,7 @@ class ResultEntityProcessorTest extends Specification {
   boolean closed = true
 
 
-  def "A ResultEntityProcessor should de-serialize all ConnectorResults correctly"() {
+  def "A ResultEntityProcessor should serialize all ConnectorResults correctly"() {
     given:
     def sysPartResProcessor = new ResultEntityProcessor(modelClass)
 
@@ -240,7 +240,7 @@ class ResultEntityProcessorTest extends Specification {
     Transformer3WResult | new Transformer3WResult(uuid, ZonedDateTime.parse("2020-01-30T17:26:44Z[UTC]"), inputModel, iAMag, iAAng, iBMag, iBAng, iCMag, iCAng, tapPos) || expectedTrafo3WResults
   }
 
-  def "A ResultEntityProcessor should de-serialize a CylindricalStorageResult correctly"() {
+  def "A ResultEntityProcessor should serialize a CylindricalStorageResult correctly"() {
     given:
     def sysPartResProcessor = new ResultEntityProcessor(CylindricalStorageResult)
 

src/test/groovy/edu/ie3/datamodel/models/system/characteristic/CharacteristicPointTest.groovy

@@ -58,14 +58,14 @@ class CharacteristicPointTest extends Specification {
     }
   }
 
-  def "An CharacteristicCoordinate is de-serialized correctly"() {
+  def "An CharacteristicCoordinate is serialized correctly"() {
     given: "A point"
     CharacteristicPoint<Power, Dimensionless> point =
         new CharacteristicPoint<Power, Dimensionless>(
         Quantities.getQuantity(3d, KILOWATT),
         Quantities.getQuantity(4d, PERCENT))
 
-    when: "de-serialized"
+    when: "serialized"
     String result = point.serialize()
 
     then: "the result is correct"