com.lucidworks.search.dsl.request

Class FacetField

java.lang.Object

com.lucidworks.search.dsl.DslBase

com.lucidworks.search.dsl.request.DslCloneable

com.lucidworks.search.dsl.request.FacetField

public class FacetField
extends DslCloneable

Field facet parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetField.Sort

Constructor Summary

Constructors

Constructor and Description
FacetField(String field, String prefix, FacetField.Sort sort, Integer limit, Integer offset, Integer minCount, Boolean missing, List<String> ensuredValues)

Method Summary

Modifier and Type	Method and Description
FacetField	clone()
List<String>	getEnsuredValues()
String	getField()
String	getFieldWithoutParams()
Integer	getLimit()
Integer	getMinCount()
Boolean	getMissing()
Integer	getOffset()
String	getPrefix()
FacetField.Sort	getSort()

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

FacetField

public FacetField(String field,
                  String prefix,
                  FacetField.Sort sort,
                  Integer limit,
                  Integer offset,
                  Integer minCount,
                  Boolean missing,
                  List<String> ensuredValues)

Method Detail

getField

public String getField()

Returns:

a field to be treated as a facet

getFieldWithoutParams

public String getFieldWithoutParams()

getPrefix

public String getPrefix()

Returns:

prefix. Limits the terms used for faceting to those that begin with the specified prefix

getSort

public FacetField.Sort getSort()

Returns:

sort type. Controls how faceted results are sorted

getLimit

public Integer getLimit()

Returns:

limit. Controls how many constraints should be returned for each facet.

getOffset

public Integer getOffset()

Returns:

offset. Specifies an offset into the facet results at which to begin displaying facets.

getMinCount

public Integer getMinCount()

Returns:

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

getMissing

public Boolean getMissing()

Returns:

include missing flag. Controls whether to include a count of all matching results which have no value for the field, in addition to the term-based constraints of a facet field.

getEnsuredValues

public List<String> getEnsuredValues()

Returns:

ensured values.

Field facets only return getLimit() distinct values for the field in question. Other values are unrepresented in the field facet. Users who want to ensure that specific values are included can specify those values here. This guarantees that they appear as a value in the field facet, even if they have a low or zero count.

clone

public FacetField clone()

Specified by:

clone in class DslCloneable