use specification system from ws-commons (#137)

Signed-off-by: Mathieu DEHARBE <[email protected]>

Author: Mathieu-Deharbe

pom.xml

@@ -47,6 +47,7 @@
         <db-util.version>1.0.5</db-util.version>
         <sonar.organization>gridsuite</sonar.organization>
         <sonar.projectKey>org.gridsuite:shortcircuit-analysis-server</sonar.projectKey>
+        <powsybl-ws-commons.version>1.25.0</powsybl-ws-commons.version><!-- should be removed once gridsuite-dependencies is upgraded-->
     </properties>
 
     <build>
@@ -128,6 +129,7 @@
         <dependency>
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-ws-commons</artifactId>
+            <version>${powsybl-ws-commons.version}</version>
         </dependency>
         <dependency>
             <groupId>org.springframework.cloud</groupId>

src/main/java/org/gridsuite/shortcircuit/server/ShortCircuitController.java

@@ -6,7 +6,6 @@
  */
 package org.gridsuite.shortcircuit.server;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.powsybl.iidm.network.ThreeSides;
 import com.powsybl.security.LimitViolationType;
 import io.swagger.v3.oas.annotations.Operation;
@@ -94,9 +93,8 @@ public ResponseEntity<Page<FaultResult>> getPagedFaultResults(@Parameter(descrip
                                                                       "WITH_LIMIT_VIOLATIONS (like FULL but only those with limit violations) or " +
                                                                       "NONE (no fault)") @RequestParam(name = "mode", required = false, defaultValue = "FULL") FaultResultsMode mode,
                                                                   @Parameter(description = "Filters") @RequestParam(name = "filters", required = false) String stringFilters,
-                                                                  Pageable pageable) throws JsonProcessingException {
-        List<ResourceFilter> resourceFilters = ResourceFilter.fromStringToList(stringFilters);
-        Page<FaultResult> faultResultsPage = shortCircuitService.getFaultResultsPage(resultUuid, mode, resourceFilters, pageable);
+                                                                  Pageable pageable) {
+        Page<FaultResult> faultResultsPage = shortCircuitService.getFaultResultsPage(resultUuid, mode, stringFilters, pageable);
         return faultResultsPage != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(faultResultsPage)
             : ResponseEntity.notFound().build();
     }
@@ -107,9 +105,8 @@ public ResponseEntity<Page<FaultResult>> getPagedFaultResults(@Parameter(descrip
         @ApiResponse(responseCode = "404", description = "Short circuit analysis result has not been found")})
     public ResponseEntity<Page<FeederResult>> getPagedFeederResults(@Parameter(description = "Result UUID") @PathVariable("resultUuid") UUID resultUuid,
                                                                     @Parameter(description = "Filters") @RequestParam(name = "filters", required = false) String stringFilters,
-                                                                    Pageable pageable) throws JsonProcessingException {
-        List<ResourceFilter> resourceFilters = ResourceFilter.fromStringToList(stringFilters);
-        Page<FeederResult> feederResultsPage = shortCircuitService.getFeederResultsPage(resultUuid, resourceFilters, pageable);
+                                                                    Pageable pageable) {
+        Page<FeederResult> feederResultsPage = shortCircuitService.getFeederResultsPage(resultUuid, stringFilters, pageable);
         return feederResultsPage != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(feederResultsPage)
             : ResponseEntity.notFound().build();
     }

src/main/java/org/gridsuite/shortcircuit/server/dto/ResourceFilter.java

@@ -7,50 +7,45 @@
 
 package org.gridsuite.shortcircuit.server.repositories.specifications;
 
+import com.powsybl.ws.commons.computation.dto.ResourceFilterDTO;
+import com.powsybl.ws.commons.computation.specification.AbstractCommonSpecificationBuilder;
+import com.powsybl.ws.commons.computation.utils.SpecificationUtils;
 import jakarta.persistence.criteria.Path;
 import jakarta.persistence.criteria.Root;
-import org.gridsuite.shortcircuit.server.dto.ResourceFilter;
 import org.gridsuite.shortcircuit.server.entities.FaultResultEntity;
 import org.gridsuite.shortcircuit.server.entities.FeederResultEntity;
 import org.gridsuite.shortcircuit.server.entities.ShortCircuitAnalysisResultEntity;
 import org.springframework.data.jpa.domain.Specification;
+import org.springframework.stereotype.Service;
 
 import java.util.List;
 import java.util.UUID;
 
 /**
  * @author Florent MILLOT <[email protected]>
  */
-public final class FaultResultSpecificationBuilder {
+@Service
+public final class FaultResultSpecificationBuilder extends AbstractCommonSpecificationBuilder<FaultResultEntity> {
 
-    // Utility class, so no constructor
-    private FaultResultSpecificationBuilder() { }
-
-    public static boolean isNotParentFilter(ResourceFilter filter) {
+    @Override
+    public boolean isNotParentFilter(ResourceFilterDTO filter) {
         return filter.column().contains(FeederResultEntity.Fields.connectableId);
     }
 
-    public static Specification<FaultResultEntity> uuidIn(List<UUID> uuids) {
-        return (root, cq, cb) -> root.get(getIdFieldName()).in(uuids);
-    }
-
-    public static Specification<FaultResultEntity> resultUuidEquals(UUID value) {
-        return (root, cq, cb) -> cb.equal(getResultIdPath(root), value);
-    }
-
-    public static String getIdFieldName() {
+    public String getIdFieldName() {
         return FaultResultEntity.Fields.faultResultUuid;
     }
 
-    public static Path<UUID> getResultIdPath(Root<FaultResultEntity> root) {
+    public Path<UUID> getResultIdPath(Root<FaultResultEntity> root) {
         return root.get(FaultResultEntity.Fields.result).get(ShortCircuitAnalysisResultEntity.Fields.resultUuid);
     }
 
-    public static Specification<FaultResultEntity> appendWithLimitViolationsToSpecification(Specification<FaultResultEntity> specification) {
+    public Specification<FaultResultEntity> appendWithLimitViolationsToSpecification(Specification<FaultResultEntity> specification) {
         return specification.and(SpecificationUtils.isNotEmpty(FaultResultEntity.Fields.limitViolations));
     }
 
-    public static Specification<FaultResultEntity> buildSpecification(UUID resultUuid, List<ResourceFilter> resourceFilters) {
+    @Override
+    public Specification<FaultResultEntity> buildSpecification(UUID resultUuid, List<ResourceFilterDTO> resourceFilters) {
         // since sql joins generates duplicate results, we need to use distinct here
         Specification<FaultResultEntity> specification = SpecificationUtils.distinct();
         // filter by resultUuid
@@ -59,8 +54,8 @@ public static Specification<FaultResultEntity> buildSpecification(UUID resultUui
         return SpecificationUtils.appendFiltersToSpecification(specification, resourceFilters);
     }
 
-    public static Specification<FaultResultEntity> buildFeedersSpecification(List<UUID> uuids, List<ResourceFilter> resourceFilters) {
-        List<ResourceFilter> childrenResourceFilter = resourceFilters.stream().filter(FaultResultSpecificationBuilder::isNotParentFilter)
+    public Specification<FaultResultEntity> buildFeedersSpecification(List<UUID> uuids, List<ResourceFilterDTO> resourceFilters) {
+        List<ResourceFilterDTO> childrenResourceFilter = resourceFilters.stream().filter(this::isNotParentFilter)
                 .toList();
         Specification<FaultResultEntity> specification = Specification.where(uuidIn(uuids));
 

src/main/java/org/gridsuite/shortcircuit/server/repositories/specifications/FaultResultSpecificationBuilder.java

@@ -7,7 +7,8 @@
 
 package org.gridsuite.shortcircuit.server.repositories.specifications;
 
-import org.gridsuite.shortcircuit.server.dto.ResourceFilter;
+import com.powsybl.ws.commons.computation.dto.ResourceFilterDTO;
+import com.powsybl.ws.commons.computation.utils.SpecificationUtils;
 import org.gridsuite.shortcircuit.server.entities.FeederResultEntity;
 import org.springframework.data.jpa.domain.Specification;
 
@@ -27,7 +28,7 @@ public static Specification<FeederResultEntity> resultUuidEquals(UUID value) {
         return (feederResult, cq, cb) -> cb.equal(feederResult.get("faultResult").get("result").get("resultUuid"), value);
     }
 
-    public static Specification<FeederResultEntity> buildSpecification(UUID resultUuid, List<ResourceFilter> resourceFilters) {
+    public static Specification<FeederResultEntity> buildSpecification(UUID resultUuid, List<ResourceFilterDTO> resourceFilters) {
         Specification<FeederResultEntity> specification = Specification.where(resultUuidEquals(resultUuid));
         return SpecificationUtils.appendFiltersToSpecification(specification, resourceFilters);
     }