RangeTermFacetSearchModel (Composable Commerce JVM SDK 2.17.0-SNAPSHOT API)

java.lang.Object
- io.sphere.sdk.models.Base
- - io.sphere.sdk.search.model.RangeTermFacetSearchModel<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Implemented Interfaces:

FacetSearchModel<T,V>
```
public final class RangeTermFacetSearchModel<T,V extends Comparable<? super V>>
extends Base
```
Model to build range and term facets.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`alias`
`protected Boolean`	`isCountingProducts`
`protected SearchModel<T>`	`searchModel`
`protected Function<V,String>`	`typeSerializer`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RangeFacetExpression<T>`	`allRanges()` Generates an expression to obtain the facet of the attribute for any range.
`TermFacetExpression<T>`	`allTerms()` Generates an expression to obtain the facets of the attribute for all values.
`String`	`getAlias()` The alias related to the facet.
`SearchModel<T>`	`getSearchModel()` The search model for the facet.
`Boolean`	`isCountingProducts()` Whether the facet is counting products.
`static <T,V extends Comparable<? super V>> RangeTermFacetSearchModel<T,V>`	`of(String attributePath, Function<V,String> typeSerializer)` Creates an instance of the search model to generate range and term facet expressions.
`RangeFacetExpression<T>`	`onlyGreaterThanOrEqualTo(V value)` Generates an expression to obtain the facet of the attribute for only values greater than or equal to the given value.
`RangeFacetExpression<T>`	`onlyLessThan(V value)` Generates an expression to obtain the facet of the attribute for only values less than the given value.
`RangeFacetExpression<T>`	`onlyRange(FacetRange<V> range)` Generates an expression to obtain the facet of the attribute for only the given range.
`RangeFacetExpression<T>`	`onlyRange(Iterable<FacetRange<V>> facetRanges)` Generates an expression to obtain the facet of the attribute for only the given ranges.
`RangeFacetExpression<T>`	`onlyRange(V lowerEndpoint, V upperEndpoint)` Generates an expression to obtain the facet of the attribute for only the given range.
`RangeFacetExpression<T>`	`onlyRangeAsString(FacetRange<String> range)` Generates an expression to obtain the facet of the attribute for only the given range.
`RangeFacetExpression<T>`	`onlyRangeAsString(Iterable<FacetRange<String>> ranges)` Generates an expression to obtain the facet of the attribute for only the given ranges.
`FilteredFacetExpression<T>`	`onlyTerm(Iterable<V> values)` Generates an expression to obtain the facets of the attribute for only the given values.
`FilteredFacetExpression<T>`	`onlyTerm(V value)` Generates an expression to obtain the facet of the attribute for only the given value.
`FilteredFacetExpression<T>`	`onlyTermAsString(Iterable<String> values)` Generates an expression to obtain the facets of the attribute for only the given values.
`RangeTermFacetSearchModel<T,V>`	`withAlias(String alias)` Allows to set an alias to identify the facet.
`RangeTermFacetSearchModel<T,V>`	`withCountingProducts(Boolean isCountingProducts)` Allows to enable/disable the counting of products.

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
```
  - alias
```
@Nullable
protected final String alias
```
  - isCountingProducts
```
protected final Boolean isCountingProducts
```
- Method Detail
  - withAlias
```
public RangeTermFacetSearchModel<T,V> withAlias(String alias)
```
    Allows to set an alias to identify the facet.
    
    Parameters:
    
    alias - the identifier to use for the facet
    
    Returns:
    
    a new facet search model identical to the current one, but with the given alias
  - withCountingProducts
```
public RangeTermFacetSearchModel<T,V> withCountingProducts(Boolean isCountingProducts)
```
    Allows to enable/disable the counting of products.
    
    Parameters:
    
    isCountingProducts - whether to count products or not
    
    Returns:
    
    a new facet search model identical to the current one, but with the counting of products enabled/disabled
  - allTerms
```
public TermFacetExpression<T> allTerms()
```
    Generates an expression to obtain the facets of the attribute for all values. For example: a possible faceted classification could be ["red": 4, "yellow": 2, "blue": 1].
    
    Specified by:
    
    allTerms in interface FacetSearchModel<T,V extends Comparable<? super V>>
    
    Returns:
    
    a facet expression for all values
  - allRanges
```
public RangeFacetExpression<T> allRanges()
```
    Generates an expression to obtain the facet of the attribute for any range. For example: a possible faceted classification could be ["-40": 4, "105": 2, "4": 1]. Notice that this method generates a facet expression with two ranges: (-∞, 0] and [0, +∞), therefore two results should be expected.
    
    Returns:
    
    a facet expression for all values
  - onlyTerm
```
public FilteredFacetExpression<T> onlyTerm(V value)
```
    Generates an expression to obtain the facet of the attribute for only the given value. For example: a possible faceted classification for "red" could be ["red": 4].
    
    Specified by:
    
    onlyTerm in interface FacetSearchModel<T,V extends Comparable<? super V>>
    
    Parameters:
    
    value - the value from which to obtain the facet
    
    Returns:
    
    a facet expression for only the given value
  - onlyTerm
```
public FilteredFacetExpression<T> onlyTerm(Iterable<V> values)
```
    Generates an expression to obtain the facets of the attribute for only the given values. For example: a possible faceted classification for ["red", "blue"] could be ["red": 4, "blue": 1].
    
    Specified by:
    
    onlyTerm in interface FacetSearchModel<T,V extends Comparable<? super V>>
    
    Parameters:
    
    values - the values from which to obtain the facets
    
    Returns:
    
    a facet expression for only the given values
  - onlyRange
```
public RangeFacetExpression<T> onlyRange(FacetRange<V> range)
```
    Generates an expression to obtain the facet of the attribute for only the given range. For example: a possible faceted classification for [3, 5] could be ["3": 4, "5": 2, "4": 1].
    
    Parameters:
    
    range - the range of values to be present in the facet
    
    Returns:
    
    a facet expression for only the given range
  - onlyRange
```
public RangeFacetExpression<T> onlyRange(Iterable<FacetRange<V>> facetRanges)
```
    Generates an expression to obtain the facet of the attribute for only the given ranges. For example: a possible faceted classification for [[3, 5], [8, 9]] could be ["3": 4, "9": 3, "5": 2, "4": 1].
    
    Parameters:
    
    facetRanges - the ranges of values to be present in the facet
    
    Returns:
    
    a facet expression for only the given ranges
  - onlyRange
```
public RangeFacetExpression<T> onlyRange(V lowerEndpoint,
                                         V upperEndpoint)
```
    Generates an expression to obtain the facet of the attribute for only the given range. For example: a possible faceted classification for [3, 5] could be ["3": 4, "5": 2, "4": 1].
    
    Parameters:
    
    lowerEndpoint - the lower endpoint of the range of values to be present in the facet, inclusive
    
    upperEndpoint - the upper endpoint of the range of values to be present in the facet, inclusive
    
    Returns:
    
    a facet expression for only the given range
  - onlyGreaterThanOrEqualTo
```
public RangeFacetExpression<T> onlyGreaterThanOrEqualTo(V value)
```
    Generates an expression to obtain the facet of the attribute for only values greater than or equal to the given value. For example: a possible faceted classification for [3, +∞) could be ["15": 6, "3": 4, "9": 3, "5": 2, "4": 1].
    
    Parameters:
    
    value - the lower endpoint of the range [v, +∞)
    
    Returns:
    
    a facet expression for only the given range
  - onlyLessThan
```
public RangeFacetExpression<T> onlyLessThan(V value)
```
    Generates an expression to obtain the facet of the attribute for only values less than the given value. For example: a possible faceted classification for (-∞, 5) could be ["3": 4, "1": 3, "4": 1].
    
    Parameters:
    
    value - the upper endpoint of the range (-∞, v)
    
    Returns:
    
    a facet expression for only the given range
  - of
```
public static <T,V extends Comparable<? super V>> RangeTermFacetSearchModel<T,V> of(String attributePath,
                                                                                    Function<V,String> typeSerializer)
```
    Creates an instance of the search model to generate range and term facet 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 RangeTermFacetSearchModel
  - onlyRangeAsString
```
public RangeFacetExpression<T> onlyRangeAsString(FacetRange<String> range)
```
    Generates an expression to obtain the facet of the attribute for only the given range. For example: a possible faceted classification for [3, 5] could be ["3": 4, "5": 2, "4": 1].
    
    Parameters:
    
    range - the range of values (as string) to be present in the facet
    
    Returns:
    
    a facet expression for only the given range
  - onlyRangeAsString
```
public RangeFacetExpression<T> onlyRangeAsString(Iterable<FacetRange<String>> ranges)
```
    Generates an expression to obtain the facet of the attribute for only the given ranges. For example: a possible faceted classification for [[3, 5], [8, 9]] could be ["3": 4, "9": 3, "5": 2, "4": 1].
    
    Parameters:
    
    ranges - the ranges of values (as string) to be present in the facet
    
    Returns:
    
    a facet expression for only the given ranges
  - getAlias
```
@Nullable
public String getAlias()
```
    The alias related to the facet.
    
    Specified by:
    
    getAlias in interface FacetSearchModel<T,V>
    
    Returns:
    
    the facet alias
  - isCountingProducts
```
public Boolean isCountingProducts()
```
    Whether the facet is counting products.
    
    Specified by:
    
    isCountingProducts in interface FacetSearchModel<T,V>
    
    Returns:
    
    whether the facet is counting products
  - getSearchModel
```
public SearchModel<T> getSearchModel()
```
    Description copied from interface: FacetSearchModel
    
    The search model for the facet.
    
    Specified by:
    
    getSearchModel in interface FacetSearchModel<T,V>
    
    Returns:
    
    the facet search model
  - onlyTermAsString
```
public FilteredFacetExpression<T> onlyTermAsString(Iterable<String> values)
```
    Generates an expression to obtain the facets of the attribute for only the given values. For example: a possible faceted classification for ["red", "blue"] could be ["red": 4, "blue": 1].
    
    Specified by:
    
    onlyTermAsString in interface FacetSearchModel<T,V>
    
    Parameters:
    
    values - the values from which to obtain the facets
    
    Returns:
    
    a facet expression for only the given values

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

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

searchModel

typeSerializer

alias

isCountingProducts

Method Detail

withAlias

withCountingProducts

allTerms

allRanges

onlyTerm

onlyTerm

onlyRange

onlyRange

onlyRange

onlyGreaterThanOrEqualTo

onlyLessThan

of

onlyRangeAsString

onlyRangeAsString

getAlias

isCountingProducts

getSearchModel

onlyTermAsString