Skip to content

Commit

Permalink
feat:Add operators to search endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
Sulejman Karisik authored and Sulejman Karisik committed Jun 10, 2024
1 parent 4342f1c commit 8751953
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public CkanDatasetsSearchService(

@Override
public DatasetsSearchResponse search(DatasetSearchQuery query, String accessToken) {
var facetsQuery = CkanFacetsQueryBuilder.buildFacetQuery(query.getFacets());
var facetsQuery = CkanFacetsQueryBuilder.buildFacetQuery(query);

var response = ckanQueryApi.packageSearch(
query.getQuery(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import java.util.List;
import java.util.Objects;

import io.github.genomicdatainfrastructure.discovery.model.DatasetSearchQuery;
import io.github.genomicdatainfrastructure.discovery.model.DatasetSearchQueryFacet;
import lombok.experimental.UtilityClass;

Expand All @@ -21,18 +22,20 @@ public class CkanFacetsQueryBuilder {
private final String CKAN_FACET_GROUP = "ckan";
private final String QUOTED_VALUE = "\"%s\"";
private final String FACET_PATTERN = "%s:(%s)";
private final String AND = " AND ";

public String buildFacetQuery(List<DatasetSearchQueryFacet> facets) {
public String buildFacetQuery(DatasetSearchQuery query) {
var facets = query.getFacets();
var operator = query.getOperator();

var nonNullFacets = ofNullable(facets)
.orElseGet(List::of)
.stream()
.filter(CkanFacetsQueryBuilder::isCkanGroupAndFacetIsNotBlank)
.collect(groupingBy(DatasetSearchQueryFacet::getFacet));

return nonNullFacets.entrySet().stream()
.map(entry -> getFacetQuery(entry.getKey(), entry.getValue()))
.collect(joining(AND));
.map(entry -> getFacetQuery(entry.getKey(), entry.getValue(), operator))
.collect(joining(OperatorMapper.getOperator(operator)));
}

private Boolean isCkanGroupAndFacetIsNotBlank(DatasetSearchQueryFacet facet) {
Expand All @@ -43,10 +46,10 @@ private Boolean isCkanGroupAndFacetIsNotBlank(DatasetSearchQueryFacet facet) {
!facet.getValue().isBlank();
}

private String getFacetQuery(String key, List<DatasetSearchQueryFacet> facets) {
private String getFacetQuery(String key, List<DatasetSearchQueryFacet> facets, String operator) {
var values = facets.stream()
.map(facet -> QUOTED_VALUE.formatted(facet.getValue()))
.collect(joining(AND));
.collect(joining(OperatorMapper.getOperator(operator)));

return FACET_PATTERN.formatted(key, values);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// SPDX-FileCopyrightText: 2024 PNED G.I.E.
//
// SPDX-License-Identifier: Apache-2.0

package io.github.genomicdatainfrastructure.discovery.services;

import lombok.experimental.UtilityClass;

@UtilityClass
public class Operator {
public static final String Or = "or";
public static final String And = "and";
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// SPDX-FileCopyrightText: 2024 PNED G.I.E.
//
// SPDX-License-Identifier: Apache-2.0

package io.github.genomicdatainfrastructure.discovery.services;

import lombok.experimental.UtilityClass;

@UtilityClass
public class OperatorMapper {

private final String AND = " AND ";
private final String OR = " OR ";

public String getOperator(String operator) {
return operator.equals(Operator.Or) ? OR : AND;
}
}
3 changes: 3 additions & 0 deletions src/main/openapi/discovery.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@ components:
title: Offset in the complete result set
default: 0
minimum: 0
operator:
type: string
default: "and"
DatasetSearchQueryFacet:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

package io.github.genomicdatainfrastructure.discovery.services;

import io.github.genomicdatainfrastructure.discovery.model.DatasetSearchQuery;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.NullSource;
Expand All @@ -20,7 +21,7 @@ class CkanFacetsQueryBuilderTest {
@Test
void can_parse_if_empty_list() {
var expected = "";
var actual = CkanFacetsQueryBuilder.buildFacetQuery(List.of());
var actual = CkanFacetsQueryBuilder.buildFacetQuery(null);
assertEquals(expected, actual);
}

Expand All @@ -34,7 +35,7 @@ void can_parse_if_null_list() {
@ParameterizedTest
@NullSource
@ValueSource(strings = {"", " ", " "})
void can_parse(String value) {
void can_parse_with_and_operator(String value) {
var facets = List.of(
new DatasetSearchQueryFacet("ckan", "field1", "value1"),
new DatasetSearchQueryFacet("ckan", "field1", "value2"),
Expand All @@ -47,8 +48,37 @@ void can_parse(String value) {
new DatasetSearchQueryFacet(value, "field2", "value3")
);

var query = new DatasetSearchQuery();
query.setFacets(facets);
query.setOperator(Operator.And);

var expected = "field1:(\"value1\" AND \"value2\") AND field2:(\"value3\")";
var actual = CkanFacetsQueryBuilder.buildFacetQuery(facets);
var actual = CkanFacetsQueryBuilder.buildFacetQuery(query);
assertEquals(expected, actual);
}

@ParameterizedTest
@NullSource
@ValueSource(strings = {"", " ", " "})
void can_parse_with_or_operator(String value) {
var facets = List.of(
new DatasetSearchQueryFacet("ckan", "field1", "value1"),
new DatasetSearchQueryFacet("ckan", "field1", "value2"),
new DatasetSearchQueryFacet("ckan", "field2", "value3"),
new DatasetSearchQueryFacet("dummy", "field2", "value"),
new DatasetSearchQueryFacet(null, "field2", "value"),
new DatasetSearchQueryFacet(null, null, "value"),
new DatasetSearchQueryFacet("ckan", value, "value3"),
new DatasetSearchQueryFacet("ckan", "field2", value),
new DatasetSearchQueryFacet(value, "field2", "value3")
);

var query = new DatasetSearchQuery();
query.setFacets(facets);
query.setOperator(Operator.Or);

var expected = "field1:(\"value1\" OR \"value2\") OR field2:(\"value3\")";
var actual = CkanFacetsQueryBuilder.buildFacetQuery(query);
assertEquals(expected, actual);
}
}

0 comments on commit 8751953

Please sign in to comment.