Add location id to the SA result (#158)

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

Author: AAJELLAL

pom.xml

@@ -258,4 +258,4 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
-</project>
+</project>

src/main/java/org/gridsuite/securityanalysis/server/dto/LimitViolationDTO.java

@@ -26,6 +26,7 @@ public class LimitViolationDTO {
     private double limitReduction;
     private double value;
     private Double loading;
+    private String locationId;
 
     public static LimitViolationDTO toDto(AbstractLimitViolationEntity limitViolation) {
         return LimitViolationDTO.builder()
@@ -37,11 +38,13 @@ public static LimitViolationDTO toDto(AbstractLimitViolationEntity limitViolatio
             .limitReduction(limitViolation.getLimitReduction())
             .value(limitViolation.getValue())
             .loading(limitViolation.getLoading())
+            .locationId(limitViolation.getLocationId())
             .build();
     }
 
     public List<String> toCsvRow(Map<String, String> translations) {
         List<String> csvRow = new ArrayList<>();
+        csvRow.add(this.getLocationId());
         csvRow.add(this.getLimitType() != null ? CsvExportUtils.translate(this.getLimitType().name(), translations) : "");
         csvRow.add(CsvExportUtils.replaceNullWithEmptyString(CsvExportUtils.translate(this.getLimitName(), translations)));
         csvRow.add(Double.toString(this.getLimit()));

src/main/java/org/gridsuite/securityanalysis/server/dto/PreContingencyLimitViolationResultDTO.java

@@ -11,6 +11,7 @@
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import lombok.experimental.FieldNameConstants;
 import org.gridsuite.securityanalysis.server.entities.PreContingencyLimitViolationEntity;
 
 import java.util.List;
@@ -21,6 +22,7 @@
 @AllArgsConstructor
 @NoArgsConstructor
 @Builder
+@FieldNameConstants
 public class PreContingencyLimitViolationResultDTO {
 
     private String subjectId;
@@ -31,7 +33,6 @@ public static PreContingencyLimitViolationResultDTO toDto(PreContingencyLimitVio
         String subjectId = preContingencyLimitViolation.getSubjectLimitViolation() != null
                 ? preContingencyLimitViolation.getSubjectLimitViolation().getSubjectId()
                 : null;
-
         return PreContingencyLimitViolationResultDTO.builder()
                 .subjectId(subjectId)
                 .status(preContingencyLimitViolation.getResult().getPreContingencyStatus())
@@ -40,7 +41,7 @@ public static PreContingencyLimitViolationResultDTO toDto(PreContingencyLimitVio
     }
 
     public List<String> toCsvRow(Map<String, String> translations) {
-        List<String> csvRow = List.of(this.getSubjectId());
+        List<String> csvRow = List.of();
 
         if (this.getLimitViolation() != null) {
             return Stream.concat(csvRow.stream(), this.getLimitViolation().toCsvRow(translations).stream()).toList();

src/main/java/org/gridsuite/securityanalysis/server/dto/SubjectLimitViolationDTO.java

@@ -21,14 +21,12 @@
 @Builder
 public class SubjectLimitViolationDTO {
     private String subjectId;
-
     private LimitViolationDTO limitViolation;
 
     public static SubjectLimitViolationDTO toDto(ContingencyLimitViolationEntity limitViolation) {
         String subjectId = limitViolation.getSubjectLimitViolation() != null
             ? limitViolation.getSubjectLimitViolation().getSubjectId()
             : null;
-
         return SubjectLimitViolationDTO.builder()
             .subjectId(subjectId)
             .limitViolation(LimitViolationDTO.toDto(limitViolation))

src/main/java/org/gridsuite/securityanalysis/server/dto/SubjectLimitViolationResultDTO.java

@@ -27,7 +27,6 @@
 @NoArgsConstructor
 public class SubjectLimitViolationResultDTO {
     private String subjectId;
-
     private List<ContingencyLimitViolationDTO> contingencies;
 
     public static SubjectLimitViolationResultDTO toDto(SubjectLimitViolationEntity subjectLimitViolation) {

src/main/java/org/gridsuite/securityanalysis/server/entities/AbstractLimitViolationEntity.java

@@ -58,6 +58,9 @@ public abstract class AbstractLimitViolationEntity {
     @Column(name = "loading")
     private Double loading;
 
+    @Column
+    private String locationId;
+
     public static Double computeLoading(LimitViolation limitViolation) {
         return LimitViolationType.CURRENT.equals(limitViolation.getLimitType())
                 ? 100 * limitViolation.getValue() / limitViolation.getLimit()

src/main/java/org/gridsuite/securityanalysis/server/entities/ContingencyEntity.java

@@ -6,6 +6,7 @@
  */
 package org.gridsuite.securityanalysis.server.entities;
 
+import com.powsybl.iidm.network.Network;
 import com.powsybl.security.results.PostContingencyResult;
 import jakarta.persistence.*;
 import lombok.Getter;
@@ -41,7 +42,6 @@ public ContingencyEntity(String contingencyId, String status, List<ContingencyEl
     private UUID uuid;
 
     private String contingencyId;
-
     @Setter
     @ManyToOne(fetch = FetchType.LAZY)
     private SecurityAnalysisResultEntity result;
@@ -64,11 +64,11 @@ private void setContingencyLimitViolations(List<ContingencyLimitViolationEntity>
         }
     }
 
-    public static ContingencyEntity toEntity(PostContingencyResult postContingencyResult, Map<String, SubjectLimitViolationEntity> subjectLimitViolationsBySubjectId) {
+    public static ContingencyEntity toEntity(Network network, PostContingencyResult postContingencyResult, Map<String, SubjectLimitViolationEntity> subjectLimitViolationsBySubjectId) {
         List<ContingencyElementEmbeddable> contingencyElements = postContingencyResult.getContingency().getElements().stream().map(contingencyElement -> ContingencyElementEmbeddable.toEntity(contingencyElement)).collect(Collectors.toList());
 
         List<ContingencyLimitViolationEntity> contingencyLimitViolations = postContingencyResult.getLimitViolationsResult().getLimitViolations().stream()
-            .map(limitViolation -> ContingencyLimitViolationEntity.toEntity(limitViolation, subjectLimitViolationsBySubjectId.get(limitViolation.getSubjectId())))
+            .map(limitViolation -> ContingencyLimitViolationEntity.toEntity(network, limitViolation, subjectLimitViolationsBySubjectId.get(limitViolation.getSubjectId())))
             .collect(Collectors.toList());
         return new ContingencyEntity(postContingencyResult.getContingency().getId(), postContingencyResult.getStatus().name(), contingencyElements, contingencyLimitViolations);
     }

src/main/java/org/gridsuite/securityanalysis/server/entities/ContingencyLimitViolationEntity.java

@@ -6,7 +6,9 @@
  */
 package org.gridsuite.securityanalysis.server.entities;
 
+import com.powsybl.iidm.network.Network;
 import com.powsybl.security.LimitViolation;
+import com.powsybl.ws.commons.computation.utils.ComputationResultUtils;
 import jakarta.persistence.*;
 import lombok.*;
 import lombok.experimental.FieldNameConstants;
@@ -30,7 +32,7 @@ public class ContingencyLimitViolationEntity extends AbstractLimitViolationEntit
     @Setter
     private ContingencyEntity contingency;
 
-    public static ContingencyLimitViolationEntity toEntity(LimitViolation limitViolation, SubjectLimitViolationEntity subjectLimitViolation) {
+    public static ContingencyLimitViolationEntity toEntity(Network network, LimitViolation limitViolation, SubjectLimitViolationEntity subjectLimitViolation) {
         ContingencyLimitViolationEntity contingencyLimitViolationEntity = ContingencyLimitViolationEntity.builder()
             .limit(limitViolation.getLimit())
             .limitName(limitViolation.getLimitName())
@@ -40,6 +42,7 @@ public static ContingencyLimitViolationEntity toEntity(LimitViolation limitViola
             .value(limitViolation.getValue())
             .side(limitViolation.getSide())
             .loading(computeLoading(limitViolation))
+            .locationId(ComputationResultUtils.getViolationLocationId(limitViolation, network))
             .subjectLimitViolation(subjectLimitViolation)
             .build();
 

src/main/java/org/gridsuite/securityanalysis/server/entities/PreContingencyLimitViolationEntity.java

@@ -6,12 +6,11 @@
  */
 package org.gridsuite.securityanalysis.server.entities;
 
+import com.powsybl.iidm.network.Network;
 import com.powsybl.security.LimitViolation;
 import com.powsybl.security.results.PreContingencyResult;
-import jakarta.persistence.Entity;
-import jakarta.persistence.FetchType;
-import jakarta.persistence.ManyToOne;
-import jakarta.persistence.Table;
+import com.powsybl.ws.commons.computation.utils.ComputationResultUtils;
+import jakarta.persistence.*;
 import lombok.Data;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -35,16 +34,15 @@
 @FieldNameConstants
 @Table(name = "pre_contingency_limit_violation")
 public class PreContingencyLimitViolationEntity extends AbstractLimitViolationEntity {
-
     @ManyToOne(fetch = FetchType.LAZY)
     @Setter
     SecurityAnalysisResultEntity result;
 
-    public static List<PreContingencyLimitViolationEntity> toEntityList(PreContingencyResult preContingencyResult, Map<String, SubjectLimitViolationEntity> subjectLimitViolationsBySubjectId) {
-        return preContingencyResult.getLimitViolationsResult().getLimitViolations().stream().map(limitViolation -> toEntity(limitViolation, subjectLimitViolationsBySubjectId.get(limitViolation.getSubjectId()))).collect(Collectors.toList());
+    public static List<PreContingencyLimitViolationEntity> toEntityList(Network network, PreContingencyResult preContingencyResult, Map<String, SubjectLimitViolationEntity> subjectLimitViolationsBySubjectId) {
+        return preContingencyResult.getLimitViolationsResult().getLimitViolations().stream().map(limitViolation -> toEntity(network, limitViolation, subjectLimitViolationsBySubjectId.get(limitViolation.getSubjectId()))).collect(Collectors.toList());
     }
 
-    public static PreContingencyLimitViolationEntity toEntity(LimitViolation limitViolation, SubjectLimitViolationEntity subjectLimitViolation) {
+    public static PreContingencyLimitViolationEntity toEntity(Network network, LimitViolation limitViolation, SubjectLimitViolationEntity subjectLimitViolation) {
         return PreContingencyLimitViolationEntity.builder()
             .subjectLimitViolation(subjectLimitViolation)
             .limit(limitViolation.getLimit())
@@ -55,6 +53,7 @@ public static PreContingencyLimitViolationEntity toEntity(LimitViolation limitVi
             .value(limitViolation.getValue())
             .side(limitViolation.getSide())
             .loading(computeLoading(limitViolation))
+            .locationId(ComputationResultUtils.getViolationLocationId(limitViolation, network))
             .build();
     }
 }

src/main/java/org/gridsuite/securityanalysis/server/entities/SecurityAnalysisResultEntity.java

@@ -6,6 +6,7 @@
  */
 package org.gridsuite.securityanalysis.server.entities;
 
+import com.powsybl.iidm.network.Network;
 import com.powsybl.security.SecurityAnalysisResult;
 import jakarta.persistence.*;
 import lombok.*;
@@ -52,17 +53,17 @@ public SecurityAnalysisResultEntity(UUID id) {
         this.id = id;
     }
 
-    public static SecurityAnalysisResultEntity toEntity(UUID resultUuid, SecurityAnalysisResult securityAnalysisResult, SecurityAnalysisStatus securityAnalysisStatus) {
+    public static SecurityAnalysisResultEntity toEntity(Network network, UUID resultUuid, SecurityAnalysisResult securityAnalysisResult, SecurityAnalysisStatus securityAnalysisStatus) {
         Map<String, SubjectLimitViolationEntity> subjectLimitViolationsBySubjectId = getUniqueSubjectLimitViolationsFromResult(securityAnalysisResult)
             .stream().collect(Collectors.toMap(
                 SubjectLimitViolationEntity::getSubjectId,
                 subjectLimitViolation -> subjectLimitViolation)
             );
 
         List<ContingencyEntity> contingencies = securityAnalysisResult.getPostContingencyResults().stream()
-            .map(postContingencyResult -> ContingencyEntity.toEntity(postContingencyResult, subjectLimitViolationsBySubjectId)).collect(Collectors.toList());
+            .map(postContingencyResult -> ContingencyEntity.toEntity(network, postContingencyResult, subjectLimitViolationsBySubjectId)).collect(Collectors.toList());
 
-        List<PreContingencyLimitViolationEntity> preContingencyLimitViolations = PreContingencyLimitViolationEntity.toEntityList(securityAnalysisResult.getPreContingencyResult(), subjectLimitViolationsBySubjectId);
+        List<PreContingencyLimitViolationEntity> preContingencyLimitViolations = PreContingencyLimitViolationEntity.toEntityList(network, securityAnalysisResult.getPreContingencyResult(), subjectLimitViolationsBySubjectId);
 
         List<SubjectLimitViolationEntity> subjectLimitViolations = Stream.concat(
                 contingencies.stream().flatMap(c -> c.getContingencyLimitViolations().stream()),