io.sphere.sdk.search.model

Class RangeTermFilterSearchModel<T,V extends Comparable<? super V>>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.RangeTermFilterSearchModel<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Implemented Interfaces:

ExistsAndMissingFilterSearchModelSupport<T>, ExistsFilterSearchModelSupport<T>, FilterSearchModel<T,V>, MissingFilterSearchModelSupport<T>

public final class RangeTermFilterSearchModel<T,V extends Comparable<? super V>>
extends Base

Model to build range and term filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchModel<T>	searchModel
protected Function<V,String>	typeSerializer

Method Summary

Modifier and Type	Method and Description
List<FilterExpression<T>>	containsAll(Iterable<V> values) Generates an expression to select all elements with attributes matching all the given values.
List<FilterExpression<T>>	containsAllAsString(Iterable<String> values) Generates an expression to select all elements with attributes matching all the given values.
List<FilterExpression<T>>	containsAny(Iterable<V> values) Generates an expression to select all elements with attributes matching any of the given values.
List<FilterExpression<T>>	containsAnyAsString(Iterable<String> values) Generates an expression to select all elements with attributes matching any of the given values.
List<FilterExpression<T>>	exists() Creates filters for a field that contains at least one value.
SearchModel<T>	getSearchModel() The search model for the filter.
List<FilterExpression<T>>	is(V value) Generates an expression to select all elements with the given attribute value.
List<FilterExpression<T>>	isBetween(FilterRange<V> range) Generates an expression to select all elements with an attribute value within the given range.
List<FilterExpression<T>>	isBetween(V lowerEndpoint, V upperEndpoint) Generates an expression to select all elements with an attribute value within the range defined by the given endpoints.
List<FilterExpression<T>>	isBetweenAll(Iterable<FilterRange<V>> filterRanges) Generates an expression to select all elements with an attribute value within all the given ranges.
List<FilterExpression<T>>	isBetweenAllAsString(Iterable<FilterRange<String>> ranges) Generates an expression to select all elements with an attribute value within all the given ranges.
List<FilterExpression<T>>	isBetweenAny(Iterable<FilterRange<V>> filterRanges) Generates an expression to select all elements with an attribute value within any of the given ranges.
List<FilterExpression<T>>	isBetweenAnyAsString(Iterable<FilterRange<String>> ranges) Generates an expression to select all elements with an attribute value within any of the given ranges.
List<FilterExpression<T>>	isBetweenAsString(FilterRange<String> range) Generates an expression to select all elements with an attribute value within the given range.
List<FilterExpression<T>>	isGreaterThanOrEqualTo(V value) Generates an expression to select all elements with an attribute value greater than or equal to the given value.
List<FilterExpression<T>>	isIn(Iterable<V> values) Generates an expression to select all elements with attributes matching any of the given values.
List<FilterExpression<T>>	isLessThanOrEqualTo(V value) Generates an expression to select all elements with an attribute value less than or equal to the given value.
List<FilterExpression<T>>	missing() Creates filters for fields that contain no values.
static <T,V extends Comparable<? super V>> RangeTermFilterSearchModel<T,V>	of(String attributePath, Function<V,String> typeSerializer) Creates an instance of the search model to generate range and term filter expressions.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

searchModel

protected final SearchModel<T> searchModel

typeSerializer

protected final Function<V,String> typeSerializer

Method Detail

is

public List<FilterExpression<T>> is(V value)

Generates an expression to select all elements with the given attribute value. For example: filtering by "red" would select only those elements with "red" value.

Specified by:

is in interface FilterSearchModel<T,V extends Comparable<? super V>>

Parameters:

value - the value to filter by

Returns:

a filter expression for the given value

isIn

public List<FilterExpression<T>> isIn(Iterable<V> values)

Generates an expression to select all elements with attributes matching any of the given values. For example: filtering by ["red", "blue"] would select only those elements with either "red" or "blue" value.

Alias for FilterSearchModel.containsAny(Iterable).

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAny

public List<FilterExpression<T>> containsAny(Iterable<V> values)

Generates an expression to select all elements with attributes matching any of the given values. For example: filtering by ["red", "blue"] would select only those elements with either "red" or "blue" value.

Specified by:

containsAny in interface FilterSearchModel<T,V extends Comparable<? super V>>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAll

public List<FilterExpression<T>> containsAll(Iterable<V> values)

Generates an expression to select all elements with attributes matching all the given values. For example: filtering by ["red", "blue"] would select only those elements with both "red" and "blue" values.

Specified by:

containsAll in interface FilterSearchModel<T,V extends Comparable<? super V>>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

isBetween

public List<FilterExpression<T>> isBetween(FilterRange<V> range)

Generates an expression to select all elements with an attribute value within the given range. For example: filtering by [3, 7] would select only those elements with values between 3 and 7, inclusive.

Parameters:

range - the range of values to filter by

Returns:

a filter expression for the given range

isBetween

public List<FilterExpression<T>> isBetween(V lowerEndpoint,
                                           V upperEndpoint)

Generates an expression to select all elements with an attribute value within the range defined by the given endpoints. For example: filtering by [3, 5] would select only those elements with values between 3 and 5, inclusive.

Parameters:

lowerEndpoint - the lower endpoint of the range of values to filter by, inclusive

upperEndpoint - the upper endpoint of the range of values to filter by, inclusive

Returns:

a filter expression for the given range

isBetweenAny

public List<FilterExpression<T>> isBetweenAny(Iterable<FilterRange<V>> filterRanges)

Generates an expression to select all elements with an attribute value within any of the given ranges. For example: filtering by [[3, 7], [5, 9]] would select only those elements with values within 3 and 7, or within 5 and 9, both inclusive.

Parameters:

filterRanges - the ranges of values to filter by

Returns:

a filter expression for the given ranges

isBetweenAll

public List<FilterExpression<T>> isBetweenAll(Iterable<FilterRange<V>> filterRanges)

Generates an expression to select all elements with an attribute value within all the given ranges. For example: filtering by [[3, 7], [5, 9]] would select only those elements with values within the range intersection [5, 7], inclusive.

Parameters:

filterRanges - the ranges of values to filter by

Returns:

a filter expression for the given ranges

isGreaterThanOrEqualTo

public List<FilterExpression<T>> isGreaterThanOrEqualTo(V value)

Generates an expression to select all elements with an attribute value greater than or equal to the given value. For example: filtering by [3, +∞) would select only those elements with values greater than or equal to 3.

Parameters:

value - the lower endpoint of the range [v, +∞)

Returns:

a filter expression for the given range

isLessThanOrEqualTo

public List<FilterExpression<T>> isLessThanOrEqualTo(V value)

Generates an expression to select all elements with an attribute value less than or equal to the given value. For example: filtering by (-∞, 5] would select only those elements with values less than or equal to 5.

Parameters:

value - the upper endpoint of the range (-∞, v]

Returns:

a filter expression for the given range

of

public static <T,V extends Comparable<? super V>> RangeTermFilterSearchModel<T,V> of(String attributePath,
                                                                                     Function<V,String> typeSerializer)

Creates an instance of the search model to generate range and term filter expressions.

Type Parameters:

T - type of the resource

V - type of the value

Parameters:

attributePath - the path of the attribute as expected by Composable Commerce (e.g. "variants.attributes.color.key")

typeSerializer - the function to convert the provided value to a string accepted by Composable Commerce

Returns:

new instance of RangeTermFilterSearchModel

isBetweenAsString

public List<FilterExpression<T>> isBetweenAsString(FilterRange<String> range)

Generates an expression to select all elements with an attribute value within the given range. For example: filtering by [3, 7] would select only those elements with values between 3 and 7, inclusive.

Parameters:

range - the range of values (as string) to filter by

Returns:

a filter expression for the given range

isBetweenAnyAsString

public List<FilterExpression<T>> isBetweenAnyAsString(Iterable<FilterRange<String>> ranges)

Generates an expression to select all elements with an attribute value within any of the given ranges. For example: filtering by [[3, 7], [5, 9]] would select only those elements with values within 3 and 7, or within 5 and 9, both inclusive.

Parameters:

ranges - the ranges of values (as string) to filter by

Returns:

a filter expression for the given ranges

isBetweenAllAsString

public List<FilterExpression<T>> isBetweenAllAsString(Iterable<FilterRange<String>> ranges)

Generates an expression to select all elements with an attribute value within all the given ranges. For example: filtering by [[3, 7], [5, 9]] would select only those elements with values within the range intersection [5, 7], inclusive.

Parameters:

ranges - the ranges of values (as string) to filter by

Returns:

a filter expression for the given ranges

getSearchModel

public SearchModel<T> getSearchModel()

Description copied from interface: FilterSearchModel

The search model for the filter.

Specified by:

getSearchModel in interface FilterSearchModel<T,V>

Returns:

the filter search model

exists

public List<FilterExpression<T>> exists()

Description copied from interface: ExistsFilterSearchModelSupport

Creates filters for a field that contains at least one value.

withCategory(client(), category -> {
    withProduct(client(), builder -> builder.categories(singleton(category.toReference())), productWithCategories -> {
        withProduct(client(), productWithoutCategories -> {
            final List<String> productIds = asList(productWithCategories.getId(), productWithoutCategories.getId());
            final ProductProjectionSearch exists = ProductProjectionSearch.ofStaged()
                    .withQueryFilters(m -> m.id().isIn(productIds))//for test isolation
                    .plusQueryFilters(m -> m.categories().exists());
            assertEventually(() -> {
                final List<ProductProjection> results = client().executeBlocking(exists).getResults();
                assertThat(results)
                        .hasSize(1)
                        .extracting(s -> s.getId())
                        .containsExactly(productWithCategories.getId())
                        .doesNotContain(productWithoutCategories.getId());
            });
        });
    });
});
See the test code.

Specified by:

exists in interface ExistsAndMissingFilterSearchModelSupport<T>

Specified by:

exists in interface ExistsFilterSearchModelSupport<T>

Returns:

filters

missing

public List<FilterExpression<T>> missing()

Description copied from interface: MissingFilterSearchModelSupport

Creates filters for fields that contain no values.

withCategory(client(), category -> {
    withProduct(client(), builder -> builder.categories(singleton(category.toReference())), productWithCategories -> {
        withProduct(client(), productWithoutCategories -> {
            final List<String> productIds = asList(productWithCategories.getId(), productWithoutCategories.getId());
            final ProductProjectionSearch missing = ProductProjectionSearch.ofStaged()
                    .withQueryFilters(m -> m.id().isIn(productIds))//for test isolation
                    .plusQueryFilters(m -> m.categories().missing());
           assertEventually(() -> {
               final List<ProductProjection> results = client().executeBlocking(missing).getResults();
               assertThat(results)
                       .hasSize(1)
                       .extracting(s -> s.getId())
                       .containsExactly(productWithoutCategories.getId())
                       .doesNotContain(productWithCategories.getId());
           });
        });
    });
});
See the test code.

Specified by:

missing in interface ExistsAndMissingFilterSearchModelSupport<T>

Specified by:

missing in interface MissingFilterSearchModelSupport<T>

Returns:

filters

containsAnyAsString

public List<FilterExpression<T>> containsAnyAsString(Iterable<String> values)

Generates an expression to select all elements with attributes matching any of the given values. For example: filtering by ["red", "blue"] would select only those elements with either "red" or "blue" value.

Specified by:

containsAnyAsString in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAllAsString

public List<FilterExpression<T>> containsAllAsString(Iterable<String> values)

Generates an expression to select all elements with attributes matching all the given values. For example: filtering by ["red", "blue"] would select only those elements with both "red" and "blue" values.

Specified by:

containsAllAsString in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values