TermsFacet

org.elasticsearch.search.facet.terms

Interface TermsFacet

All Superinterfaces:

Facet, Iterable<TermsFacet.Entry>

All Known Implementing Classes:

InternalDoubleTermsFacet, InternalLongTermsFacet, InternalStringTermsFacet, InternalTermsFacet
```
public interface TermsFacet
extends Facet, Iterable<TermsFacet.Entry>
```
Terms facet allows to return facets of the most popular terms within the search query.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
`static class`	`TermsFacet.ComparatorType` Controls how the terms facets are ordered.
`static interface`	`TermsFacet.Entry`

Field Summary

Fields

Modifier and Type	Field and Description
`static String`	`TYPE` The type of the filter facet.

Method Summary

All Methods

Instance Methods

Abstract Methods
Modifier and Type	Method and Description
`List<? extends TermsFacet.Entry>`	`getEntries()` The terms and counts.
`long`	`getMissingCount()` The number of docs missing a value.
`long`	`getOtherCount()` The count of terms other than the one provided by the entries.
`long`	`getTotalCount()` The total count of terms.

Methods inherited from interface org.elasticsearch.search.facet.Facet
getName, getType

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Field Detail
  - TYPE
```
static final String TYPE
```
    The type of the filter facet.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMissingCount
```
long getMissingCount()
```
    The number of docs missing a value.
  - getTotalCount
```
long getTotalCount()
```
    The total count of terms.
  - getOtherCount
```
long getOtherCount()
```
    The count of terms other than the one provided by the entries.
  - getEntries
```
List<? extends TermsFacet.Entry> getEntries()
```
    The terms and counts.