io.sphere.sdk.search.model

Class RangeTermFacetedSearchSearchModel<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.RangeTermFacetedSearchSearchModel<T>

Type Parameters:

T - type of the resource

All Implemented Interfaces:

FacetedSearchSearchModel<T>

public final class RangeTermFacetedSearchSearchModel<T>
extends Base

Model to build range and term facets and filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchModel<T>	searchModel
protected static TypeSerializer<String>	TYPE_SERIALIZER

Method Summary

Modifier and Type	Method and Description
RangeFacetedSearchExpression<T>	allRanges() Generates an expression to select all elements, without filtering, along with the facet for all terms for this attribute.
TermFacetedSearchExpression<T>	allTerms() Generates an expression to select all elements, without filtering, along with the facet for all terms for this attribute.
TermFacetedSearchExpression<T>	containsAll(Iterable<String> values) Generates an expression to select all elements with attributes matching all the given values, along with the facet for all terms for this attribute.
TermFacetedSearchExpression<T>	containsAny(Iterable<String> values) Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute.
SearchModel<T>	getSearchModel() The search model for the faceted search.
TermFacetedSearchExpression<T>	is(String value) Generates an expression to select all elements with the given attribute value, along with the facet for all terms for this attribute.
RangeFacetedSearchExpression<T>	isBetween(FilterRange<String> range) Generates an expression to select all elements with an attribute value within the given range, along with the facet for all ranges for this attribute.
RangeFacetedSearchExpression<T>	isBetweenAll(Iterable<FilterRange<String>> ranges) Generates an expression to select all elements with an attribute value within all the given ranges, along with the facet for all ranges for this attribute.
RangeFacetedSearchExpression<T>	isBetweenAny(Iterable<FilterRange<String>> ranges) Generates an expression to select all elements with an attribute value within any of the given ranges, along with the facet for all ranges for this attribute.
TermFacetedSearchExpression<T>	isIn(Iterable<String> values) Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute.
static <T> RangeTermFacetedSearchSearchModel<T>	of(String attributePath) Creates an instance of the search model to generate range and term faceted search 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

TYPE_SERIALIZER

protected static final TypeSerializer<String> TYPE_SERIALIZER

searchModel

protected final SearchModel<T> searchModel

Method Detail

isBetween

public RangeFacetedSearchExpression<T> isBetween(FilterRange<String> range)

Generates an expression to select all elements with an attribute value within the given range, along with the facet for all ranges for this attribute. For example: filtering by [3, 7] would select only those elements with values between 3 and 7, inclusive, while the facet would contain statistical information about the range.

Parameters:

range - the range of values to filter by

Returns:

a bundle of the filter expressions for the given range and a facet expression for all ranges

isBetweenAny

public RangeFacetedSearchExpression<T> isBetweenAny(Iterable<FilterRange<String>> ranges)

Generates an expression to select all elements with an attribute value within any of the given ranges, along with the facet for all ranges for this attribute. 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, while the color facet would contain statistical information about the ranges.

Parameters:

ranges - the ranges of values to filter by

Returns:

a bundle of the filter expressions for the given ranges and a facet expression for all ranges

isBetweenAll

public RangeFacetedSearchExpression<T> isBetweenAll(Iterable<FilterRange<String>> ranges)

Generates an expression to select all elements with an attribute value within all the given ranges, along with the facet for all ranges for this attribute. For example: filtering by [[3, 7], [5, 9]] would select only those elements with values within the range intersection [5, 7], inclusive, while the color facet would contain statistical information about the ranges.

Parameters:

ranges - the ranges of values to filter by

Returns:

a bundle of the filter expressions for the given ranges and a facet expression for all ranges

allRanges

public RangeFacetedSearchExpression<T> allRanges()

Generates an expression to select all elements, without filtering, along with the facet for all terms for this attribute.

Returns:

a bundle of an empty filter expression and a facet expression for all terms

allTerms

public TermFacetedSearchExpression<T> allTerms()

Generates an expression to select all elements, without filtering, along with the facet for all terms for this attribute.

Specified by:

allTerms in interface FacetedSearchSearchModel<T>

Returns:

a bundle of an empty filter expression and a facet expression for all terms

is

public TermFacetedSearchExpression<T> is(String value)

Generates an expression to select all elements with the given attribute value, along with the facet for all terms for this attribute. For example: filtering by "red" color would select only those elements with "red" value, while the color facet would contain all possible values.

Specified by:

is in interface FacetedSearchSearchModel<T>

Parameters:

value - the value to filter by

Returns:

a bundle of the filter expressions for the given value and a facet expression for all terms

isIn

public TermFacetedSearchExpression<T> isIn(Iterable<String> values)

Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute. For example: filtering by ["red", "blue"] color would select only those elements with either "red" or "blue" value, while the color facet would contain all possible values.

Alias for FacetedSearchSearchModel.containsAny(Iterable).

Parameters:

values - the values to filter by

Returns:

a bundle of the filter expressions for the given values and a facet expression for all terms

containsAny

public TermFacetedSearchExpression<T> containsAny(Iterable<String> values)

Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute. For example: filtering by ["red", "blue"] color would select only those elements with either "red" or "blue" value, while the color facet would contain all possible values.

Specified by:

containsAny in interface FacetedSearchSearchModel<T>

Parameters:

values - the values to filter by

Returns:

a bundle of the filter expressions for the given values and a facet expression for all terms

containsAll

public TermFacetedSearchExpression<T> containsAll(Iterable<String> values)

Generates an expression to select all elements with attributes matching all the given values, along with the facet for all terms for this attribute. For example: filtering by ["red", "blue"] color would select only those elements with both "red" and "blue" values, while the color facet would contain all possible values.

Specified by:

containsAll in interface FacetedSearchSearchModel<T>

Parameters:

values - the values to filter by

Returns:

a bundle of the filter expressions for the given values and a facet expression for all terms

of

public static <T> RangeTermFacetedSearchSearchModel<T> of(String attributePath)

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

Type Parameters:

T - type of the resource

Parameters:

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

Returns:

new instance of RangeTermFacetAndFilterSearchModel

getSearchModel

public SearchModel<T> getSearchModel()

Description copied from interface: FacetedSearchSearchModel

The search model for the faceted search.

Specified by:

getSearchModel in interface FacetedSearchSearchModel<T>

Returns:

the faceted search model