Preserve variable level ordering and unit (#1187)

* Switch from set of variable levels to list of variable levels

Level ordering holds information and must not be discarded. As sets are unordered the api objects changed from an unordered set to an ordered list.

* Fix unit discarding

Switches wrong if condition. Previously a unit of null was assigned always and provided units discarded. This was flipped.

* Replace if-else with Optional methods

---------

Co-authored-by: KochTobi <[email protected]>

Author: KochTobi

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectService.java

@@ -669,19 +669,19 @@ Mono<ProjectCreationResponse> create(ProjectCreationRequest request)
    * @param unit   the unit of the experimental variable. Can be null if no unit is set
    * @since 1.9.0
    */
-  record ExperimentalVariable(String name, Set<String> levels, @Nullable String unit) {
+  record ExperimentalVariable(String name, List<String> levels, @Nullable String unit) {
 
-    public ExperimentalVariable(String name, Set<String> levels) {
+    public ExperimentalVariable(String name, List<String> levels) {
       this(name, levels, null);
     }
 
     public ExperimentalVariable {
-      levels = Set.copyOf(levels);
+      levels = List.copyOf(levels);
     }
 
     @Override
-    public Set<String> levels() {
-      return Set.copyOf(levels);
+    public List<String> levels() {
+      return List.copyOf(levels);
     }
 
     public Optional<String> optionalUnit() {
@@ -716,15 +716,15 @@ record VariableLevel(String variableName, String levelValue,
    */
   record ExperimentalGroup(@Nullable Long id, @Nullable Integer groupId, String name,
                            int sampleSize,
-                           Set<VariableLevel> levels) {
+                           List<VariableLevel> levels) {
 
     public ExperimentalGroup {
       requireNonNull(levels);
-      levels = Set.copyOf(levels);
+      levels = List.copyOf(levels);
     }
 
-    public Set<VariableLevel> levels() {
-      return Set.copyOf(levels);
+    public List<VariableLevel> levels() {
+      return List.copyOf(levels);
     }
   }
 

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectServiceImpl.java

@@ -159,8 +159,9 @@ public Mono<ExperimentalGroupCreationResponse> create(ExperimentalGroupCreationR
           new ExperimentalGroup(createdGroup.id(), createdGroup.groupNumber(), createdGroup.name(),
               createdGroup.replicateCount(), createdGroup.levels().stream()
               .map(this::convertLevelToApi)
-              .collect(Collectors.toSet())), request.requestId());
+              .toList()), request.requestId());
     });
+
     return applySecurityContext(call)
         .subscribeOn(VirtualThreadScheduler.getScheduler())
         .contextWrite(reactiveSecurity(SecurityContextHolder.getContext()))
@@ -238,8 +239,9 @@ public Flux<ExperimentalGroup> getExperimentalGroups(String projectId, String ex
   }
 
   private static ExperimentalGroup convertToApi(ExperimentInformationService.ExperimentalGroup group) {
-    return new ExperimentalGroup(group.id(), group.groupNumber(), group.name(), group.replicateCount(),
-        group.levels().stream().map(AsyncProjectServiceImpl::convertToApi).collect(Collectors.toSet()));
+    return new ExperimentalGroup(group.id(), group.groupNumber(), group.name(),
+        group.replicateCount(),
+        group.levels().stream().map(AsyncProjectServiceImpl::convertToApi).toList());
   }
 
   private static VariableLevel convertToApi(ExperimentInformationService.VariableLevel level) {
@@ -775,8 +777,7 @@ private ExperimentalVariable convertToApi(
       life.qbic.projectmanagement.domain.model.experiment.ExperimentalVariable experimentalVariable) {
     return new ExperimentalVariable(experimentalVariable.name().value(),
         experimentalVariable.levels()
-            .stream().map(level -> level.variableName().value()).collect(
-                Collectors.toSet()),
+            .stream().map(level -> level.variableName().value()).toList(),
         experimentalVariable.levels().getFirst().experimentalValue().unit().orElse(null));
   }
 

project-management/src/main/java/life/qbic/projectmanagement/application/experiment/ExperimentInformationService.java

@@ -422,8 +422,10 @@ public void addVariableToExperiment(String projectId, String experimentId, List<
     for (AsyncProjectService.ExperimentalVariable experimentalVariable : experimentalVariables) {
       List<ExperimentalValue> experimentalValues = new ArrayList<>();
       for (String level : experimentalVariable.levels()) {
-        ExperimentalValue experimentalValue = experimentalVariable.optionalUnit().isPresent() ? ExperimentalValue.create(level)
-            : ExperimentalValue.create(level, experimentalVariable.unit());
+        ExperimentalValue experimentalValue =
+            experimentalVariable.optionalUnit()
+                .map(unit -> ExperimentalValue.create(level, unit))
+                .orElse(ExperimentalValue.create(level));
         experimentalValues.add(experimentalValue);
       }
       experiment.addVariableToDesign(experimentalVariable.name(), experimentalValues);

user-interface/src/main/java/life/qbic/datamanager/views/projects/project/experiments/experiment/ExperimentDetailsComponent.java

@@ -30,7 +30,6 @@
 import java.util.Collection;
 import java.util.Comparator;
 import java.util.EnumMap;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -545,7 +544,7 @@ private void onExperimentalVariablesAddConfirmed(
   private AsyncProjectService.ExperimentalVariable convertToApi(
       ExperimentalVariableContent experimentalVariable) {
     return new AsyncProjectService.ExperimentalVariable(experimentalVariable.name(),
-        new HashSet<>(experimentalVariable.levels()), experimentalVariable.unit());
+        new ArrayList<>(experimentalVariable.levels()), experimentalVariable.unit());
   }
 
   private void openExperimentalVariablesEditDialog() {
@@ -887,7 +886,7 @@ private AsyncProjectService.ExperimentalGroup toApi(ExperimentalGroupContent exp
     return new AsyncProjectService.ExperimentalGroup(experimentalGroup.id(),
         experimentalGroup.groupNumber(),
         experimentalGroup.name(), experimentalGroup.size(),
-        experimentalGroup.variableLevels().stream().map(this::toApi).collect(Collectors.toSet()));
+        experimentalGroup.variableLevels().stream().map(this::toApi).toList());
   }
 
   private void addExperimentalGroups(

user-interface/src/main/java/life/qbic/datamanager/views/projects/project/experiments/experiment/components/ExperimentalVariableRowLayout.java

@@ -35,7 +35,7 @@ static ExperimentalVariableRowLayout from(
     final ExperimentalVariableRowLayout rowLayout = new ExperimentalVariableRowLayout();
     rowLayout.nameField.setValue(experimentalVariable.name().value());
     rowLayout.unitField.setValue(
-        experimentalVariable.levels().get(0).experimentalValue().unit().orElse(""));
+        experimentalVariable.levels().getFirst().experimentalValue().unit().orElse(""));
     rowLayout.levelArea.setValue(
         experimentalVariable.levels().stream().map(it -> it.experimentalValue().value())
             .collect(Collectors.joining("\n")));