Merge pull request #35 from Breeding-Insight/feature/BI-2304

BI-2304 - Support Duplicate Germplasm in Lists Referencing Existing Germplasm

Author: mlm483

src/main/java/org/brapi/test/BrAPITestServer/model/entity/core/ListEntity.java

@@ -30,6 +30,7 @@ public class ListEntity extends BrAPIPrimaryEntity {
 	@ManyToOne(fetch = FetchType.LAZY)
 	private PersonEntity listOwnerPerson;
 	@OneToMany(mappedBy="list", cascade = CascadeType.ALL)
+	@OrderColumn(name = "position")
 	private List<ListItemEntity> data;
 
 	public PersonEntity getListOwnerPerson() {

src/main/java/org/brapi/test/BrAPITestServer/model/entity/core/ListItemEntity.java

@@ -11,6 +11,8 @@ public class ListItemEntity extends BrAPIBaseEntity {
 	private ListEntity list;
 	@Column
 	private String item;
+	@Column
+	private Integer position;
 
 	public ListEntity getList() {
 		return list;
@@ -24,6 +26,10 @@ public String getItem() {
 	public void setItem(String item) {
 		this.item = item;
 	}
-	
-	
+	public Integer getPosition() {
+		return position;
+	}
+	public void setPosition(Integer position) {
+		this.position = position;
+	}
 }

src/main/java/org/brapi/test/BrAPITestServer/service/core/ListService.java

@@ -1,9 +1,6 @@
 package org.brapi.test.BrAPITestServer.service.core;
 
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
-import java.util.Optional;
+import java.util.*;
 import java.util.stream.Collectors;
 
 import jakarta.validation.Valid;
@@ -237,12 +234,19 @@ private void updateEntity(ListEntity entity, @Valid ListNewRequest list) throws
 		}
 
 		if (list.getData() != null) {
-			entity.setData(list.getData().stream().map((item) -> {
-				ListItemEntity itemEntity = new ListItemEntity();
-				itemEntity.setItem(item);
-				itemEntity.setList(entity);
-				return itemEntity;
-			}).collect(Collectors.toList()));
+			List<ListItemEntity> items = new ArrayList<>();
+			ListIterator<String> iter = list.getData().listIterator();
+			while (iter.hasNext()) {
+				String item = iter.next();
+				if (item != null) {
+					ListItemEntity itemEntity = new ListItemEntity();
+					itemEntity.setPosition(iter.nextIndex());
+					itemEntity.setItem(item);
+					itemEntity.setList(entity);
+					items.add(itemEntity);
+				}
+			}
+			entity.setData(items);
 		} else {
 			entity.setData(new ArrayList<>());
 		}

src/main/resources/db/migration/V002.001__update_list_positions.sql

@@ -0,0 +1,68 @@
+
+-- This migration updates existing list_item records based on DeltaBreed (Breeding Insight) specific fields.
+--
+-- These are the list types, the BJTS uses Java enums and stores ints in the database.
+-- 0: germplasm
+-- 1: markers
+-- 2: programs
+-- 3: trials
+-- 4: studies
+-- 5: observationUnits
+-- 6: observations
+-- 7: observationVariables
+-- 8: samples
+
+DO
+$$
+BEGIN
+    -- Update germplasm list items, the goal is to use the order defined by the listEntryNumbers.
+    UPDATE
+        list_item
+    SET
+        position = subquery.position
+    FROM
+        (
+            SELECT
+                -- Subtract 1 from row_number to get zero indexing.
+                row_number() OVER (PARTITION BY li.list_id ORDER BY (g.additional_info->'listEntryNumbers'->>xr.external_reference_id)::int) - 1 AS position,
+                li.id AS list_item_id
+            FROM
+                list_item li
+                    JOIN list l ON li.list_id = l.id
+                    JOIN list_external_references ler ON l.id = ler.list_entity_id
+                    JOIN external_reference xr ON xr.id = ler.external_references_id AND xr.external_reference_source = 'breedinginsight.org/lists'
+                    JOIN germplasm g ON li.item = g.germplasm_name
+            WHERE
+                l.list_type = 0  -- 0 is germplasm
+            ORDER BY
+                l.id
+        ) AS subquery
+    WHERE
+        list_item.id = subquery.list_item_id
+    ;
+
+    -- Update all non-germplasm list items. There is no existing order to preserve, assign sequential position values arbitrarily.
+    UPDATE
+        list_item
+    SET
+        position = subquery.position
+    FROM
+        (
+            SELECT
+                -- Subtract 1 from row_number to get zero indexing.
+                row_number() OVER (PARTITION BY li.list_id) - 1 AS position,
+                li.id AS list_item_id
+            FROM
+                list_item li
+                JOIN list l ON li.list_id = l.id
+            WHERE
+                l.list_type != 0  -- 0 is germplasm, here we are addressing non-germplasm lists.
+            ORDER BY
+                l.id
+        ) AS subquery
+    WHERE
+        list_item.id = subquery.list_item_id
+    ;
+
+END;
+$$;

src/main/resources/db/migration/V002__add_list_position.sql

@@ -0,0 +1,9 @@
+-- This migration adds a position field to list_item so that lists can be explicitly ordered.
+
+-- Add position to list_item.
+ALTER TABLE list_item
+ADD COLUMN position INT NOT NULL DEFAULT 0;
+-- Add an index on the position column
+CREATE INDEX idx_list_item_position ON list_item(position);
+-- Add a composite index on list_id and position for better performance when querying items within a specific list
+CREATE INDEX idx_list_item_list_position ON list_item(list_id, position);