Skip to content

Filtering operators #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 6, 2021
Merged

Filtering operators #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f647056
add not equals filter parameter
Dec 11, 2020
4381ac1
add empty operator filter
Dec 11, 2020
9984d45
implement not empty filtering operator
Dec 14, 2020
e67f82d
implement not in filtering operator
Dec 14, 2020
bba22b4
Merge branch 'master' into filtering-operators
Simply007 Jan 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion kontent-delivery/src/main/java/kentico/kontent/delivery/DeliveryClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,9 @@ private String createUrl(final String apiCall, final List<NameValuePair> queryPa
final String queryStr = Optional.ofNullable(queryParams)
.filter(params -> !params.isEmpty())
.map(params -> params.stream()
.map(pair -> String.format("%s=%s", pair.getName(), pair.getValue()))
.map(pair -> pair.getValue() != null
? String.format("%s=%s", pair.getName(), pair.getValue())
: pair.getName())
.collect(Collectors.joining("&")))
.map("?"::concat)
.orElse("");
Expand Down
79 changes: 79 additions & 0 deletions kontent-delivery/src/main/java/kentico/kontent/delivery/DeliveryParameterBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,12 +171,16 @@ public class DeliveryParameterBuilder {
static final String LIMIT = "limit";
static final String INCLUDE_TOTAL_COUNT = "includeTotalCount";

static final String NOT_EQUALS = "[neq]";
static final String EMPTY = "[empty]";
static final String NOT_EMPTY = "[nempty]";
static final String LESS_THAN = "[lt]";
static final String LESS_THAN_OR_EQUALS = "[lte]";
static final String GREATER_THAN = "[gt]";
static final String GREATER_THAN_OR_EQUALS = "[gte]";
static final String RANGE = "[range]";
static final String IN = "[in]";
static final String NOT_IN = "[nin]";
static final String CONTAINS = "[contains]";
static final String ANY = "[any]";
static final String ALL = "[all]";
Expand Down Expand Up @@ -211,6 +215,52 @@ public DeliveryParameterBuilder filterEquals(String attribute, String value) {
return this;
}

/**
* Attribute value is not the same as the specified value.
*
* @param attribute The attribute.
* @param value The value.
* @return This DeliveryParameterBuilder with the added operator.
* @see <a href="https://docs.kontent.ai/reference/delivery-api#tag/Filtering-content/filtering-operators">
* More in Filtering operators.</a>
*/
public DeliveryParameterBuilder filterNotEquals(String attribute, String value) {
if (attribute != null) {
nameValuePairs.add(new NameValuePair(String.format("%s%s", attribute, NOT_EQUALS), value));
}
return this;
}

/**
* Attribute value is empty.
*
* @param attribute The attribute.
* @return This DeliveryParameterBuilder with the added operator.
* @see <a href="https://docs.kontent.ai/reference/delivery-api#tag/Filtering-content/filtering-operators">
* More in Filtering operators.</a>
*/
public DeliveryParameterBuilder filterEmpty(String attribute) {
if (attribute != null) {
nameValuePairs.add(new NameValuePair(String.format("%s%s", attribute, EMPTY), null));
}
return this;
}

/**
* Attribute value is not empty.
*
* @param attribute The attribute.
* @return This DeliveryParameterBuilder with the added operator.
* @see <a href="https://docs.kontent.ai/reference/delivery-api#tag/Filtering-content/filtering-operators">
* More in Filtering operators.</a>
*/
public DeliveryParameterBuilder filterNotEmpty(String attribute) {
if (attribute != null) {
nameValuePairs.add(new NameValuePair(String.format("%s%s", attribute, NOT_EMPTY), null));
}
return this;
}

/**
* Attribute value is less than the specified value.
*
Expand Down Expand Up @@ -333,6 +383,35 @@ public DeliveryParameterBuilder filterIn(String attribute, Collection<String> va
return filterIn(attribute, values.toArray(new String[0]));
}

/**
* Attribute value is not in the specified list of values.
*
* @param attribute The attribute.
* @param values The values.
* @return This DeliveryParameterBuilder with the added operator.
* @see <a href="https://docs.kontent.ai/reference/delivery-api#tag/Filtering-content/filtering-operators">
* More in Filtering operators.</a>
*/
public DeliveryParameterBuilder filterNotIn(String attribute, String... values) {
if (attribute != null) {
nameValuePairs.add(new NameValuePair(String.format("%s%s", attribute, NOT_IN), String.join(",", values)));
}
return this;
}

/**
* Attribute value is not in the specified list of values.
*
* @param attribute The attribute.
* @param values The values.
* @return This DeliveryParameterBuilder with the added operator.
* @see <a href="https://docs.kontent.ai/reference/delivery-api#tag/Filtering-content/filtering-operators">
* More in Filtering operators.</a>
*/
public DeliveryParameterBuilder filterNotIn(String attribute, Collection<String> values) {
return filterNotIn(attribute, values.toArray(new String[0]));
}

/**
* Attribute with an array of values contains the specified value.
*
Expand Down
62 changes: 62 additions & 0 deletions kontent-delivery/src/test/java/kentico/kontent/delivery/DeliveryParameterBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,49 @@ public void testEqualsNullAttr() {
Assert.assertEquals(0, params.size());
}

@Test
public void testNotEqualsNullAttr() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterNotEquals(null, null).build();
Assert.assertEquals(0, params.size());
}

@Test
public void testNotEquals() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterNotEquals("foo", "bar").build();
Assert.assertEquals(1, params.size());
Assert.assertEquals("foo[neq]", params.get(0).getName());
Assert.assertEquals("bar", params.get(0).getValue());
}

@Test
public void testEmptyNullAttr() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterEmpty(null).build();
Assert.assertEquals(0, params.size());
}

@Test
public void testEmpty() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterEmpty("foo").build();
Assert.assertEquals(1, params.size());
Assert.assertEquals("foo[empty]", params.get(0).getName());
Assert.assertEquals(null, params.get(0).getValue());
}

@Test
public void testNotEmptyNullAttr() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterNotEmpty(null).build();
Assert.assertEquals(0, params.size());
}

@Test
public void testNotEmpty() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterNotEmpty("foo").build();
Assert.assertEquals(1, params.size());
Assert.assertEquals("foo[nempty]", params.get(0).getName());
Assert.assertEquals(null, params.get(0).getValue());
}


@Test
public void testLessThan() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterLessThan("foo", "bar").build();
Expand Down Expand Up @@ -136,6 +179,25 @@ public void testInCollection() {
Assert.assertEquals("bar,foobar", params.get(0).getValue());
}

@Test
public void testNotIn() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterNotIn("foo", "bar", "foobar").build();
Assert.assertEquals(1, params.size());
Assert.assertEquals("foo[nin]", params.get(0).getName());
Assert.assertEquals("bar,foobar", params.get(0).getValue());
}

@Test
public void testNotInCollection() {
List<String> values = new ArrayList<>();
values.add("bar");
values.add("foobar");
List<NameValuePair> params = DeliveryParameterBuilder.params().filterNotIn("foo", values).build();
Assert.assertEquals(1, params.size());
Assert.assertEquals("foo[nin]", params.get(0).getName());
Assert.assertEquals("bar,foobar", params.get(0).getValue());
}

@Test
public void testInNullAttr() {
List<NameValuePair> params = DeliveryParameterBuilder.params().filterIn(null, null, null).build();
Expand Down