Add column type (#22)

ayolab · web-flow · commit 0f5163f1075d · 2025-02-05T17:58:38.000+01:00
Signed-off-by: Ayoub LABIDI &lt;ayoub.labidi@protonmail.com&gt;
diff --git a/src/main/java/org/gridsuite/studyconfig/server/constants/ColumnType.java b/src/main/java/org/gridsuite/studyconfig/server/constants/ColumnType.java
@@ -0,0 +1,18 @@
+/**
+ * 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/.
+ */
+package org.gridsuite.studyconfig.server.constants;
+
+/**
+ * @author Ayoub LABIDI <ayoub.labidi at rte-france.com>
+ */
+
+public enum ColumnType {
+    TEXT,
+    ENUM,
+    NUMBER,
+    BOOLEAN,
+}
diff --git a/src/main/java/org/gridsuite/studyconfig/server/dto/CustomColumnInfos.java b/src/main/java/org/gridsuite/studyconfig/server/dto/CustomColumnInfos.java
@@ -6,6 +6,8 @@
  */
 package org.gridsuite.studyconfig.server.dto;
 
+import org.gridsuite.studyconfig.server.constants.ColumnType;
+
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 
@@ -19,6 +21,12 @@ public record CustomColumnInfos(
     @Schema(description = "Column name")
     String name,
 
+    @Schema(description = "Column type")
+    ColumnType type,
+
+    @Schema(description = "Column precision")
+    Integer precision,
+
     @Schema(description = "Column formula")
     String formula,
 
diff --git a/src/main/java/org/gridsuite/studyconfig/server/entities/CustomColumnEmbeddable.java b/src/main/java/org/gridsuite/studyconfig/server/entities/CustomColumnEmbeddable.java
@@ -6,6 +6,8 @@
  */
 package org.gridsuite.studyconfig.server.entities;
 
+import org.gridsuite.studyconfig.server.constants.ColumnType;
+
 import jakarta.persistence.*;
 import lombok.*;
 
@@ -23,6 +25,13 @@ public class CustomColumnEmbeddable {
     @Column(name = "name", nullable = false, columnDefinition = "varchar(255)")
     private String name;
 
+    @Column(name = "type", nullable = false)
+    @Enumerated(EnumType.STRING)
+    private ColumnType type;
+
+    @Column(name = "precision", columnDefinition = "integer")
+    private Integer precision;
+
     @Column(name = "formula", columnDefinition = "CLOB")
     private String formula;
 
diff --git a/src/main/java/org/gridsuite/studyconfig/server/mapper/SpreadsheetConfigMapper.java b/src/main/java/org/gridsuite/studyconfig/server/mapper/SpreadsheetConfigMapper.java
@@ -49,10 +49,10 @@ public static SpreadsheetConfigEntity toEntity(SpreadsheetConfigInfos dto) {
     }
 
     public static CustomColumnInfos toCustomColumnDto(CustomColumnEmbeddable entity) {
-        return new CustomColumnInfos(entity.getName(), entity.getFormula(), entity.getDependencies(), entity.getId());
+        return new CustomColumnInfos(entity.getName(), entity.getType(), entity.getPrecision(), entity.getFormula(), entity.getDependencies(), entity.getId());
     }
 
     public static CustomColumnEmbeddable toCustomColumnEmbeddable(CustomColumnInfos dto) {
-        return new CustomColumnEmbeddable(dto.name(), dto.formula(), dto.dependencies(), dto.id());
+        return new CustomColumnEmbeddable(dto.name(), dto.type(), dto.precision(), dto.formula(), dto.dependencies(), dto.id());
     }
 }
diff --git a/src/main/java/org/gridsuite/studyconfig/server/service/SpreadsheetConfigService.java b/src/main/java/org/gridsuite/studyconfig/server/service/SpreadsheetConfigService.java
@@ -53,6 +53,8 @@ public UUID duplicateSpreadsheetConfig(UUID id) {
         List<CustomColumnEmbeddable> customColumns = entity.getCustomColumns().stream()
                 .map(column -> CustomColumnEmbeddable.builder()
                         .name(column.getName())
+                        .type(column.getType())
+                        .precision(column.getPrecision())
                         .formula(column.getFormula())
                         .dependencies(column.getDependencies())
                         .id(column.getId())
@@ -167,6 +169,8 @@ public UUID duplicateSpreadsheetConfigCollection(UUID id) {
                     configDuplicate.setCustomColumns(config.getCustomColumns().stream()
                             .map(column -> CustomColumnEmbeddable.builder()
                                     .name(column.getName())
+                                    .type(column.getType())
+                                    .precision(column.getPrecision())
                                     .formula(column.getFormula())
                                     .dependencies(column.getDependencies())
                                     .id(column.getId())
diff --git a/src/main/resources/db/changelog/changesets/changelog_20250201T194706Z.xml b/src/main/resources/db/changelog/changesets/changelog_20250201T194706Z.xml
@@ -0,0 +1,25 @@
+<?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="labidiayo (generated)" id="1738439236362-1">
+        <sql dbms="postgresql">
+            TRUNCATE TABLE spreadsheet_config CASCADE;
+        </sql>
+    </changeSet>
+    <changeSet author="labidiayo (generated)" id="1738439236362-2">
+        <sql dbms="postgresql">
+            TRUNCATE TABLE spreadsheet_config_collection CASCADE;
+        </sql>
+    </changeSet>
+    <changeSet author="labidiayo (generated)" id="1738439236362-3">
+        <addColumn tableName="spreadsheet_custom_column">
+            <column name="precision" type="integer"/>
+        </addColumn>
+    </changeSet>
+    <changeSet author="labidiayo (generated)" id="1738439236362-4">
+        <addColumn tableName="spreadsheet_custom_column">
+            <column name="type" type="varchar(255)">
+                <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
@@ -14,3 +14,6 @@ databaseChangeLog:
   - include:
       file: changesets/changelog_20250124T151522Z.xml
       relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20250201T194706Z.xml
+      relativeToChangelogFile: true
diff --git a/src/test/java/org/gridsuite/studyconfig/server/DtoConverterTest.java b/src/test/java/org/gridsuite/studyconfig/server/DtoConverterTest.java
@@ -7,6 +7,7 @@
 package org.gridsuite.studyconfig.server;
 
 import org.assertj.core.api.WithAssertions;
+import org.gridsuite.studyconfig.server.constants.ColumnType;
 import org.gridsuite.studyconfig.server.constants.SheetType;
 import org.gridsuite.studyconfig.server.dto.CustomColumnInfos;
 import org.gridsuite.studyconfig.server.dto.SpreadsheetConfigInfos;
@@ -63,8 +64,8 @@ void testConversionToEntityOfSpreadsheetConfig() {
                     id,
                     SheetType.BUS,
                     Arrays.asList(
-                            new CustomColumnInfos("Column1", "X+Y", "[\"col1\", \"col2\"]", "id1"),
-                            new CustomColumnInfos("Column2", "Z*W", "[\"col1\"]", "id2")
+                            new CustomColumnInfos("Column1", ColumnType.NUMBER, 1, "X+Y", "[\"col1\", \"col2\"]", "id1"),
+                            new CustomColumnInfos("Column2", ColumnType.NUMBER, 2, "Z*W", "[\"col1\"]", "id2")
                     )
             );
 
@@ -110,7 +111,7 @@ void testConversionToDtoOfCustomColumn() {
 
         @Test
         void testConversionToEmbeddableOfCustomColumn() {
-            CustomColumnInfos dto = new CustomColumnInfos("TestColumn", "X*Y*Z", "[\"col1\", \"col2\"]", "idTest");
+            CustomColumnInfos dto = new CustomColumnInfos("TestColumn", ColumnType.NUMBER, 3, "X*Y*Z", "[\"col1\", \"col2\"]", "idTest");
             CustomColumnEmbeddable customColumnEmbeddable = SpreadsheetConfigMapper.toCustomColumnEmbeddable(dto);
 
             assertThat(customColumnEmbeddable)
diff --git a/src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigCollectionIntegrationTest.java b/src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigCollectionIntegrationTest.java
@@ -8,6 +8,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+import org.gridsuite.studyconfig.server.constants.ColumnType;
 import org.gridsuite.studyconfig.server.constants.SheetType;
 import org.gridsuite.studyconfig.server.dto.CustomColumnInfos;
 import org.gridsuite.studyconfig.server.dto.SpreadsheetConfigCollectionInfos;
@@ -136,8 +137,8 @@ void testDuplicateCollection() throws Exception {
 
     private List<SpreadsheetConfigInfos> createSpreadsheetConfigs() {
         List<CustomColumnInfos> customColumnInfos = Arrays.asList(
-            new CustomColumnInfos("cust_a", "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
-            new CustomColumnInfos("cust_b", "var_minP + 1", null, "idB")
+            new CustomColumnInfos("cust_a", ColumnType.NUMBER, 1, "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
+            new CustomColumnInfos("cust_b", ColumnType.TEXT, null, "var_minP + 1", null, "idB")
         );
 
         return List.of(
@@ -148,10 +149,10 @@ private List<SpreadsheetConfigInfos> createSpreadsheetConfigs() {
 
     private List<SpreadsheetConfigInfos> createUpdatedSpreadsheetConfigs() {
         List<CustomColumnInfos> customColumnInfos = Arrays.asList(
-            new CustomColumnInfos("cust_a", "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
-            new CustomColumnInfos("cust_b", "var_minP + 2", null, "idB"),
-            new CustomColumnInfos("cust_c", "cust_b + 2", "[\"cust_b\"]", "idC"),
-            new CustomColumnInfos("cust_d", "5 + 1", null, "idD")
+            new CustomColumnInfos("cust_a", ColumnType.NUMBER, 1, "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
+            new CustomColumnInfos("cust_b", ColumnType.TEXT, null, "var_minP + 2", null, "idB"),
+            new CustomColumnInfos("cust_c", ColumnType.ENUM, null, "cust_b + 2", "[\"cust_b\"]", "idC"),
+            new CustomColumnInfos("cust_d", ColumnType.NUMBER, 0, "5 + 1", null, "idD")
         );
 
         return List.of(
diff --git a/src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigIntegrationTest.java b/src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigIntegrationTest.java
@@ -8,6 +8,8 @@
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+
+import org.gridsuite.studyconfig.server.constants.ColumnType;
 import org.gridsuite.studyconfig.server.constants.SheetType;
 import org.gridsuite.studyconfig.server.dto.CustomColumnInfos;
 import org.gridsuite.studyconfig.server.dto.MetadataInfos;
@@ -232,18 +234,18 @@ void testDuplicateNonExistent() throws Exception {
 
     private List<CustomColumnInfos> createCustomColumns() {
         return Arrays.asList(
-                new CustomColumnInfos("cust_a", "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
-                new CustomColumnInfos("cust_b", "var_minP + 1", null, "idB"),
-                new CustomColumnInfos("cust_c", "cust_b + 1", "[\"cust_b\"]", "idC"),
-                new CustomColumnInfos("cust_d", "5 + 2", null, "idD")
+                new CustomColumnInfos("cust_a", ColumnType.BOOLEAN, null, "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
+                new CustomColumnInfos("cust_b", ColumnType.NUMBER, 0, "var_minP + 1", null, "idB"),
+                new CustomColumnInfos("cust_c", ColumnType.NUMBER, 2, "cust_b + 1", "[\"cust_b\"]", "idC"),
+                new CustomColumnInfos("cust_d", ColumnType.TEXT, null, "5 + 2", null, "idD")
         );
     }
 
     private List<CustomColumnInfos> createUpdatedCustomColumns() {
         return Arrays.asList(
-                new CustomColumnInfos("cust_x", "cust_y * 2", "[\"cust_y\"]", "idX"),
-                new CustomColumnInfos("cust_y", "var_maxP - 1", null, "idY"),
-                new CustomColumnInfos("cust_z", "cust_x / 2", "[\"cust_x\"]", "idZ")
+                new CustomColumnInfos("cust_x", ColumnType.BOOLEAN, null, "cust_y * 2", "[\"cust_y\"]", "idX"),
+                new CustomColumnInfos("cust_y", ColumnType.NUMBER, 1, "var_maxP - 1", null, "idY"),
+                new CustomColumnInfos("cust_z", ColumnType.NUMBER, 0, "cust_x / 2", "[\"cust_x\"]", "idZ")
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -49,10 +49,10 @@ public static SpreadsheetConfigEntity toEntity(SpreadsheetConfigInfos dto) {`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`public static CustomColumnInfos toCustomColumnDto(CustomColumnEmbeddable entity) {`
`52`		`- return new CustomColumnInfos(entity.getName(), entity.getFormula(), entity.getDependencies(), entity.getId());`
	`52`	`+ return new CustomColumnInfos(entity.getName(), entity.getType(), entity.getPrecision(), entity.getFormula(), entity.getDependencies(), entity.getId());`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`public static CustomColumnEmbeddable toCustomColumnEmbeddable(CustomColumnInfos dto) {`
`56`		`- return new CustomColumnEmbeddable(dto.name(), dto.formula(), dto.dependencies(), dto.id());`
	`56`	`+ return new CustomColumnEmbeddable(dto.name(), dto.type(), dto.precision(), dto.formula(), dto.dependencies(), dto.id());`
`57`	`57`	`}`
`58`	`58`	`}`