#266 - Change validation information

- rename TermCodeValidation to StructuredQueryValidation - remove ValidationIssues and directly use List<ValidationIssue>
medizininformatik-initiative · Mar 21, 2024 · 1ab2fd0 · 1ab2fd0
1 parent 9368876
commit 1ab2fd0
Show file tree

Hide file tree

Showing 14 changed files with 64 additions and 80 deletions.
diff --git a/src/main/java/de/numcodex/feasibility_gui_backend/common/api/Criterion.java b/src/main/java/de/numcodex/feasibility_gui_backend/common/api/Criterion.java
@@ -6,7 +6,7 @@
 import de.numcodex.feasibility_gui_backend.query.api.AttributeFilter;
 import de.numcodex.feasibility_gui_backend.query.api.TimeRestriction;
 import de.numcodex.feasibility_gui_backend.query.api.ValueFilter;
-import de.numcodex.feasibility_gui_backend.query.api.status.ValidationIssues;
+import de.numcodex.feasibility_gui_backend.query.api.status.ValidationIssue;
 import lombok.Builder;
 
 import java.util.List;
@@ -19,7 +19,7 @@ public record Criterion (
     @JsonProperty("attributeFilters") List<AttributeFilter> attributeFilters,
     @JsonProperty("valueFilter") ValueFilter valueFilter,
     @JsonProperty("timeRestriction") TimeRestriction timeRestriction,
-    @JsonProperty("issues") ValidationIssues validationIssues
+    @JsonProperty("issues") List<ValidationIssue> validationIssues
 ) {
   public static Criterion createImmutableCriterion(MutableCriterion mutableCriterion) {
     return Criterion.builder()

diff --git a/src/main/java/de/numcodex/feasibility_gui_backend/common/api/MutableCriterion.java b/src/main/java/de/numcodex/feasibility_gui_backend/common/api/MutableCriterion.java
@@ -6,7 +6,7 @@
 import de.numcodex.feasibility_gui_backend.query.api.AttributeFilter;
 import de.numcodex.feasibility_gui_backend.query.api.TimeRestriction;
 import de.numcodex.feasibility_gui_backend.query.api.ValueFilter;
-import de.numcodex.feasibility_gui_backend.query.api.status.ValidationIssues;
+import de.numcodex.feasibility_gui_backend.query.api.status.ValidationIssue;
 import lombok.Builder;
 import lombok.Data;
 
@@ -21,7 +21,7 @@ public class MutableCriterion {
     @JsonProperty("attributeFilters") List<AttributeFilter> attributeFilters;
     @JsonProperty("valueFilter") ValueFilter valueFilter;
     @JsonProperty("timeRestriction") TimeRestriction timeRestriction;
-    @JsonProperty("issues") ValidationIssues validationIssues;
+    @JsonProperty("issues") List<ValidationIssue> validationIssues;
 
     public static MutableCriterion createMutableCriterion (Criterion criterion) {
       return MutableCriterion.builder()

diff --git a/src/main/java/de/numcodex/feasibility_gui_backend/query/QueryHandlerService.java b/src/main/java/de/numcodex/feasibility_gui_backend/query/QueryHandlerService.java
@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import de.numcodex.feasibility_gui_backend.common.api.Criterion;
 import de.numcodex.feasibility_gui_backend.query.api.Query;
 import de.numcodex.feasibility_gui_backend.query.api.QueryTemplate;
 import de.numcodex.feasibility_gui_backend.query.api.SavedQuery;
@@ -15,7 +14,7 @@
 import de.numcodex.feasibility_gui_backend.query.result.ResultService;
 import de.numcodex.feasibility_gui_backend.query.templates.QueryTemplateException;
 import de.numcodex.feasibility_gui_backend.query.templates.QueryTemplateHandler;
-import de.numcodex.feasibility_gui_backend.terminology.validation.TermCodeValidation;
+import de.numcodex.feasibility_gui_backend.terminology.validation.StructuredQueryValidation;
 import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
 import org.springframework.dao.DataIntegrityViolationException;
@@ -61,7 +60,7 @@ public enum ResultDetail {
     private final SavedQueryRepository savedQueryRepository;
 
     @NonNull
-    private final TermCodeValidation termCodeValidation;
+    private final StructuredQueryValidation structuredQueryValidation;
 
     @NonNull
     private ObjectMapper jsonUtil;
@@ -246,7 +245,7 @@ public QueryListEntry convertQueryToQueryListEntry(de.numcodex.feasibility_gui_b
         if (!skipValidation) {
             try {
                 var sq = jsonUtil.readValue(query.getQueryContent().getQueryContent(), StructuredQuery.class);
-                isValid = termCodeValidation.isValid(sq);
+                isValid = structuredQueryValidation.isValid(sq);
             } catch (JsonProcessingException e) {
                 isValid = false;
             }

diff --git a/src/main/java/de/numcodex/feasibility_gui_backend/query/api/status/ValidationIssues.java b/src/main/java/de/numcodex/feasibility_gui_backend/query/api/status/ValidationIssues.java
diff --git a/src/main/java/de/numcodex/feasibility_gui_backend/query/v3/QueryHandlerRestController.java b/src/main/java/de/numcodex/feasibility_gui_backend/query/v3/QueryHandlerRestController.java
@@ -14,7 +14,7 @@
 import de.numcodex.feasibility_gui_backend.query.ratelimiting.AuthenticationHelper;
 import de.numcodex.feasibility_gui_backend.query.ratelimiting.InvalidAuthenticationException;
 import de.numcodex.feasibility_gui_backend.query.ratelimiting.RateLimitingService;
-import de.numcodex.feasibility_gui_backend.terminology.validation.TermCodeValidation;
+import de.numcodex.feasibility_gui_backend.terminology.validation.StructuredQueryValidation;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.validation.Valid;
 import jakarta.ws.rs.core.Context;
@@ -48,7 +48,7 @@ public class QueryHandlerRestController {
 
   public static final String HEADER_X_DETAILED_OBFUSCATED_RESULT_WAS_EMPTY = "X-Detailed-Obfuscated-Result-Was-Empty";
   private final QueryHandlerService queryHandlerService;
-  private final TermCodeValidation termCodeValidation;
+  private final StructuredQueryValidation structuredQueryValidation;
   private final RateLimitingService rateLimitingService;
   private final UserBlacklistRepository userBlacklistRepository;
   private final AuthenticationHelper authenticationHelper;
@@ -85,13 +85,13 @@ public class QueryHandlerRestController {
 
   public QueryHandlerRestController(QueryHandlerService queryHandlerService,
       RateLimitingService rateLimitingService,
-      TermCodeValidation termCodeValidation,
+      StructuredQueryValidation structuredQueryValidation,
       UserBlacklistRepository userBlacklistRepository,
       AuthenticationHelper authenticationHelper,
       @Value("${app.apiBaseUrl}") String apiBaseUrl) {
     this.queryHandlerService = queryHandlerService;
     this.rateLimitingService = rateLimitingService;
-    this.termCodeValidation = termCodeValidation;
+    this.structuredQueryValidation = structuredQueryValidation;
     this.userBlacklistRepository = userBlacklistRepository;
     this.authenticationHelper = authenticationHelper;
     this.apiBaseUrl = apiBaseUrl;
@@ -303,7 +303,7 @@ public ResponseEntity<Object> getQuery(@PathVariable("id") Long queryId,
     var query = queryHandlerService.getQuery(queryId);
     var annotatedQuery = Query.builder()
             .id(query.id())
-            .content(termCodeValidation.annotateStructuredQuery(query.content()))
+            .content(structuredQueryValidation.annotateStructuredQuery(query.content()))
             .label(query.label())
             .comment(query.comment())
             .build();
@@ -398,7 +398,7 @@ public ResponseEntity<Object> getQueryContent(
   @PostMapping("/validate")
   public ResponseEntity<StructuredQuery> validateStructuredQuery(
       @Valid @RequestBody StructuredQuery query) {
-    return new ResponseEntity<>(termCodeValidation.annotateStructuredQuery(query), HttpStatus.OK);
+    return new ResponseEntity<>(structuredQueryValidation.annotateStructuredQuery(query), HttpStatus.OK);
   }
 
   private boolean hasAccess(Long queryId, Authentication authentication) {

diff --git a/...java/de/numcodex/feasibility_gui_backend/query/v3/QueryTemplateHandlerRestController.java b/...java/de/numcodex/feasibility_gui_backend/query/v3/QueryTemplateHandlerRestController.java
@@ -1,15 +1,14 @@
 package de.numcodex.feasibility_gui_backend.query.v3;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
-import de.numcodex.feasibility_gui_backend.common.api.Criterion;
-import de.numcodex.feasibility_gui_backend.common.api.TermCode;
 import de.numcodex.feasibility_gui_backend.query.QueryHandlerService;
 import de.numcodex.feasibility_gui_backend.query.api.QueryTemplate;
 import de.numcodex.feasibility_gui_backend.query.templates.QueryTemplateException;
-import de.numcodex.feasibility_gui_backend.terminology.validation.TermCodeValidation;
+import de.numcodex.feasibility_gui_backend.terminology.validation.StructuredQueryValidation;
+
 import java.security.Principal;
 import java.util.ArrayList;
-import java.util.List;
+
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.validation.Valid;
 import jakarta.ws.rs.core.Context;
@@ -33,13 +32,13 @@
 public class QueryTemplateHandlerRestController {
 
   private final QueryHandlerService queryHandlerService;
-  private final TermCodeValidation termCodeValidation;
+  private final StructuredQueryValidation structuredQueryValidation;
   private final String apiBaseUrl;
 
   public QueryTemplateHandlerRestController(QueryHandlerService queryHandlerService,
-      TermCodeValidation termCodeValidation, @Value("${app.apiBaseUrl}") String apiBaseUrl) {
+                                            StructuredQueryValidation structuredQueryValidation, @Value("${app.apiBaseUrl}") String apiBaseUrl) {
     this.queryHandlerService = queryHandlerService;
-    this.termCodeValidation = termCodeValidation;
+    this.structuredQueryValidation = structuredQueryValidation;
     this.apiBaseUrl = apiBaseUrl;
   }
 
@@ -79,7 +78,7 @@ public ResponseEntity<Object> getQueryTemplate(@PathVariable(value = "queryId")
       var queryTemplate = queryHandlerService.convertTemplatePersistenceToApi(query);
       var queryTemplateWithInvalidCritiera = QueryTemplate.builder()
               .id(queryTemplate.id())
-              .content(termCodeValidation.annotateStructuredQuery(queryTemplate.content()))
+              .content(structuredQueryValidation.annotateStructuredQuery(queryTemplate.content()))
               .label(queryTemplate.label())
               .comment(queryTemplate.comment())
               .lastModified(queryTemplate.lastModified())
@@ -122,7 +121,7 @@ public ResponseEntity<Object> getQueryTemplates(
                   .comment(convertedQuery.comment())
                   .lastModified(convertedQuery.lastModified())
                   .createdBy(convertedQuery.createdBy())
-                  .isValid(termCodeValidation.isValid(convertedQuery.content()))
+                  .isValid(structuredQueryValidation.isValid(convertedQuery.content()))
                   .build()
           );
         }

diff --git a/...nology/validation/TermCodeValidation.java → ...validation/StructuredQueryValidation.java b/...nology/validation/TermCodeValidation.java → ...validation/StructuredQueryValidation.java
@@ -6,7 +6,6 @@
 import de.numcodex.feasibility_gui_backend.query.api.MutableStructuredQuery;
 import de.numcodex.feasibility_gui_backend.query.api.StructuredQuery;
 import de.numcodex.feasibility_gui_backend.query.api.status.ValidationIssue;
-import de.numcodex.feasibility_gui_backend.query.api.status.ValidationIssues;
 import de.numcodex.feasibility_gui_backend.terminology.TerminologyService;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -18,12 +17,12 @@
 
 @Service
 @Slf4j
-public class TermCodeValidation {
+public class StructuredQueryValidation {
 
   private final TerminologyService terminologyService;
 
   @Autowired
-  public TermCodeValidation(TerminologyService terminologyService) {
+  public StructuredQueryValidation(TerminologyService terminologyService) {
     this.terminologyService = terminologyService;
   }
 
@@ -94,7 +93,7 @@ public StructuredQuery annotateStructuredQuery(StructuredQuery structuredQuery)
     for (List<MutableCriterion> inclusionCriteria : mutableStructuredQuery.getInclusionCriteria()) {
       for (MutableCriterion criterion : inclusionCriteria) {
         if (criterion.getContext() == null) {
-          criterion.setValidationIssues(new ValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID)));
+          criterion.setValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID));
           continue;
         }
         for (TermCode termCode : criterion.getTermCodes()) {
@@ -103,7 +102,7 @@ public StructuredQuery annotateStructuredQuery(StructuredQuery structuredQuery)
           } else {
             log.debug("termcode invalid: {} - {} - {}", termCode.system(), termCode.code(),
                 termCode.version());
-            criterion.setValidationIssues(new ValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID)));
+            criterion.setValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID));
           }
         }
       }
@@ -112,7 +111,7 @@ public StructuredQuery annotateStructuredQuery(StructuredQuery structuredQuery)
     for (List<MutableCriterion> exclusionCriteria : mutableStructuredQuery.getExclusionCriteria()) {
       for (MutableCriterion criterion : exclusionCriteria) {
         if (criterion.getContext() == null) {
-          criterion.setValidationIssues(new ValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID)));
+          criterion.setValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID));
           continue;
         }
         for (TermCode termCode : criterion.getTermCodes()) {
@@ -121,7 +120,7 @@ public StructuredQuery annotateStructuredQuery(StructuredQuery structuredQuery)
           } else {
             log.debug("termcode invalid: {} - {} - {}", termCode.system(), termCode.code(),
                 termCode.version());
-            criterion.setValidationIssues(new ValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID)));
+            criterion.setValidationIssues(List.of(ValidationIssue.TERMCODE_CONTEXT_COMBINATION_INVALID));
           }
         }
       }

diff --git a/src/test/java/de/numcodex/feasibility_gui_backend/query/QueryHandlerServiceIT.java b/src/test/java/de/numcodex/feasibility_gui_backend/query/QueryHandlerServiceIT.java
@@ -24,7 +24,7 @@
 import java.net.URI;
 import java.util.List;
 
-import de.numcodex.feasibility_gui_backend.terminology.validation.TermCodeValidation;
+import de.numcodex.feasibility_gui_backend.terminology.validation.StructuredQueryValidation;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
@@ -102,7 +102,7 @@ public class QueryHandlerServiceIT {
     private QueryHashCalculator queryHashCalculator;
 
     @MockBean
-    private TermCodeValidation termCodeValidation;
+    private StructuredQueryValidation structuredQueryValidation;
 
     @Autowired
     @Qualifier("translation")

diff --git a/src/test/java/de/numcodex/feasibility_gui_backend/query/QueryHandlerServiceTest.java b/src/test/java/de/numcodex/feasibility_gui_backend/query/QueryHandlerServiceTest.java
@@ -11,7 +11,7 @@
 import de.numcodex.feasibility_gui_backend.query.persistence.*;
 import de.numcodex.feasibility_gui_backend.query.result.ResultService;
 import de.numcodex.feasibility_gui_backend.query.templates.QueryTemplateHandler;
-import de.numcodex.feasibility_gui_backend.terminology.validation.TermCodeValidation;
+import de.numcodex.feasibility_gui_backend.terminology.validation.StructuredQueryValidation;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -70,13 +70,13 @@ class QueryHandlerServiceTest {
     private SavedQueryRepository savedQueryRepository;
 
     @Mock
-    private TermCodeValidation termCodeValidation;
+    private StructuredQueryValidation structuredQueryValidation;
 
     private QueryHandlerService queryHandlerService;
 
     private QueryHandlerService createQueryHandlerService() {
         return new QueryHandlerService(queryDispatcher, queryTemplateHandler, queryRepository, queryContentRepository,
-                resultService, queryTemplateRepository, savedQueryRepository, termCodeValidation, jsonUtil);
+                resultService, queryTemplateRepository, savedQueryRepository, structuredQueryValidation, jsonUtil);
     }
 
     @BeforeEach
@@ -114,7 +114,7 @@ void convertQueriesToQueryListEntries(String withSavedQuery, String skipValidati
         if (!Boolean.parseBoolean(skipValidation)) {
             doReturn(
                 List.of(createInvalidCriterion())
-            ).when(termCodeValidation).getInvalidCriteria(any(StructuredQuery.class));
+            ).when(structuredQueryValidation).getInvalidCriteria(any(StructuredQuery.class));
         }
 
         List<QueryListEntry> queryListEntries = queryHandlerService.convertQueriesToQueryListEntries(queryList, Boolean.parseBoolean(skipValidation));

diff --git a/...ava/de/numcodex/feasibility_gui_backend/query/ratelimiting/RateLimitingInterceptorIT.java b/...ava/de/numcodex/feasibility_gui_backend/query/ratelimiting/RateLimitingInterceptorIT.java
@@ -19,7 +19,8 @@
 import de.numcodex.feasibility_gui_backend.query.persistence.UserBlacklistRepository;
 import de.numcodex.feasibility_gui_backend.query.result.ResultLine;
 import de.numcodex.feasibility_gui_backend.query.v3.QueryHandlerRestController;
-import de.numcodex.feasibility_gui_backend.terminology.validation.TermCodeValidation;
+import de.numcodex.feasibility_gui_backend.terminology.validation.StructuredQueryValidation;
+
 import java.net.URI;
 import java.util.List;
 import java.util.UUID;
@@ -64,7 +65,7 @@ public class RateLimitingInterceptorIT {
   private QueryHandlerService queryHandlerService;
 
   @MockBean
-  private TermCodeValidation termCodeValidation;
+  private StructuredQueryValidation structuredQueryValidation;
 
   @MockBean
   AuthenticationHelper authenticationHelper;