Package org.alfresco.search.model

Class RequestFacetField

java.lang.Object

org.alfresco.search.model.RequestFacetField

@Validated
public class RequestFacetField
extends Object

A simple facet field

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestFacetField.MethodEnum	Gets or Sets method
static class	RequestFacetField.SortEnum	Gets or Sets sort

Constructor Summary

Constructors

Constructor	Description
RequestFacetField()

Method Summary

Modifier and Type	Method	Description
RequestFacetField	addExcludeFiltersItem(String excludeFiltersItem)
boolean	equals(Object o)
RequestFacetField	excludeFilters(List<String> excludeFilters)
RequestFacetField	facetEnumCacheMinDf(Integer facetEnumCacheMinDf)
RequestFacetField	field(String field)
List<String>	getExcludeFilters()	Filter Queries with tags listed here will not be included in facet counts.
Integer	getFacetEnumCacheMinDf()	Get facetEnumCacheMinDf
String	getField()	The facet field
String	getLabel()	A label to include in place of the facet field
Integer	getLimit()	Get limit
RequestFacetField.MethodEnum	getMethod()	Get method
Integer	getMincount()	The minimum count required for a facet field to be included in the response.
Integer	getOffset()	Get offset
String	getPrefix()	Restricts the possible constraints to only indexed values with a specified prefix.
RequestFacetField.SortEnum	getSort()	Get sort
int	hashCode()
Boolean	isMissing()	When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints).
RequestFacetField	label(String label)
RequestFacetField	limit(Integer limit)
RequestFacetField	method(RequestFacetField.MethodEnum method)
RequestFacetField	mincount(Integer mincount)
RequestFacetField	missing(Boolean missing)
RequestFacetField	offset(Integer offset)
RequestFacetField	prefix(String prefix)
void	setExcludeFilters(List<String> excludeFilters)
void	setFacetEnumCacheMinDf(Integer facetEnumCacheMinDf)
void	setField(String field)
void	setLabel(String label)
void	setLimit(Integer limit)
void	setMethod(RequestFacetField.MethodEnum method)
void	setMincount(Integer mincount)
void	setMissing(Boolean missing)
void	setOffset(Integer offset)
void	setPrefix(String prefix)
void	setSort(RequestFacetField.SortEnum sort)
RequestFacetField	sort(RequestFacetField.SortEnum sort)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestFacetField

public RequestFacetField()

Method Detail

field

public RequestFacetField field(String field)

getField

public String getField()

The facet field

Returns:

field

setField

public void setField(String field)

label

public RequestFacetField label(String label)

getLabel

public String getLabel()

A label to include in place of the facet field

Returns:

label

setLabel

public void setLabel(String label)

prefix

public RequestFacetField prefix(String prefix)

getPrefix

public String getPrefix()

Restricts the possible constraints to only indexed values with a specified prefix.

Returns:

prefix

setPrefix

public void setPrefix(String prefix)

sort

public RequestFacetField sort(RequestFacetField.SortEnum sort)

getSort

public RequestFacetField.SortEnum getSort()

Get sort

Returns:

sort

setSort

public void setSort(RequestFacetField.SortEnum sort)

method

public RequestFacetField method(RequestFacetField.MethodEnum method)

getMethod

public RequestFacetField.MethodEnum getMethod()

Get method

Returns:

method

setMethod

public void setMethod(RequestFacetField.MethodEnum method)

missing

public RequestFacetField missing(Boolean missing)

isMissing

public Boolean isMissing()

When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints).

Returns:

missing

setMissing

public void setMissing(Boolean missing)

limit

public RequestFacetField limit(Integer limit)

getLimit

public Integer getLimit()

Get limit

Returns:

limit

setLimit

public void setLimit(Integer limit)

offset

public RequestFacetField offset(Integer offset)

getOffset

public Integer getOffset()

Get offset

Returns:

offset

setOffset

public void setOffset(Integer offset)

mincount

public RequestFacetField mincount(Integer mincount)

getMincount

public Integer getMincount()

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

Returns:

mincount

setMincount

public void setMincount(Integer mincount)

facetEnumCacheMinDf

public RequestFacetField facetEnumCacheMinDf(Integer facetEnumCacheMinDf)

getFacetEnumCacheMinDf

public Integer getFacetEnumCacheMinDf()

Get facetEnumCacheMinDf

Returns:

facetEnumCacheMinDf

setFacetEnumCacheMinDf

public void setFacetEnumCacheMinDf(Integer facetEnumCacheMinDf)

excludeFilters

public RequestFacetField excludeFilters(List<String> excludeFilters)

addExcludeFiltersItem

public RequestFacetField addExcludeFiltersItem(String excludeFiltersItem)

getExcludeFilters

public List<String> getExcludeFilters()

Filter Queries with tags listed here will not be included in facet counts. This is used for multi-select facetting.

Returns:

excludeFilters

setExcludeFilters

public void setExcludeFilters(List<String> excludeFilters)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object