public class FacetProperties extends Object implements Serializable
Modifier and Type | Class and Description |
---|---|
static class |
FacetProperties.SortFacetsBy |
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_FACET_LIMIT |
static int |
DEFAULT_MIN_FACET_COUNT |
static FacetProperties.SortFacetsBy |
DEFAULT_SORT_KEY |
Constructor and Description |
---|
FacetProperties(Set<String> facetAttributes)
Creates a FacetProperties object using default parameters to facet on the provided attributes.
|
FacetProperties(Set<String> facetAttributes,
FacetProperties.SortFacetsBy sortKey)
Creates a FacetProperties object using default parameters to facet on the provided attributes,
returning results sorted by the provided key.
|
FacetProperties(Set<String> facetAttributes,
FacetProperties.SortFacetsBy sortKey,
int facetLimit,
int minFacetCount)
Creates a FacetProperties object using the supplied parameters to facet on the provided
attributes, returning results sorted by the provided key.
|
Modifier and Type | Method and Description |
---|---|
Set<String> |
getFacetAttributes() |
int |
getFacetLimit() |
int |
getMinFacetCount() |
FacetProperties.SortFacetsBy |
getSortKey() |
public static final int DEFAULT_FACET_LIMIT
public static final int DEFAULT_MIN_FACET_COUNT
public static final FacetProperties.SortFacetsBy DEFAULT_SORT_KEY
public FacetProperties(Set<String> facetAttributes)
facetAttributes
- A set of attributes to facet onpublic FacetProperties(Set<String> facetAttributes, FacetProperties.SortFacetsBy sortKey)
facetAttributes
- A set of fields to facet onsortKey
- The key used to sort results - INDEX or COUNTpublic FacetProperties(Set<String> facetAttributes, FacetProperties.SortFacetsBy sortKey, int facetLimit, int minFacetCount)
facetAttributes
- A set of fields to facet onsortKey
- The key used to sort results - INDEX or COUNTfacetLimit
- The maximum number of returned facet values (Default is 100)minFacetCount
- The minimum count required for a facet value to be included in results
(Default is 0)public FacetProperties.SortFacetsBy getSortKey()
public int getFacetLimit()
public int getMinFacetCount()
This work is licensed under a Creative Commons Attribution 4.0 International License.