Skip to content

Commit

Permalink
#543 added institution keys as search parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
marcos-lg committed Jan 15, 2024
1 parent a4b31f7 commit 3379614
Show file tree
Hide file tree
Showing 11 changed files with 193 additions and 87 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -449,31 +449,31 @@ public void listTest() {
.size());

assertEquals(
collection1.getKey(),
collectionService
.list(
CollectionSearchRequest.builder()
.sortBy(CollectionsSortField.NUMBER_SPECIMENS)
.page(DEFAULT_PAGE)
.build())
.getResults()
.get(0)
.getCollection()
.getKey());

assertEquals(
collection2.getKey(),
collectionService
.list(
CollectionSearchRequest.builder()
.sortBy(CollectionsSortField.NUMBER_SPECIMENS)
.sortOrder(SortOrder.DESC)
.page(DEFAULT_PAGE)
.build())
.getResults()
.get(0)
.getCollection()
.getKey());
collection1.getKey(),
collectionService
.list(
CollectionSearchRequest.builder()
.sortBy(CollectionsSortField.NUMBER_SPECIMENS)
.page(DEFAULT_PAGE)
.build())
.getResults()
.get(0)
.getCollection()
.getKey());

assertEquals(
collection2.getKey(),
collectionService
.list(
CollectionSearchRequest.builder()
.sortBy(CollectionsSortField.NUMBER_SPECIMENS)
.sortOrder(SortOrder.DESC)
.page(DEFAULT_PAGE)
.build())
.getResults()
.get(0)
.getCollection()
.getKey());

collectionService.delete(key2);
assertEquals(
Expand Down Expand Up @@ -532,6 +532,31 @@ public void listByInstitutionTest() {
.page(DEFAULT_PAGE)
.build());
assertEquals(0, response.getResults().size());

response =
collectionService.list(
CollectionSearchRequest.builder()
.institutionKeys(Collections.singletonList(institutionKey1))
.page(DEFAULT_PAGE)
.build());
assertEquals(2, response.getResults().size());

response =
collectionService.list(
CollectionSearchRequest.builder()
.institutionKeys(Arrays.asList(institutionKey1, institutionKey2))
.page(DEFAULT_PAGE)
.build());
assertEquals(3, response.getResults().size());

response =
collectionService.list(
CollectionSearchRequest.builder()
.query(collection1.getCode())
.institutionKeys(Arrays.asList(institutionKey1, institutionKey2))
.page(DEFAULT_PAGE)
.build());
assertEquals(1, response.getResults().size());
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import org.gbif.api.model.collections.Institution;
import org.gbif.api.model.collections.MasterSourceMetadata;
import org.gbif.api.model.collections.UserId;
import org.gbif.api.model.collections.request.CollectionSearchRequest;
import org.gbif.api.model.collections.request.InstitutionSearchRequest;
import org.gbif.api.model.common.paging.PagingRequest;
import org.gbif.api.model.common.paging.PagingResponse;
Expand Down Expand Up @@ -148,6 +147,30 @@ public void listTest() {
assertEquals(1, response.getResults().size());
assertEquals(key2, response.getResults().get(0).getKey());

// subset of institutions
assertEquals(
2,
institutionService
.list(
InstitutionSearchRequest.builder()
.institutionKeys(Arrays.asList(institution1.getKey(), institution2.getKey()))
.page(DEFAULT_PAGE)
.build())
.getResults()
.size());

assertEquals(
1,
institutionService
.list(
InstitutionSearchRequest.builder()
.query(institution1.getCode())
.institutionKeys(Arrays.asList(institution1.getKey(), institution2.getKey()))
.page(DEFAULT_PAGE)
.build())
.getResults()
.size());

// code and name params
assertEquals(
1,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
@SuperBuilder
public class CollectionSearchParams extends SearchParams {

@Nullable UUID institutionKey;
@Nullable List<CollectionContentType> contentTypes;
@Nullable List<PreservationType> preservationTypes;
@Nullable AccessionStatus accessionStatus;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.UUID;

import javax.annotation.Nullable;
import javax.validation.constraints.Null;

import lombok.Getter;
import lombok.experimental.SuperBuilder;
Expand Down Expand Up @@ -53,6 +54,7 @@ public abstract class SearchParams {
@Nullable private UUID replacedBy;
@Nullable RangeParam occurrenceCount;
@Nullable RangeParam typeSpecimenCount;
@Nullable List<UUID> institutionKeys;
@Nullable
CollectionsSortField sortBy;
@Nullable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,6 @@
c.deleted IS NULL
</otherwise>
</choose>
<if test="params.institutionKey != null" >
AND c.institution_key = #{params.institutionKey,jdbcType=OTHER}
</if>
<if test="params.code != null" >
AND lower(c.code) = lower(#{params.code,jdbcType=VARCHAR})
</if>
Expand Down Expand Up @@ -387,6 +384,12 @@
<if test="params.replacedBy != null" >
AND c.replaced_by = #{params.replacedBy,jdbcType=OTHER}
</if>
<if test="params.institutionKeys != null and params.institutionKeys.size > 0" >
AND c.institution_key IN
<foreach item="item" collection="params.institutionKeys" open="(" separator="," close=")">
#{item,jdbcType=VARCHAR}
</foreach>
</if>
</where>
</sql>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,12 @@
<if test="params.replacedBy != null" >
AND i.replaced_by = #{params.replacedBy,jdbcType=OTHER}
</if>
<if test="params.institutionKeys != null and params.institutionKeys.size > 0" >
AND i.key IN
<foreach item="item" collection="params.institutionKeys" open="(" separator="," close=")">
#{item,jdbcType=VARCHAR}
</foreach>
</if>
</where>
</sql>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
import org.gbif.registry.service.WithMyBatis;
import org.gbif.registry.service.collections.converters.CollectionConverter;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.UUID;
Expand Down Expand Up @@ -148,9 +150,16 @@ private PagingResponse<CollectionView> listInternal(
? Strings.emptyToNull(CharMatcher.WHITESPACE.trimFrom(searchRequest.getQ()))
: searchRequest.getQ();

Set<UUID> institutionKeys = new HashSet<>();
if (searchRequest.getInstitution() != null) {
institutionKeys.add(searchRequest.getInstitution());
}
if (searchRequest.getInstitutionKeys() != null) {
institutionKeys.addAll(searchRequest.getInstitutionKeys());
}

CollectionSearchParams params =
CollectionSearchParams.builder()
.institutionKey(searchRequest.getInstitution())
.query(query)
.code(searchRequest.getCode())
.name(searchRequest.getName())
Expand All @@ -176,6 +185,7 @@ private PagingResponse<CollectionView> listInternal(
.occurrenceCount(parseIntegerRangeParameter(searchRequest.getOccurrenceCount()))
.typeSpecimenCount(parseIntegerRangeParameter(searchRequest.getTypeSpecimenCount()))
.deleted(deleted)
.institutionKeys(new ArrayList<>(institutionKeys))
.sortBy(searchRequest.getSortBy())
.sortOrder(searchRequest.getSortOrder())
.page(page)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ private InstitutionSearchParams buildSearchParams(
.replacedBy(searchRequest.getReplacedBy())
.occurrenceCount(parseIntegerRangeParameter(searchRequest.getOccurrenceCount()))
.typeSpecimenCount(parseIntegerRangeParameter(searchRequest.getTypeSpecimenCount()))
.institutionKeys(searchRequest.getInstitutionKeys())
.deleted(deleted)
.sortBy(searchRequest.getSortBy())
.sortOrder(searchRequest.getSortOrder())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
*/
package org.gbif.registry.ws.provider;


import org.gbif.api.model.collections.request.SearchRequest;
import org.gbif.api.model.common.paging.Pageable;
import org.gbif.api.util.VocabularyUtils;
Expand Down Expand Up @@ -161,6 +162,19 @@ protected <T extends SearchRequest> void fillSearchRequestParams(
validateIntegerRange(typeSpecimenCountParam, "typeSpecimen");
request.setTypeSpecimenCount(typeSpecimenCountParam);
}

String[] institutionKeysParams = webRequest.getParameterValues("institutionKey");
if (institutionKeysParams != null && institutionKeysParams.length > 0) {
request.setInstitutionKeys(new ArrayList<>());
for (String keyParam : institutionKeysParams) {
try {
request.getInstitutionKeys().add(UUID.fromString(keyParam));
} catch (Exception ex) {
throw new IllegalArgumentException(
"Invalid UUID for institution key parameter: " + keyParam);
}
}
}
}

private static void validateIntegerRange(String param, String paramName) {
Expand Down
Loading

0 comments on commit 3379614

Please sign in to comment.