Class FacetRange
- java.lang.Object
-
- com.lucidworks.search.dsl.DslBase
-
- com.lucidworks.search.dsl.request.DslCloneable
-
- com.lucidworks.search.dsl.request.FacetBase
-
- com.lucidworks.search.dsl.request.FacetRange
-
public class FacetRange extends FacetBase
Range facets parameters
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FacetRange.Include
Flags that specify inclusion and exclusion preferences for the upper and lower bounds of the rangestatic class
FacetRange.Other
Counts to include in addition to the counts for each facet range constraint
-
Constructor Summary
Constructors Constructor Description FacetRange(java.lang.String field, java.lang.String start, java.lang.String end, java.lang.String gap, java.lang.Boolean hardEnd, java.lang.Integer minCount, java.util.List<FacetRange.Include> include, java.util.List<FacetRange.Other> other, FacetDomain domain)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FacetRange
clone()
java.lang.String
getEnd()
java.lang.String
getGap()
java.lang.Boolean
getHardEnd()
java.util.List<FacetRange.Include>
getInclude()
java.lang.Integer
getMinCount()
java.util.List<FacetRange.Other>
getOther()
java.lang.String
getStart()
-
Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable
clone, deepClone
-
-
-
-
Constructor Detail
-
FacetRange
public FacetRange(java.lang.String field, java.lang.String start, java.lang.String end, java.lang.String gap, java.lang.Boolean hardEnd, java.lang.Integer minCount, java.util.List<FacetRange.Include> include, java.util.List<FacetRange.Other> other, FacetDomain domain)
-
-
Method Detail
-
getMinCount
public java.lang.Integer getMinCount()
- Returns:
- minimum count. Specifies the minimum counts required for a facet field to be included in the response.
-
getStart
public java.lang.String getStart()
- Returns:
- the start of the facet range
-
getEnd
public java.lang.String getEnd()
- Returns:
- the end of the facet range
-
getGap
public java.lang.String getGap()
- Returns:
- the span of the range as a value to be added to the lower bound
-
getHardEnd
public java.lang.Boolean getHardEnd()
- Returns:
- A boolean parameter that specifies how a range gap that cannot be evenly divided between the range start
and end values is handled. If true, the last range constraint will have the
getEnd()
value an upper bound. If false, the last range will have the smallest possible upper bound greater thengetEnd()
such that the range is the exact width of the specified range gap. The default value for this parameter is false
-
getInclude
public java.util.List<FacetRange.Include> getInclude()
- Returns:
- a list of flags that specify inclusion and exclusion preferences for the upper and lower bounds of the range.
-
getOther
public java.util.List<FacetRange.Other> getOther()
- Returns:
- a list that specifies counts to include in addition to the counts for each facet range constraint.
-
clone
public FacetRange clone()
- Specified by:
clone
in classDslCloneable
-
-