Remove useless NadFromElement and add attributes to NetworkAreaDiagram

ayolab · ayolab · commit 142beb53117b · 2025-07-19T01:03:57.000+02:00
Signed-off-by: Ayoub LABIDI &lt;ayoub.labidi@protonmail.com&gt;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/configuration/DiagramLayoutJacksonConfiguration.java b/src/main/java/org/gridsuite/studyconfig/server/configuration/DiagramLayoutJacksonConfiguration.java
@@ -1,42 +1,34 @@
-/*
-  Copyright (c) 2024, RTE (http://www.rte-france.com)
-  This Source Code Form is subject to the terms of the Mozilla Public
-  License, v. 2.0. If a copy of the MPL was not distributed with this
-  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 package org.gridsuite.studyconfig.server.configuration;
 
-import com.fasterxml.jackson.databind.Module;
-import com.fasterxml.jackson.databind.jsontype.NamedType;
-import com.fasterxml.jackson.databind.module.SimpleModule;
-import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.NadFromElementDiagramLayout;
-import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.NetworkAreaDiagramLayout;
-import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.SubstationDiagramLayout;
-import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.VoltageLevelDiagramLayout;
-import org.springframework.context.annotation.Bean;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.AbstractDiagramLayout;
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.AbstractDiagramLayoutJsonMapper;
 import org.springframework.context.annotation.Configuration;
 
+import jakarta.annotation.PostConstruct;
+
 /**
  * Jackson configuration for diagram layout polymorphic serialization.
  * This external configuration avoids circular dependencies between the abstract base class
- * and its subtypes by registering the type mappings outside the class hierarchy.
+ * and its subtypes by using a mixin approach with type mappings.
  */
 @Configuration
 public class DiagramLayoutJacksonConfiguration {
 
-    @Bean
-    public Module diagramLayoutTypeModule() {
-        SimpleModule module = new SimpleModule("DiagramLayoutTypeModule");
+    private final ObjectMapper objectMapper;
 
-        // Register subtypes for polymorphic serialization/deserialization
-        // This approach avoids circular dependencies that would occur with @JsonSubTypes
-        module.registerSubtypes(
-            new NamedType(SubstationDiagramLayout.class, "substation"),
-            new NamedType(VoltageLevelDiagramLayout.class, "voltage-level"),
-            new NamedType(NetworkAreaDiagramLayout.class, "network-area-diagram"),
-            new NamedType(NadFromElementDiagramLayout.class, "nad-from-element")
-        );
+    public DiagramLayoutJacksonConfiguration(ObjectMapper objectMapper) {
+        this.objectMapper = objectMapper;
+    }
 
-        return module;
+    @PostConstruct
+    public void configureDiagramLayoutMixIn() {
+        objectMapper.addMixIn(AbstractDiagramLayout.class, AbstractDiagramLayoutJsonMapper.class);
     }
 }
diff --git a/src/main/java/org/gridsuite/studyconfig/server/controller/StudyLayoutController.java b/src/main/java/org/gridsuite/studyconfig/server/controller/StudyLayoutController.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.controller;
 
 import io.swagger.v3.oas.annotations.Operation;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/StudyLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/StudyLayout.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.dto.studylayout;
 
 import lombok.*;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/AbstractDiagramLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/AbstractDiagramLayout.java
@@ -1,6 +1,11 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
 
-import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -15,12 +20,6 @@
 @NoArgsConstructor
 @Setter
 @Getter
-@JsonTypeInfo(
-    use = JsonTypeInfo.Id.NAME,
-    include = JsonTypeInfo.As.PROPERTY,
-    property = "type",
-    visible = true
-)
 public abstract class AbstractDiagramLayout {
     UUID diagramUuid;
 
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/AbstractDiagramLayoutJsonMapper.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/AbstractDiagramLayoutJsonMapper.java
@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+/**
+ * MixIn interface for AbstractDiagramLayout to define polymorphic serialization
+ * without creating circular dependencies in the class hierarchy.
+ * This approach avoids circular dependencies that would occur with @JsonSubTypes
+ * directly on the abstract class.
+ */
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true)
+@JsonSubTypes({
+    @JsonSubTypes.Type(value = SubstationDiagramLayout.class, name = "substation"),
+    @JsonSubTypes.Type(value = VoltageLevelDiagramLayout.class, name = "voltage-level"),
+    @JsonSubTypes.Type(value = NetworkAreaDiagramLayout.class, name = "network-area-diagram")
+})
+public interface AbstractDiagramLayoutJsonMapper {
+}
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/DiagramGridLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/DiagramGridLayout.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
 
 import lombok.AllArgsConstructor;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/NadFromElementDiagramLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/NadFromElementDiagramLayout.java
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/NetworkAreaDiagramLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/NetworkAreaDiagramLayout.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
 
 import lombok.AllArgsConstructor;
@@ -7,13 +13,18 @@
 import lombok.experimental.SuperBuilder;
 
 import java.util.List;
+import java.util.UUID;
 
 @SuperBuilder
 @AllArgsConstructor
 @NoArgsConstructor
 @Setter
 @Getter
 public class NetworkAreaDiagramLayout extends AbstractDiagramLayout {
+    UUID filterUuid;
+    UUID nadConfigUuid;
     List<String> voltageLevelIds;
+    List<String> voltageLevelToExpandIds;
+    List<String> voltageLevelToOmitIds;
     Integer depth;
 }
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/SubstationDiagramLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/SubstationDiagramLayout.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
 
 import lombok.AllArgsConstructor;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/VoltageLevelDiagramLayout.java b/src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/VoltageLevelDiagramLayout.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
 
 import lombok.AllArgsConstructor;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/AbstractDiagramLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/AbstractDiagramLayoutEntity.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import jakarta.persistence.*;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/DiagramGridLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/DiagramGridLayoutEntity.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import jakarta.persistence.Embeddable;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/NadFromElementDiagramLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/NadFromElementDiagramLayoutEntity.java
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/NetworkAreaDiagramLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/NetworkAreaDiagramLayoutEntity.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import jakarta.persistence.*;
@@ -7,6 +13,7 @@
 import lombok.experimental.SuperBuilder;
 
 import java.util.List;
+import java.util.UUID;
 
 @Entity
 @SuperBuilder
@@ -15,13 +22,36 @@
 @Getter
 @PrimaryKeyJoinColumn(foreignKey = @ForeignKey(name = "fk_network_area_diagram_layout_abstract"))
 public class NetworkAreaDiagramLayoutEntity extends AbstractDiagramLayoutEntity {
-    @ElementCollection(fetch = FetchType.EAGER)
+    @Column(name = "filter_uuid")
+    UUID filterUuid;
+
+    @Column(name = "nad_config_uuid")
+    UUID nadConfigUuid;
+
+    @ElementCollection
     @CollectionTable(
         name = "network_area_diagram_voltage_level_ids",
         joinColumns = @JoinColumn(name = "network_area_diagram_layout_id"),
         foreignKey = @ForeignKey(name = "fk_network_area_diagram_voltage_level_ids")
     )
     List<String> voltageLevelIds;
 
+    @ElementCollection
+    @CollectionTable(
+        name = "network_area_diagram_voltage_level_to_expand_ids",
+        joinColumns = @JoinColumn(name = "network_area_diagram_layout_id"),
+        foreignKey = @ForeignKey(name = "fk_network_area_diagram_voltage_level_to_expand_ids")
+    )
+    List<String> voltageLevelToExpandIds;
+
+    @ElementCollection
+    @CollectionTable(
+        name = "network_area_diagram_voltage_level_to_omit_ids",
+        joinColumns = @JoinColumn(name = "network_area_diagram_layout_id"),
+        foreignKey = @ForeignKey(name = "fk_network_area_diagram_voltage_level_to_omit_ids")
+    )
+    List<String> voltageLevelToOmitIds;
+
+    @Column(name = "depth")
     Integer depth;
 }
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/StudyLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/StudyLayoutEntity.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import jakarta.persistence.*;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/StudyLayoutRepository.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/StudyLayoutRepository.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import org.springframework.data.jpa.repository.JpaRepository;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/SubstationDiagramLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/SubstationDiagramLayoutEntity.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import jakarta.persistence.*;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/VoltageLevelLayoutEntity.java b/src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/VoltageLevelLayoutEntity.java
@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
 import jakarta.persistence.*;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/mapper/StudyLayoutMapper.java b/src/main/java/org/gridsuite/studyconfig/server/mapper/StudyLayoutMapper.java
diff --git a/src/main/java/org/gridsuite/studyconfig/server/service/StudyLayoutService.java b/src/main/java/org/gridsuite/studyconfig/server/service/StudyLayoutService.java
diff --git a/src/main/resources/db/changelog/changesets/changelog_20250717T215546Z.xml b/src/main/resources/db/changelog/changesets/changelog_20250717T215546Z.xml
diff --git a/src/main/resources/db/changelog/db.changelog-master.yaml b/src/main/resources/db/changelog/db.changelog-master.yaml
diff --git a/src/test/java/org/gridsuite/studyconfig/server/StudyLayoutControllerTest.java b/src/test/java/org/gridsuite/studyconfig/server/StudyLayoutControllerTest.java
