com.lucidworks.search.dsl.request

Class FacetRange

java.lang.Object

com.lucidworks.search.dsl.DslBase

com.lucidworks.search.dsl.request.DslCloneable

com.lucidworks.search.dsl.request.FacetRange

public class FacetRange
extends DslCloneable

Range facets parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetRange.Include Flags that specify inclusion and exclusion preferences for the upper and lower bounds of the range
static class	FacetRange.Other Counts to include in addition to the counts for each facet range constraint

Constructor Summary

Constructors

Constructor and Description
FacetRange(String field, String start, String end, String gap, Boolean hardEnd, Integer minCount, List<FacetRange.Include> include, List<FacetRange.Other> other)

Method Summary

Modifier and Type	Method and Description
FacetRange	clone()
String	getEnd()
String	getField()
String	getFieldWithoutParams()
String	getGap()
Boolean	getHardEnd()
List<FacetRange.Include>	getInclude()
Integer	getMinCount()
List<FacetRange.Other>	getOther()
String	getStart()

Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable

clone, deepClone

Methods inherited from class com.lucidworks.search.dsl.DslBase

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FacetRange

public FacetRange(String field,
                  String start,
                  String end,
                  String gap,
                  Boolean hardEnd,
                  Integer minCount,
                  List<FacetRange.Include> include,
                  List<FacetRange.Other> other)

Method Detail

getField

public String getField()

Returns:

a field to facet by range.

getFieldWithoutParams

public String getFieldWithoutParams()

getMinCount

public Integer getMinCount()

Returns:

minimum count. Specifies the minimum counts required for a facet field to be included in the response.

getStart

public String getStart()

Returns:

the start of the facet range

getEnd

public String getEnd()

Returns:

the end of the facet range

getGap

public String getGap()

Returns:

the span of the range as a value to be added to the lower bound

getHardEnd

public 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 then getEnd() such that the range is the exact width of the specified range gap. The default value for this parameter is false

getInclude

public 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 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 class DslCloneable