[BI-3082] Implement generalized list item search endpoint, targeting DeltaBreed germplasm use case

src/main/java/io/swagger/api/core/ListsApi.java

@@ -5,13 +5,10 @@
  */
 package io.swagger.api.core;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import io.swagger.model.BrAPIResponse;
 import io.swagger.model.Model202AcceptedSearchResponse;
-import io.swagger.model.core.ListNewRequest;
-import io.swagger.model.core.ListResponse;
-import io.swagger.model.core.ListSearchRequest;
-import io.swagger.model.core.ListsListResponse;
-import io.swagger.model.core.ListsSingleResponse;
+import io.swagger.model.core.*;
 import io.swagger.annotations.*;
 
 import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
@@ -166,4 +163,15 @@ ResponseEntity<? extends BrAPIResponse> searchListsSearchResultsDbIdGet(
 			@ApiParam(value = "pageSize") @Valid @RequestParam(value = "pageSize", required = false) Integer pageSize,
 			@ApiParam(value = "HTTP HEADER - Token used for Authorization   <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization) throws BrAPIServerException;
 
+	@ApiOperation(value = "Submit a search request for List Items", nickname = "searchListByItemRequest", notes = "Advanced searching for the list item resource. See Search Services for additional implementation details.", response = ListItemsListResponse.class, authorizations = {
+			@Authorization(value = "AuthorizationToken") }, tags = { "Lists", })
+	@ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = ListItemsListResponse.class),
+			@ApiResponse(code = 400, message = "Bad Request", response = String.class),
+			@ApiResponse(code = 401, message = "Unauthorized", response = String.class),
+			@ApiResponse(code = 403, message = "Forbidden", response = String.class) })
+	@RequestMapping(value = "/search/lists/{listDbId}/items", produces = { "application/json" }, consumes = {
+			"application/json" }, method = RequestMethod.POST)
+	ResponseEntity<? extends BrAPIResponse> searchListByItemRequest(@ApiParam(value = "") @Valid @RequestBody JsonNode body,
+															@ApiParam(value = "Permanent unique identifier of list to perform search on", required = true) @PathVariable("listDbId") String listDbId,
+	                                                        @ApiParam(value = "HTTP HEADER - Token used for Authorization   <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization) throws BrAPIServerException;
 }

src/main/java/io/swagger/model/SearchRequest.java

@@ -4,7 +4,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.swagger.model.sort.SortBy;
 import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
-import org.brapi.test.BrAPITestServer.model.dto.EntityColumnNameAndType;
+import org.brapi.test.BrAPITestServer.model.dto.SortAndFilterEntityColumnInfo;
 import org.brapi.test.BrAPITestServer.model.dto.EntityType;
 import org.springframework.http.HttpStatus;
 
@@ -150,7 +150,7 @@ public void setFilterBy(List<FilterBy> filterBy) throws BrAPIServerException {
 			return;
 		}
 
-		Map<String, EntityColumnNameAndType> allowedSortFilterNames = getEntityColAndTypeBySubmittedNameMap();
+		Map<String, SortAndFilterEntityColumnInfo> allowedSortFilterNames = getEntityColInfoBySubmittedNameMap();
 
 		for (FilterBy filterByItem : filterBy) {
 
@@ -162,17 +162,17 @@ public void setFilterBy(List<FilterBy> filterBy) throws BrAPIServerException {
 				throw new BrAPIServerException(HttpStatus.BAD_REQUEST, "value attribute not provided in element of filterBy list.");
 			}
 
-			EntityColumnNameAndType entityColumnNameAndType = allowedSortFilterNames.get(filterByItem.getFilterOn());
+			SortAndFilterEntityColumnInfo sortAndFilterEntityColumnInfo = allowedSortFilterNames.get(filterByItem.getFilterOn());
 
-			if (entityColumnNameAndType == null) {
+			if (sortAndFilterEntityColumnInfo == null) {
 				throw new BrAPIServerException(HttpStatus.BAD_REQUEST,
 						String.format("Supplied filterColumn [%s] not available in allowed names [%s]", filterByItem.getFilterOn(), allowedSortFilterNames.keySet())
 				);
 			}
 
-			if (entityColumnNameAndType.getEntityType() == EntityType.BOOLEAN) {
+			if (sortAndFilterEntityColumnInfo.getEntityType() == EntityType.BOOLEAN) {
 				// TODO: Add support for this when it becomes relevant for BI or when there is time.
-				throw new BrAPIServerException(HttpStatus.BAD_REQUEST, String.format("Filtering not implemented for column name [%s] with associated data type [%s]", entityColumnNameAndType.getEntityColumnName(), EntityType.BOOLEAN));
+				throw new BrAPIServerException(HttpStatus.BAD_REQUEST, String.format("Filtering not implemented for column name [%s] with associated data type [%s]", sortAndFilterEntityColumnInfo.getEntityColumnName(), EntityType.BOOLEAN));
 			}
 		}
 		this.filterBy = filterBy;
@@ -188,14 +188,14 @@ public void setSortBy(List<SortBy> sortBy) throws BrAPIServerException {
 			return;
 		}
 
-		Map<String, EntityColumnNameAndType> allowedSortFilterNames = getEntityColAndTypeBySubmittedNameMap();
+		Map<String, SortAndFilterEntityColumnInfo> allowedSortFilterNames = getEntityColInfoBySubmittedNameMap();
 
 		for (SortBy sortByItem : sortBy) {
 			if (sortByItem.getSortedOn() == null || sortByItem.getSortedOn().isEmpty()) {
 				throw new BrAPIServerException(HttpStatus.BAD_REQUEST, "sortedOn attribute not provided in element of sortBy list");
 			}
 
-			EntityColumnNameAndType sortColumnEntityNameAndType = getEntityColAndTypeBySubmittedNameMap().get(sortByItem.getSortedOn());
+			SortAndFilterEntityColumnInfo sortColumnEntityNameAndType = getEntityColInfoBySubmittedNameMap().get(sortByItem.getSortedOn());
 
 			if (sortColumnEntityNameAndType == null) {
 				throw new BrAPIServerException(HttpStatus.BAD_REQUEST,
@@ -208,7 +208,7 @@ public void setSortBy(List<SortBy> sortBy) throws BrAPIServerException {
 	}
 
 	@JsonIgnore
-	public Map<String, EntityColumnNameAndType> getEntityColAndTypeBySubmittedNameMap() throws BrAPIServerException {
+	public Map<String, SortAndFilterEntityColumnInfo> getEntityColInfoBySubmittedNameMap() throws BrAPIServerException {
 		throw new BrAPIServerException(HttpStatus.BAD_REQUEST, String.format("Sort/Filtering not implemented for %s", this.getClass().getSimpleName()));
 	}
 }

src/main/java/io/swagger/model/core/GermplasmListSearchRequest.java

@@ -0,0 +1,33 @@
+package io.swagger.model.core;
+
+import io.swagger.model.germ.GermplasmSearchRequest;
+import org.brapi.test.BrAPITestServer.model.dto.SortAndFilterEntityColumnInfo;
+import org.brapi.test.BrAPITestServer.model.dto.EntityType;
+
+import java.util.Collections;
+import java.util.Map;
+
+public class GermplasmListSearchRequest extends GermplasmSearchRequest {
+
+    // The only real difference in this request is that there's an extra sort/filter field that GermplasmSearchRequest doesn't have.
+    // It is specific to lists. In general, other EntityListSearchRequests like this one should look the same, but have different base search requests.
+    private static final Map<String, SortAndFilterEntityColumnInfo>
+            LIST_ALLOWED_FIELDS;
+
+    static {
+        Map<String, SortAndFilterEntityColumnInfo> fields =
+                copyAllowedSortAndFilterFields();
+
+        fields.put(
+                "listItemPosition",
+                new SortAndFilterEntityColumnInfo("*listItem.positionIndexedBy1", EntityType.NUMBER, false, true)
+        );
+
+        LIST_ALLOWED_FIELDS = Collections.unmodifiableMap(fields);
+    }
+
+    @Override
+    public Map<String, SortAndFilterEntityColumnInfo> getEntityColInfoBySubmittedNameMap() {
+        return LIST_ALLOWED_FIELDS;
+    }
+}

src/main/java/io/swagger/model/core/ListItem.java

@@ -0,0 +1,95 @@
+package io.swagger.model.core;
+
+import java.util.Objects;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModelProperty;
+import org.springframework.validation.annotation.Validated;
+
+/**
+ * ListItem
+ */
+@Validated
+@javax.annotation.processing.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2020-03-20T16:31:52.030Z[GMT]")
+public class ListItem  {
+    @JsonProperty("listItemDbId")
+    private String listItemDbId = null;
+
+    @JsonProperty("position")
+    private Integer position = null;
+
+    // This represents the actual value stored in the list_item table
+    @JsonProperty("item")
+    private String item = null;
+
+    /**
+     * The unique identifier for a List
+     * @return listDbId
+     **/
+    @ApiModelProperty(example = "6f621cfa", required = true, value = "The unique identifier for a List")
+
+
+    public String getListItemDbId() {
+        return listItemDbId;
+    }
+
+    public void setListItemDbId(String listItemDbId) {
+        this.listItemDbId = listItemDbId;
+    }
+
+    public Integer getPosition() {
+        return position;
+    }
+
+    public void setPosition(Integer position) {
+        this.position = position;
+    }
+
+    public String getItem() {
+        return item;
+    }
+
+    public void setItem(String item) {
+        this.item = item;
+    }
+
+    @Override
+    public boolean equals(java.lang.Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        ListItem ListItem = (ListItem) o;
+        return Objects.equals(this.listItemDbId, ListItem.listItemDbId) &&
+                super.equals(o);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(listItemDbId, super.hashCode());
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("class ListItem {\n");
+        sb.append("    ").append(toIndentedString(super.toString())).append("\n");
+        sb.append("    listDbId: ").append(toIndentedString(listItemDbId)).append("\n");
+        sb.append("}");
+        return sb.toString();
+    }
+
+    /**
+     * Convert the given object to string with each line indented by 4 spaces
+     * (except the first line).
+     */
+    private String toIndentedString(java.lang.Object o) {
+        if (o == null) {
+            return "null";
+        }
+        return o.toString().replace("\n", "\n    ");
+    }
+}
+
+

src/main/java/io/swagger/model/core/ListItemWithFullItem.java

@@ -0,0 +1,83 @@
+package io.swagger.model.core;
+
+import java.util.Objects;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModelProperty;
+import org.springframework.validation.annotation.Validated;
+
+/**
+ * ListItemWithFullItem
+ */
+@Validated
+@javax.annotation.processing.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2020-03-20T16:31:52.030Z[GMT]")
+public class ListItemWithFullItem<T>  {
+    @JsonProperty("listItem")
+    private ListItem listItem = null;
+
+    // The full actual BrAPI model object of the list item is supplied/written into here
+    @JsonProperty("item")
+    private T item = null;
+
+    /**
+     * The unique identifier for a List
+     * @return listItem
+     **/
+    @ApiModelProperty(example = "6f621cfa", required = true, value = "The unique identifier for a List")
+
+
+    public ListItem getListItem() {
+        return listItem;
+    }
+
+    public void setListItem(ListItem listItem) {
+        this.listItem = listItem;
+    }
+
+    public T getItem() {
+        return item;
+    }
+
+    public void setItem(T item) {
+        this.item = item;
+    }
+
+    @Override
+    public boolean equals(java.lang.Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        ListItemWithFullItem<T> listItemWithFullItem = (ListItemWithFullItem<T>) o;
+        return Objects.equals(this.listItem, listItemWithFullItem.listItem) &&
+                super.equals(o);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(listItem, super.hashCode());
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("class ListItemWithFullItem {\n");
+        sb.append("    ").append(toIndentedString(super.toString())).append("\n");
+        sb.append("    listItem: ").append(toIndentedString(listItem)).append("\n");
+        sb.append("}");
+        return sb.toString();
+    }
+
+    /**
+     * Convert the given object to string with each line indented by 4 spaces
+     * (except the first line).
+     */
+    private String toIndentedString(java.lang.Object o) {
+        if (o == null) {
+            return "null";
+        }
+        return o.toString().replace("\n", "\n    ");
+    }
+}
+