io.sphere.sdk.search.model

Class TermFilterSearchModelImpl<T,V>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.TermFilterSearchModelImpl<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>, TermFilterExistsAndMissingSearchModel<T,V>, TermFilterSearchModel<T,V>

public class TermFilterSearchModelImpl<T,V>
extends Base
implements TermFilterExistsAndMissingSearchModel<T,V>

Model to build term filters.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
TermFilterSearchModelImpl(SearchModel<T> searchModel, 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>>	isIn(Iterable<V> values) Generates an expression to select all elements with attributes matching any of the given values.
List<FilterExpression<T>>	missing() Creates filters for fields that contain no values.
static <T,V> TermFilterSearchModelImpl<T,V>	of(String attributePath, Function<V,String> typeSerializer) Creates an instance of the search model to generate term filters.

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

Methods inherited from interface io.sphere.sdk.search.model.TermFilterExistsAndMissingSearchModel

containsAllAsString, containsAnyAsString

Methods inherited from interface io.sphere.sdk.search.model.FilterSearchModel

getSearchModel

Methods inherited from interface io.sphere.sdk.search.model.ExistsAndMissingFilterSearchModelSupport

exists, missing

Field Detail

searchModel

protected final SearchModel<T> searchModel

typeSerializer

protected final Function<V,String> typeSerializer

Constructor Detail

TermFilterSearchModelImpl

public TermFilterSearchModelImpl(SearchModel<T> searchModel,
                                 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>

Specified by:

is in interface TermFilterExistsAndMissingSearchModel<T,V>

Specified by:

is in interface TermFilterSearchModel<T,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).

Specified by:

isIn in interface FilterSearchModel<T,V>

Specified by:

isIn in interface TermFilterExistsAndMissingSearchModel<T,V>

Specified by:

isIn in interface TermFilterSearchModel<T,V>

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>

Specified by:

containsAny in interface TermFilterExistsAndMissingSearchModel<T,V>

Specified by:

containsAny in interface TermFilterSearchModel<T,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>

Specified by:

containsAll in interface TermFilterExistsAndMissingSearchModel<T,V>

Specified by:

containsAll in interface TermFilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

of

public static <T,V> TermFilterSearchModelImpl<T,V> of(String attributePath,
                                                      Function<V,String> typeSerializer)

Creates an instance of the search model to generate term filters.

Specified by:

of in interface TermFilterExistsAndMissingSearchModel<T,V>

Specified by:

of in interface TermFilterSearchModel<T,V>

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 TermFilterSearchModel

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