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 inQueryDefinition
. 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 Description FacetDomain(java.util.List<Query> additionalFilters, java.util.List<java.lang.String> filtersToExclude)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FacetDomain
clone()
java.util.List<Query>
getAdditionalFilters()
java.util.List<java.lang.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
-
-
-
-
Constructor Detail
-
FacetDomain
public FacetDomain(java.util.List<Query> additionalFilters, java.util.List<java.lang.String> filtersToExclude)
-
-
Method Detail
-
getAdditionalFilters
public java.util.List<Query> getAdditionalFilters()
- Returns:
- filters used to narrow the domain this facet is computed over.
-
getExcludedFiltersByName
public java.util.List<java.lang.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 inQueryDefinition.getNamedFilters()
-
clone
public FacetDomain clone()
- Specified by:
clone
in classDslCloneable
-
-