org.elasticsearch.search.facet.terms
Interface TermsFacet

All Superinterfaces:

Facet, Iterable<TermsFacet.Entry>

All Known Implementing Classes:

InternalByteTermsFacet, InternalDoubleTermsFacet, InternalFloatTermsFacet, InternalIntTermsFacet, InternalIpTermsFacet, InternalLongTermsFacet, InternalShortTermsFacet, 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

static class	TermsFacet.ComparatorType Controls how the terms facets are ordered.
static interface	TermsFacet.Entry

Field Summary

static String

TYPE The type of the filter facet.

Method Summary

List<? extends TermsFacet.Entry>	entries() The terms and counts.
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.
long	missingCount() The number of docs missing a value.
long	otherCount() The count of terms other than the one provided by the entries.
long	totalCount() The total count of terms.

Methods inherited from interface org.elasticsearch.search.facet.Facet

getName, getType, name, type

Methods inherited from interface java.lang.Iterable

iterator

Field Detail

TYPE

static final String TYPE

The type of the filter facet.

See Also:

Constant Field Values

Method Detail

missingCount

long missingCount()

The number of docs missing a value.

getMissingCount

long getMissingCount()

The number of docs missing a value.

totalCount

long totalCount()

The total count of terms.

getTotalCount

long getTotalCount()

The total count of terms.

otherCount

long otherCount()

The count of terms other than the one provided by the entries.

getOtherCount

long getOtherCount()

The count of terms other than the one provided by the entries.

entries

List<? extends TermsFacet.Entry> entries()

The terms and counts.

getEntries

List<? extends TermsFacet.Entry> getEntries()

The terms and counts.