refactor tabular modification (#412)

we use an enum rather than a string, and simplify the code Signed-off-by: David BRAQUART <[email protected]>
gridsuite · Jan 10, 2024 · dfface3 · dfface3
1 parent 32bda50
commit dfface3
Show file tree

Hide file tree

Showing 12 changed files with 87 additions and 135 deletions.
diff --git a/src/main/java/org/gridsuite/modification/server/dto/TabularModificationInfos.java b/src/main/java/org/gridsuite/modification/server/dto/TabularModificationInfos.java
@@ -6,6 +6,7 @@
  */
 package org.gridsuite.modification.server.dto;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.powsybl.commons.reporter.Reporter;
 import com.powsybl.commons.reporter.ReporterModel;
@@ -35,11 +36,13 @@
 @JsonTypeName("TABULAR_MODIFICATION")
 @ModificationErrorTypeName("TABULAR_MODIFICATION_ERROR")
 public class TabularModificationInfos extends ModificationInfos {
+
     @Schema(description = "Modification type")
     @NonNull
-    private String modificationType;
+    private ModificationType modificationType;
 
     @Schema(description = "modifications")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
     private List<ModificationInfos> modifications;
 
     @Override
@@ -60,7 +63,7 @@ public Reporter createSubReporter(ReporterModel reporter) {
     @Override
     public Map<String, String> getMapMessageValues() {
         Map<String, String> mapMessageValues = new HashMap<>();
-        mapMessageValues.put("tabularModificationType", getModificationType());
+        mapMessageValues.put("tabularModificationType", getModificationType().name());
         return mapMessageValues;
     }
 }
diff --git a/src/main/java/org/gridsuite/modification/server/entities/TabularModificationEntity.java b/src/main/java/org/gridsuite/modification/server/entities/TabularModificationEntity.java
@@ -15,15 +15,8 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import org.gridsuite.modification.server.ModificationType;
 import org.gridsuite.modification.server.dto.*;
-import org.gridsuite.modification.server.entities.equipment.modification.BatteryModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.GeneratorModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.LineModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.LoadModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.SubstationModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.TwoWindingsTransformerModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.ShuntCompensatorModificationEntity;
-import org.gridsuite.modification.server.entities.equipment.modification.VoltageLevelModificationEntity;
 
 /**
  * @author Etienne Homer <etienne.homer at rte-france.com>
@@ -36,43 +29,16 @@
 public class TabularModificationEntity extends ModificationEntity {
 
     @Column(name = "modificationType")
-    private String modificationType;
+    @Enumerated(EnumType.STRING)
+    private ModificationType modificationType;
 
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
     @OrderColumn
     private List<ModificationEntity> modifications;
 
-    public TabularModificationEntity(TabularModificationInfos tabularModificationInfos) {
+    public TabularModificationEntity(@NonNull TabularModificationInfos tabularModificationInfos) {
         super(tabularModificationInfos);
-        modificationType = tabularModificationInfos.getModificationType();
-        switch (modificationType) {
-            case "GENERATOR_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(generatorModificationInfos -> new GeneratorModificationEntity((GeneratorModificationInfos) generatorModificationInfos)).collect(Collectors.toList());
-                break;
-            case "LOAD_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(loadModificationInfos -> new LoadModificationEntity((LoadModificationInfos) loadModificationInfos)).collect(Collectors.toList());
-                break;
-            case "TWO_WINDINGS_TRANSFORMER_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(twtModificationInfos -> new TwoWindingsTransformerModificationEntity((TwoWindingsTransformerModificationInfos) twtModificationInfos)).collect(Collectors.toList());
-                break;
-            case "BATTERY_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(batteryModificationInfos -> new BatteryModificationEntity((BatteryModificationInfos) batteryModificationInfos)).collect(Collectors.toList());
-                break;
-            case "VOLTAGE_LEVEL_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(voltageLevelModificationInfos -> new VoltageLevelModificationEntity((VoltageLevelModificationInfos) voltageLevelModificationInfos)).collect(Collectors.toList());
-                break;
-            case "SHUNT_COMPENSATOR_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(shuntCompensatorModificationInfos -> new ShuntCompensatorModificationEntity((ShuntCompensatorModificationInfos) shuntCompensatorModificationInfos)).collect(Collectors.toList());
-                break;
-            case "LINE_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(lineModificationInfos -> new LineModificationEntity((LineModificationInfos) lineModificationInfos)).collect(Collectors.toList());
-                break;
-            case "SUBSTATION_MODIFICATION":
-                modifications = tabularModificationInfos.getModifications().stream().map(subStationModificationInfos -> new SubstationModificationEntity((SubstationModificationInfos) subStationModificationInfos)).collect(Collectors.toList());
-                break;
-            default:
-                break;
-        }
+        assignAttributes(tabularModificationInfos);
     }
 
     @Override
@@ -90,37 +56,16 @@ public TabularModificationInfos toModificationInfos() {
     @Override
     public void update(@NonNull ModificationInfos modificationInfos) {
         super.update(modificationInfos);
-        TabularModificationInfos tabularModificationInfos = (TabularModificationInfos) modificationInfos;
+        assignAttributes((TabularModificationInfos) modificationInfos);
+    }
+
+    private void assignAttributes(TabularModificationInfos tabularModificationInfos) {
         modificationType = tabularModificationInfos.getModificationType();
-        modifications.clear();
-        switch (modificationType) {
-            case "GENERATOR_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(generatorModificationInfos -> new GeneratorModificationEntity((GeneratorModificationInfos) generatorModificationInfos)).collect(Collectors.toList()));
-                break;
-            case "BATTERY_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(batteryModificationInfos -> new BatteryModificationEntity((BatteryModificationInfos) batteryModificationInfos)).collect(Collectors.toList()));
-                break;
-            case "LOAD_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(loadModificationInfos -> new LoadModificationEntity((LoadModificationInfos) loadModificationInfos)).collect(Collectors.toList()));
-                break;
-            case "TWO_WINDINGS_TRANSFORMER_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(twtModificationInfos -> new TwoWindingsTransformerModificationEntity((TwoWindingsTransformerModificationInfos) twtModificationInfos)).collect(Collectors.toList()));
-                break;
-            case "VOLTAGE_LEVEL_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(voltageLevelModificationInfos -> new VoltageLevelModificationEntity((VoltageLevelModificationInfos) voltageLevelModificationInfos)).collect(Collectors.toList()));
-                break;
-            case "SHUNT_COMPENSATOR_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(shuntCompensatorModificationInfos -> new ShuntCompensatorModificationEntity((ShuntCompensatorModificationInfos) shuntCompensatorModificationInfos)).toList());
-                break;
-            case "LINE_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(lineModificationInfos -> new LineModificationEntity((LineModificationInfos) lineModificationInfos)).collect(Collectors.toList()));
-                break;
-            case "SUBSTATION_MODIFICATION":
-                modifications.addAll(tabularModificationInfos.getModifications().stream().map(subStationModificationInfos -> new SubstationModificationEntity((SubstationModificationInfos) subStationModificationInfos)).toList());
-                break;
-            default:
-                break;
+        if (modifications == null) {
+            modifications = tabularModificationInfos.getModifications().stream().map(ModificationInfos::toEntity).toList();
+        } else {
+            modifications.clear();
+            modifications.addAll(tabularModificationInfos.getModifications().stream().map(ModificationInfos::toEntity).toList());
         }
     }
-
 }
diff --git a/src/main/java/org/gridsuite/modification/server/modifications/TabularModification.java b/src/main/java/org/gridsuite/modification/server/modifications/TabularModification.java
@@ -65,14 +65,14 @@ public void apply(Network network, Reporter subReporter) {
         }
         String defaultMessage = " have been modified";
         defaultMessage = switch (modificationInfos.getModificationType()) {
-            case "GENERATOR_MODIFICATION" -> "generators" + defaultMessage;
-            case "LOAD_MODIFICATION" -> "loads" + defaultMessage;
-            case "TWO_WINDINGS_TRANSFORMER_MODIFICATION" -> "two windings transformers" + defaultMessage;
-            case "BATTERY_MODIFICATION" -> "batteries" + defaultMessage;
-            case "VOLTAGE_LEVEL_MODIFICATION" -> "voltage levels" + defaultMessage;
-            case "SHUNT_COMPENSATOR_MODIFICATION" -> "shunt compensator" + defaultMessage;
-            case "LINE_MODIFICATION" -> "lines" + defaultMessage;
-            case "SUBSTATION_MODIFICATION" -> "substations" + defaultMessage;
+            case GENERATOR_MODIFICATION -> "generators" + defaultMessage;
+            case LOAD_MODIFICATION -> "loads" + defaultMessage;
+            case TWO_WINDINGS_TRANSFORMER_MODIFICATION -> "two windings transformers" + defaultMessage;
+            case BATTERY_MODIFICATION -> "batteries" + defaultMessage;
+            case VOLTAGE_LEVEL_MODIFICATION -> "voltage levels" + defaultMessage;
+            case SHUNT_COMPENSATOR_MODIFICATION -> "shunt compensators" + defaultMessage;
+            case LINE_MODIFICATION -> "lines" + defaultMessage;
+            case SUBSTATION_MODIFICATION -> "substations" + defaultMessage;
             default -> "equipments of unknown type" + defaultMessage;
         };
 

diff --git a/...in/java/org/gridsuite/modification/server/repositories/NetworkModificationRepository.java b/...in/java/org/gridsuite/modification/server/repositories/NetworkModificationRepository.java
@@ -154,7 +154,7 @@ public List<ModificationInfos> getModificationsMetadata(UUID groupUuid, boolean
     public TabularModificationEntity loadTabularModificationSubEntities(ModificationEntity modificationEntity) {
         TabularModificationEntity tabularModificationEntity = (TabularModificationEntity) modificationEntity;
         switch (tabularModificationEntity.getModificationType()) {
-            case "GENERATOR_MODIFICATION":
+            case GENERATOR_MODIFICATION:
                 tabularModificationEntity = modificationRepository.findAllWithReactiveCapabilityCurvePointsById(modificationEntity.getId()).orElseThrow(() ->
                         new NetworkModificationException(MODIFICATION_NOT_FOUND, String.format(MODIFICATION_NOT_FOUND_MESSAGE, modificationEntity.getId()))
                 );

diff --git a/...dification/server/modifications/tabularmodifications/TabularBatteryModificationsTest.java b/...dification/server/modifications/tabularmodifications/TabularBatteryModificationsTest.java
@@ -47,7 +47,7 @@ protected ModificationInfos buildModification() {
                 BatteryModificationInfos.builder().equipmentId("unknownBattery").reactivePowerSetpoint(new AttributeModification<>(500., OperationType.SET)).build()
         );
         return TabularModificationInfos.builder()
-                .modificationType("BATTERY_MODIFICATION")
+                .modificationType(ModificationType.BATTERY_MODIFICATION)
                 .modifications(modifications)
                 .stashed(false)
                 .build();
@@ -61,7 +61,7 @@ protected ModificationInfos buildModificationUpdate() {
                 BatteryModificationInfos.builder().equipmentId("v3Battery").activePowerSetpoint(new AttributeModification<>(6., OperationType.SET)).build()
         );
         return TabularModificationInfos.builder()
-                .modificationType("BATTERY_MODIFICATION")
+                .modificationType(ModificationType.BATTERY_MODIFICATION)
                 .modifications(modifications)
                 .stashed(false)
                 .build();
@@ -85,16 +85,16 @@ protected void assertAfterNetworkModificationDeletion() {
     @Override
     @SneakyThrows
     protected void testCreationModificationMessage(ModificationInfos modificationInfos) {
-        assertEquals("TABULAR_MODIFICATION", modificationInfos.getMessageType());
+        assertEquals(ModificationType.TABULAR_MODIFICATION.name(), modificationInfos.getMessageType());
         Map<String, String> createdValues = mapper.readValue(modificationInfos.getMessageValues(), new TypeReference<>() { });
-        Assertions.assertEquals("BATTERY_MODIFICATION", createdValues.get("tabularModificationType"));
+        Assertions.assertEquals(ModificationType.BATTERY_MODIFICATION.name(), createdValues.get("tabularModificationType"));
     }
 
     @Override
     @SneakyThrows
     protected void testUpdateModificationMessage(ModificationInfos modificationInfos) {
-        assertEquals("TABULAR_MODIFICATION", modificationInfos.getMessageType());
+        assertEquals(ModificationType.TABULAR_MODIFICATION.name(), modificationInfos.getMessageType());
         Map<String, String> updatedValues = mapper.readValue(modificationInfos.getMessageValues(), new TypeReference<>() { });
-        Assertions.assertEquals("BATTERY_MODIFICATION", updatedValues.get("tabularModificationType"));
+        Assertions.assertEquals(ModificationType.BATTERY_MODIFICATION.name(), updatedValues.get("tabularModificationType"));
     }
 }
diff --git a/...fication/server/modifications/tabularmodifications/TabularGeneratorModificationsTest.java b/...fication/server/modifications/tabularmodifications/TabularGeneratorModificationsTest.java
@@ -51,7 +51,7 @@ protected ModificationInfos buildModification() {
                 GeneratorModificationInfos.builder().equipmentId("unknownGenerator").maxActivePower(new AttributeModification<>(500., OperationType.SET)).build()
         );
         return TabularModificationInfos.builder()
-                .modificationType("GENERATOR_MODIFICATION")
+                .modificationType(ModificationType.GENERATOR_MODIFICATION)
                 .modifications(modifications)
                 .stashed(false)
                 .build();
@@ -65,7 +65,7 @@ protected ModificationInfos buildModificationUpdate() {
                 GeneratorModificationInfos.builder().equipmentId("v6generator").maxActivePower(new AttributeModification<>(300., OperationType.SET)).build()
         );
         return TabularModificationInfos.builder()
-                .modificationType("GENERATOR_MODIFICATION")
+                .modificationType(ModificationType.GENERATOR_MODIFICATION)
                 .modifications(modifications)
                 .stashed(false)
                 .build();
@@ -92,7 +92,7 @@ public void testCheckSqlRequestsCount() throws Exception {
                 GeneratorModificationInfos.builder().equipmentId("v6generator").maxActivePower(new AttributeModification<>(300., OperationType.SET)).build()
         );
         ModificationInfos modificationInfos = TabularModificationInfos.builder()
-                .modificationType("GENERATOR_MODIFICATION")
+                .modificationType(ModificationType.GENERATOR_MODIFICATION)
                 .modifications(modifications)
                 .build();
         UUID modificationUuid = saveModification(modificationInfos);
@@ -109,7 +109,7 @@ public void testCheckSqlRequestsCount() throws Exception {
                 GeneratorModificationInfos.builder().equipmentId("v6generator").maxActivePower(new AttributeModification<>(300., OperationType.SET)).build()
         );
         modificationInfos = TabularModificationInfos.builder()
-                .modificationType("GENERATOR_MODIFICATION")
+                .modificationType(ModificationType.GENERATOR_MODIFICATION)
                 .modifications(modifications)
                 .build();
         modificationUuid = saveModification(modificationInfos);
@@ -137,7 +137,7 @@ public void testAllModificationsHaveFailed() throws Exception {
                 GeneratorModificationInfos.builder().equipmentId("v6generator").maxActivePower(new AttributeModification<>(-300., OperationType.SET)).build()
         );
         ModificationInfos modificationInfos = TabularModificationInfos.builder()
-                .modificationType("GENERATOR_MODIFICATION")
+                .modificationType(ModificationType.GENERATOR_MODIFICATION)
                 .modifications(modifications)
                 .build();
         String modificationToCreateJson = mapper.writeValueAsString(modificationInfos);
@@ -151,16 +151,16 @@ public void testAllModificationsHaveFailed() throws Exception {
     @Override
     @SneakyThrows
     protected void testCreationModificationMessage(ModificationInfos modificationInfos) {
-        assertEquals("TABULAR_MODIFICATION", modificationInfos.getMessageType());
+        assertEquals(ModificationType.TABULAR_MODIFICATION.name(), modificationInfos.getMessageType());
         Map<String, String> createdValues = mapper.readValue(modificationInfos.getMessageValues(), new TypeReference<>() { });
-        Assertions.assertEquals("GENERATOR_MODIFICATION", createdValues.get("tabularModificationType"));
+        Assertions.assertEquals(ModificationType.GENERATOR_MODIFICATION.name(), createdValues.get("tabularModificationType"));
     }
 
     @Override
     @SneakyThrows
     protected void testUpdateModificationMessage(ModificationInfos modificationInfos) {
-        assertEquals("TABULAR_MODIFICATION", modificationInfos.getMessageType());
+        assertEquals(ModificationType.TABULAR_MODIFICATION.name(), modificationInfos.getMessageType());
         Map<String, String> updatedValues = mapper.readValue(modificationInfos.getMessageValues(), new TypeReference<>() { });
-        Assertions.assertEquals("GENERATOR_MODIFICATION", updatedValues.get("tabularModificationType"));
+        Assertions.assertEquals(ModificationType.GENERATOR_MODIFICATION.name(), updatedValues.get("tabularModificationType"));
     }
 }