Feat: Manage Map Card save in layout (#69)

Signed-off-by: sBouzols <[email protected]>

Author: sBouzols

src/main/java/org/gridsuite/studyconfig/server/dto/diagramgridlayout/diagramlayout/AbstractDiagramLayoutJsonMapper.java

@@ -19,7 +19,9 @@
 @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")
+    @JsonSubTypes.Type(value = NetworkAreaDiagramLayout.class, name = "network-area-diagram"),
+    @JsonSubTypes.Type(value = MapLayout.class, name = "map")
+
 })
 public interface AbstractDiagramLayoutJsonMapper {
 }

src/main/java/org/gridsuite/studyconfig/server/dto/diagramgridlayout/diagramlayout/MapLayout.java

@@ -0,0 +1,19 @@
+/**
+ * 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.diagramgridlayout.diagramlayout;
+
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.SuperBuilder;
+
+@SuperBuilder
+@NoArgsConstructor
+@Setter
+@Getter
+public class MapLayout extends AbstractDiagramLayout {
+}

src/main/java/org/gridsuite/studyconfig/server/entities/diagramgridlayout/diagramlayout/MapLayoutEntity.java

@@ -0,0 +1,20 @@
+/**
+ * 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.diagramgridlayout.diagramlayout;
+
+import jakarta.persistence.*;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
+
+@SuperBuilder
+@NoArgsConstructor
+@Entity
+@Getter
+@PrimaryKeyJoinColumn(foreignKey = @ForeignKey(name = "fk_map_layout_abstract"))
+public class MapLayoutEntity extends AbstractDiagramLayoutEntity {
+}

src/main/java/org/gridsuite/studyconfig/server/mapper/DiagramGridLayoutMapper.java

@@ -18,12 +18,14 @@
 import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayout;
 import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.SubstationDiagramLayout;
 import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.VoltageLevelDiagramLayout;
+import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.MapLayout;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.DiagramGridLayoutEntity;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.diagramlayout.AbstractDiagramLayoutEntity;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.diagramlayout.DiagramPositionEntity;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayoutEntity;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.diagramlayout.SubstationDiagramLayoutEntity;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.diagramlayout.VoltageLevelLayoutEntity;
+import org.gridsuite.studyconfig.server.entities.diagramgridlayout.diagramlayout.MapLayoutEntity;
 
 public final class DiagramGridLayoutMapper {
 
@@ -66,6 +68,10 @@ public static AbstractDiagramLayoutEntity toDiagramLayoutEntity(AbstractDiagramL
                     .name(v.getName())
                     .diagramPositions(convertDiagramPositionsMap(v.getDiagramPositions(), DiagramGridLayoutMapper::toDiagramPositionEntity))
                     .build();
+            case MapLayout m -> MapLayoutEntity.builder()
+                    .diagramUuid(m.getDiagramUuid())
+                    .diagramPositions(convertDiagramPositionsMap(m.getDiagramPositions(), DiagramGridLayoutMapper::toDiagramPositionEntity))
+                    .build();
             case null -> null;
             default -> throw new IllegalArgumentException("Unknown diagram layout DTO type: " + dto.getClass());
         };
@@ -91,6 +97,10 @@ public static AbstractDiagramLayout toDiagramLayoutDto(AbstractDiagramLayoutEnti
                     .name(n.getName())
                     .diagramPositions(convertDiagramPositionsMap(n.getDiagramPositions(), DiagramGridLayoutMapper::toDiagramPositionDto))
                     .build();
+            case MapLayoutEntity m -> MapLayout.builder()
+                    .diagramUuid(m.getDiagramUuid())
+                    .diagramPositions(convertDiagramPositionsMap(m.getDiagramPositions(), DiagramGridLayoutMapper::toDiagramPositionDto))
+                    .build();
             case null -> null;
             default -> throw new IllegalArgumentException("Unknown diagram layout entity type: " + entity.getClass());
         };

src/main/resources/db/changelog/changesets/changelog_20250801T093703Z.xml

@@ -0,0 +1,13 @@
+<?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="bouzolssyl (generated)" id="1754041051708-6">
+        <createTable tableName="map_layout_entity">
+            <column name="id" type="UUID">
+                <constraints nullable="false" primaryKey="true" primaryKeyName="map_layout_entityPK"/>
+            </column>
+        </createTable>
+    </changeSet>
+    <changeSet author="bouzolssyl (generated)" id="1754041051708-7">
+        <addForeignKeyConstraint baseColumnNames="id" baseTableName="map_layout_entity" constraintName="fk_map_layout_abstract" deferrable="false" initiallyDeferred="false" referencedColumnNames="id" referencedTableName="abstract_diagram_layout_entity" validate="true"/>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/db/changelog/db.changelog-master.yaml

@@ -65,3 +65,6 @@ databaseChangeLog:
   - include:
       file: changesets/changelog_20250722T151152Z.xml
       relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20250801T093703Z.xml
+      relativeToChangelogFile: true

src/test/java/org/gridsuite/studyconfig/server/DiagramGridLayoutControllerTest.java

@@ -13,6 +13,7 @@
 import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayout;
 import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.SubstationDiagramLayout;
 import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.VoltageLevelDiagramLayout;
+import org.gridsuite.studyconfig.server.dto.diagramgridlayout.diagramlayout.MapLayout;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.DiagramGridLayoutEntity;
 import org.gridsuite.studyconfig.server.entities.diagramgridlayout.DiagramGridLayoutRepository;
 import org.gridsuite.studyconfig.server.mapper.DiagramGridLayoutMapper;
@@ -83,6 +84,22 @@ void testSaveDiagramGridLayout() throws Exception {
         assertThat(diagramGridLayoutToCheck).usingRecursiveComparison().isEqualTo(diagramGridLayoutToSave);
     }
 
+    @Test
+    void testSaveMapGridLayout() throws Exception {
+        DiagramGridLayout mapLayoutToSave = createMapGridLayout();
+
+        MvcResult mockMvcResult = mockMvc.perform(post("/v1/diagram-grid-layout")
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(objectMapper.writeValueAsString(mapLayoutToSave)))
+            .andExpect(status().isOk())
+            .andReturn();
+
+        UUID mapGridLayoutUUID = objectMapper.readValue(mockMvcResult.getResponse().getContentAsString(), UUID.class);
+
+        DiagramGridLayout diagramGridLayoutToCheck = diagramGridLayoutService.getByDiagramGridLayoutUuid(mapGridLayoutUUID);
+        assertThat(diagramGridLayoutToCheck).usingRecursiveComparison().isEqualTo(mapLayoutToSave);
+    }
+
     @Test
     void testUpdateDiagramGridLayout() throws Exception {
         DiagramGridLayoutEntity existingDiagramGridLayout = diagramGridLayoutRepository.save(DiagramGridLayoutMapper.toEntity(createDiagramGridLayout()));
@@ -149,4 +166,21 @@ private DiagramGridLayout createDiagramGridLayout() {
                     .build())))
             .build();
     }
+
+    private DiagramGridLayout createMapGridLayout() {
+        return DiagramGridLayout.builder()
+            .diagramLayouts(new ArrayList<>(List.of(
+                MapLayout.builder()
+                    .diagramPositions(Map.of(
+                        "lg",
+                        DiagramPosition.builder().w(1)
+                            .h(2)
+                            .x(3)
+                            .y(4)
+                            .build()
+                    ))
+                    .diagramUuid(UUID.randomUUID())
+                    .build())))
+            .build();
+    }
 }