feat: add partial loading on bus network components (#851)

TheMaskedTurtle · web-flow · commit 19f6095a6b7a · 2025-09-22T13:50:49.000+02:00
* feat: add partial loading on bus network components

Signed-off-by: Joris Mancini &lt;joris.mancini_externe@rte-france.com&gt;

* fix tests

Signed-off-by: Joris Mancini &lt;joris.mancini_externe@rte-france.com&gt;

* add tests

Signed-off-by: Joris Mancini &lt;joris.mancini_externe@rte-france.com&gt;

---------

Signed-off-by: Joris Mancini &lt;joris.mancini_externe@rte-france.com&gt;
diff --git a/src/main/java/org/gridsuite/study/server/dto/InfoTypeParameters.java b/src/main/java/org/gridsuite/study/server/dto/InfoTypeParameters.java
@@ -18,6 +18,7 @@ public class InfoTypeParameters {
     public static final String QUERY_PARAM_DC_POWERFACTOR = "dcPowerFactor";
     public static final String QUERY_PARAM_LOAD_OPERATIONAL_LIMIT_GROUPS = "loadOperationalLimitGroups";
     public static final String QUERY_PARAM_LOAD_REGULATING_TERMINALS = "loadRegulatingTerminals";
+    public static final String QUERY_PARAM_LOAD_NETWORK_COMPONENTS = "loadNetworkComponents";
 
     private String infoType;
     private Map<String, String> optionalParameters;
diff --git a/src/main/java/org/gridsuite/study/server/dto/SpreadsheetParameters.java b/src/main/java/org/gridsuite/study/server/dto/SpreadsheetParameters.java
@@ -40,6 +40,10 @@ public class SpreadsheetParameters {
     @JsonInclude(Include.NON_EMPTY)
     private GeneratorSpreadsheetParameters generator;
 
+    @JsonProperty("BUS")
+    @JsonInclude(Include.NON_EMPTY)
+    private BusSpreadsheetParameters bus;
+
     @AllArgsConstructor
     @NoArgsConstructor
     @Data
@@ -61,4 +65,15 @@ public static class GeneratorSpreadsheetParameters {
         @JsonInclude(Include.NON_NULL)
         private Boolean regulatingTerminal;
     }
+
+    @AllArgsConstructor
+    @NoArgsConstructor
+    @Data
+    @Accessors(chain = true)
+    @Jacksonized
+    @Builder
+    public static class BusSpreadsheetParameters {
+        @JsonInclude(Include.NON_NULL)
+        private Boolean networkComponents;
+    }
 }
diff --git a/src/main/java/org/gridsuite/study/server/dto/modification/EquipmentDeletionInfos.java b/src/main/java/org/gridsuite/study/server/dto/modification/EquipmentDeletionInfos.java
@@ -23,5 +23,5 @@
 @ToString(callSuper = true)
 @Schema(description = "Equipment deletion")
 public class EquipmentDeletionInfos extends EquipmentModificationInfos {
-    // String equipmentType transfered up to EquipmentModificationInfos.
+    // String equipmentType transferred up to EquipmentModificationInfos.
 }
diff --git a/src/main/java/org/gridsuite/study/server/repository/SpreadsheetParametersEntity.java b/src/main/java/org/gridsuite/study/server/repository/SpreadsheetParametersEntity.java
@@ -36,12 +36,17 @@ public class SpreadsheetParametersEntity {
     @Default
     private boolean spreadsheetLoadGeneratorRegulatingTerminal = false;
 
+    @Column(name = "sp_load_bus_nc", nullable = false, columnDefinition = "boolean default false")
+    @Default
+    private boolean spreadsheetLoadBusNetworkComponents = false;
+
     public SpreadsheetParameters toDto() {
         return new SpreadsheetParameters(
             new BranchSpreadsheetParameters(this.spreadsheetLoadBranchOperationalLimitGroup),
             new BranchSpreadsheetParameters(this.spreadsheetLoadLineOperationalLimitGroup),
             new BranchSpreadsheetParameters(this.spreadsheetLoadTwtOperationalLimitGroup),
-            new GeneratorSpreadsheetParameters(this.spreadsheetLoadGeneratorRegulatingTerminal)
+            new GeneratorSpreadsheetParameters(this.spreadsheetLoadGeneratorRegulatingTerminal),
+            new SpreadsheetParameters.BusSpreadsheetParameters(this.spreadsheetLoadBusNetworkComponents)
         );
     }
 
@@ -78,6 +83,13 @@ public boolean update(@NonNull final SpreadsheetParameters dto) {
                 this.spreadsheetLoadGeneratorRegulatingTerminal = generatorParams.getRegulatingTerminal();
             }
         }
+        final SpreadsheetParameters.BusSpreadsheetParameters busParams = dto.getBus();
+        if (busParams != null) {
+            if (busParams.getNetworkComponents() != null && this.spreadsheetLoadBusNetworkComponents != busParams.getNetworkComponents()) {
+                modified = true;
+                this.spreadsheetLoadBusNetworkComponents = busParams.getNetworkComponents();
+            }
+        }
         return modified;
     }
 }
diff --git a/src/main/java/org/gridsuite/study/server/service/StudyService.java b/src/main/java/org/gridsuite/study/server/service/StudyService.java
@@ -900,6 +900,9 @@ private static Map<String, String> getOptionalParameters(String elementType, Stu
             case "generator" -> additionalParameters.put(
                 InfoTypeParameters.QUERY_PARAM_LOAD_REGULATING_TERMINALS,
                 String.valueOf(studyEntity.getSpreadsheetParameters().isSpreadsheetLoadGeneratorRegulatingTerminal()));
+            case "bus" -> additionalParameters.put(
+                InfoTypeParameters.QUERY_PARAM_LOAD_NETWORK_COMPONENTS,
+                String.valueOf(studyEntity.getSpreadsheetParameters().isSpreadsheetLoadBusNetworkComponents()));
         }
         return additionalParameters;
     }
@@ -961,6 +964,10 @@ public String getAllMapData(UUID studyUuid, UUID nodeUuid, UUID rootNetworkUuid,
             Map.of(
                 InfoTypeParameters.QUERY_PARAM_LOAD_REGULATING_TERMINALS,
                 String.valueOf(studyEntity.getSpreadsheetParameters().isSpreadsheetLoadGeneratorRegulatingTerminal())));
+        optionalParameters.put(String.valueOf(ElementType.BUS),
+            Map.of(
+                InfoTypeParameters.QUERY_PARAM_LOAD_NETWORK_COMPONENTS,
+                String.valueOf(studyEntity.getSpreadsheetParameters().isSpreadsheetLoadBusNetworkComponents())));
         return networkMapService.getAllElementsInfos(
             rootNetworkService.getNetworkUuid(rootNetworkUuid),
             networkModificationTreeService.getVariantId(nodeUuid, rootNetworkUuid),
diff --git a/src/main/resources/db/changelog/changesets/changelog_20250917T153853Z.xml b/src/main/resources/db/changelog/changesets/changelog_20250917T153853Z.xml
@@ -0,0 +1,10 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet author="mancinijor (generated)" id="1758123566985-22">
+        <addColumn tableName="study">
+            <column defaultValueBoolean="false" name="sp_load_bus_nc" type="boolean">
+                <constraints nullable="false"/>
+            </column>
+        </addColumn>
+    </changeSet>
+</databaseChangeLog>
diff --git a/src/main/resources/db/changelog/db.changelog-master.yaml b/src/main/resources/db/changelog/db.changelog-master.yaml
@@ -338,3 +338,6 @@ databaseChangeLog:
   - include:
       file: changesets/changelog_20250828T134627Z.xml
       relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20250917T153853Z.xml
+      relativeToChangelogFile: true
diff --git a/src/test/java/org/gridsuite/study/server/NetworkMapTest.java b/src/test/java/org/gridsuite/study/server/NetworkMapTest.java
@@ -590,6 +590,9 @@ void testGetAllNetworkElementsInfos(final MockWebServer server) throws Exception
   "GENERATOR": {
     "loadRegulatingTerminals": "true"
   },
+  "BUS" : {
+    "loadNetworkComponents" : "false"
+  },
   "TIE_LINE": {
     "dcPowerFactor": "1.0"
   },
diff --git a/src/test/java/org/gridsuite/study/server/repository/SpreadsheetParametersEntityTest.java b/src/test/java/org/gridsuite/study/server/repository/SpreadsheetParametersEntityTest.java
@@ -20,6 +20,7 @@ void testEntityCreationWithDefaultBuilder() {
         assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadLineOperationalLimitGroup());
         assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadTwtOperationalLimitGroup());
         assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadGeneratorRegulatingTerminal());
+        assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadBusNetworkComponents());
     }
 
     @Test
@@ -29,11 +30,13 @@ void testEntityCreationWithBuilder() {
             .spreadsheetLoadLineOperationalLimitGroup(true)
             .spreadsheetLoadTwtOperationalLimitGroup(true)
             .spreadsheetLoadGeneratorRegulatingTerminal(true)
+            .spreadsheetLoadBusNetworkComponents(true)
             .build();
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadBranchOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadLineOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadTwtOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadGeneratorRegulatingTerminal());
+        assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadBusNetworkComponents());
     }
 
     @Test
@@ -43,13 +46,15 @@ void testToDto() {
             .spreadsheetLoadLineOperationalLimitGroup(true)
             .spreadsheetLoadTwtOperationalLimitGroup(true)
             .spreadsheetLoadGeneratorRegulatingTerminal(true)
+            .spreadsheetLoadBusNetworkComponents(true)
             .build();
 
         SpreadsheetParameters spreadsheetParameters = spreadsheetParametersEntity.toDto();
         assertTrue(spreadsheetParameters.getBranch().getOperationalLimitsGroups());
         assertTrue(spreadsheetParameters.getLine().getOperationalLimitsGroups());
         assertTrue(spreadsheetParameters.getTwt().getOperationalLimitsGroups());
         assertTrue(spreadsheetParameters.getGenerator().getRegulatingTerminal());
+        assertTrue(spreadsheetParameters.getBus().getNetworkComponents());
     }
 
     @Test
@@ -65,6 +70,7 @@ void testUpdatePartial() {
         assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadLineOperationalLimitGroup());
         assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadTwtOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadGeneratorRegulatingTerminal());
+        assertFalse(spreadsheetParametersEntity.isSpreadsheetLoadBusNetworkComponents());
     }
 
     @Test
@@ -75,12 +81,14 @@ void testUpdateFull() {
             .line(SpreadsheetParameters.BranchSpreadsheetParameters.builder().operationalLimitsGroups(true).build())
             .twt(SpreadsheetParameters.BranchSpreadsheetParameters.builder().operationalLimitsGroups(true).build())
             .generator(SpreadsheetParameters.GeneratorSpreadsheetParameters.builder().regulatingTerminal(true).build())
+            .bus(SpreadsheetParameters.BusSpreadsheetParameters.builder().networkComponents(true).build())
             .build();
 
         spreadsheetParametersEntity.update(newParameters);
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadBranchOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadLineOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadTwtOperationalLimitGroup());
         assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadGeneratorRegulatingTerminal());
+        assertTrue(spreadsheetParametersEntity.isSpreadsheetLoadBusNetworkComponents());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,5 @@`
`23`	`23`	`@ToString(callSuper = true)`
`24`	`24`	`@Schema(description = "Equipment deletion")`
`25`	`25`	`public class EquipmentDeletionInfos extends EquipmentModificationInfos {`
`26`		`- // String equipmentType transfered up to EquipmentModificationInfos.`
	`26`	`+ // String equipmentType transferred up to EquipmentModificationInfos.`
`27`	`27`	`}`