org.elasticsearch.search.facet.terms
Interface TermsFacet

All Superinterfaces:

Facet, java.lang.Iterable<TermsFacet.Entry>

All Known Implementing Classes:

InternalByteTermsFacet, InternalDoubleTermsFacet, InternalFloatTermsFacet, InternalIntTermsFacet, InternalIpTermsFacet, InternalLongTermsFacet, InternalShortTermsFacet, InternalStringTermsFacet, InternalTermsFacet

public interface TermsFacet
extends Facet, java.lang.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 java.lang.String

TYPE The type of the filter facet.

Method Summary

java.util.List<? extends TermsFacet.Entry>	entries() The terms and counts.
java.util.List<? extends TermsFacet.Entry>	getEntries() The terms and counts.
long	getMissingCount() The number of docs missing a value.
long	missingCount() The number of docs missing a value.

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 java.lang.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.

entries

java.util.List<? extends TermsFacet.Entry> entries()

The terms and counts.

getEntries

java.util.List<? extends TermsFacet.Entry> getEntries()

The terms and counts.