com.lucidworks.search.dsl.request

Class FacetDomain

java.lang.Object

com.lucidworks.search.dsl.DslBase

com.lucidworks.search.dsl.request.DslCloneable

com.lucidworks.search.dsl.request.FacetDomain

public class FacetDomain
extends DslCloneable

Changes to the set of documents the facet is computed on. Facets are computed over a set of documents, called the "domain" of the facet. By default this domain is documents matching the main query and filters in QueryDefinition. However, some use-cases require computing facets on a broader, narrower, or otherwise modified set of documents. FacetDomain encapsulates all the supported mechanisms for making these domain modifications.

Constructor Summary

Constructors

Constructor and Description
FacetDomain(List<Query> additionalFilters, List<String> filtersToExclude)

Method Summary

Modifier and Type	Method and Description
FacetDomain	clone()
List<Query>	getAdditionalFilters()
List<String>	getExcludedFiltersByName() A list of filter "names" to ignore when calculating facet counts.

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

FacetDomain

public FacetDomain(List<Query> additionalFilters,
                   List<String> filtersToExclude)

Method Detail

getAdditionalFilters

public List<Query> getAdditionalFilters()

Returns:

filters used to narrow the domain this facet is computed over.

getExcludedFiltersByName

public List<String> getExcludedFiltersByName()

A list of filter "names" to ignore when calculating facet counts. Each name in this list must correspond to the name of a filter specified in QueryDefinition.getNamedFilters()

clone

public FacetDomain clone()

Specified by:

clone in class DslCloneable