public class TermsFacetBuilder extends FacetBuilder
FacetBuilder.Mode
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
facetFilter, global, mode, name, nested
EMPTY_PARAMS
Constructor and Description |
---|
TermsFacetBuilder(String name)
Construct a new term facet with the provided facet name.
|
Modifier and Type | Method and Description |
---|---|
TermsFacetBuilder |
allTerms(boolean allTerms)
Sets all possible terms to be loaded, even ones with 0 count.
|
TermsFacetBuilder |
exclude(Object... exclude)
A set of terms that will be excluded.
|
TermsFacetBuilder |
executionHint(String executionHint)
An execution hint to how the facet is computed.
|
TermsFacetBuilder |
facetFilter(FilterBuilder filter)
An additional facet filter that will further filter the documents the facet will be
executed on.
|
TermsFacetBuilder |
field(String field)
The field the terms will be collected from.
|
TermsFacetBuilder |
fields(String... fields)
The fields the terms will be collected from.
|
TermsFacetBuilder |
global(boolean global)
Should the fact run in global mode (not bounded by the search query) or not.
|
TermsFacetBuilder |
lang(String lang)
The language of the script.
|
TermsFacetBuilder |
nested(String nested)
Sets the nested path the facet will execute on.
|
TermsFacetBuilder |
order(TermsFacet.ComparatorType comparatorType)
The order by which to return the facets by.
|
TermsFacetBuilder |
param(String name,
Object value)
A parameter that will be passed to the script.
|
TermsFacetBuilder |
regex(String regex)
A regular expression to use in order to further filter terms.
|
TermsFacetBuilder |
regex(String regex,
int flags)
A regular expression (with flags) to use in order to further filter terms.
|
TermsFacetBuilder |
script(String script)
A script allowing to either modify or ignore a provided term (can be accessed using term var).
|
TermsFacetBuilder |
scriptField(String scriptField)
Define a script field that will control the terms that will be used (and not filtered, as is the
case when the script is provided on top of field / fields).
|
TermsFacetBuilder |
shardSize(int shardSize)
Sets the number of terms that will be returned from each shard.
|
TermsFacetBuilder |
size(int size)
The number of terms (and frequencies) to return.
|
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
addFilterFacetAndGlobal, mode
public TermsFacetBuilder(String name)
name
- The facet name.public TermsFacetBuilder global(boolean global)
global
in class FacetBuilder
public TermsFacetBuilder facetFilter(FilterBuilder filter)
facetFilter
in class FacetBuilder
public TermsFacetBuilder nested(String nested)
nested
in class FacetBuilder
public TermsFacetBuilder field(String field)
public TermsFacetBuilder fields(String... fields)
public TermsFacetBuilder scriptField(String scriptField)
public TermsFacetBuilder exclude(Object... exclude)
public TermsFacetBuilder size(int size)
public TermsFacetBuilder shardSize(int shardSize)
size
, therefore in this case it will fall back and be treated as being equal to
size.public TermsFacetBuilder regex(String regex)
public TermsFacetBuilder regex(String regex, int flags)
public TermsFacetBuilder order(TermsFacet.ComparatorType comparatorType)
TermsFacet.ComparatorType.COUNT
.public TermsFacetBuilder script(String script)
public TermsFacetBuilder lang(String lang)
public TermsFacetBuilder executionHint(String executionHint)
public TermsFacetBuilder param(String name, Object value)
name
- The name of the script parameter.value
- The value of the script parameter.public TermsFacetBuilder allTerms(boolean allTerms)
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
IOException
Copyright © 2009–2015. All rights reserved.