org.elasticsearch.search.facet.terms
Interface TermsFacet

All Superinterfaces:

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

All Known Implementing Classes:

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 class	TermsFacet.Entry

Nested classes/interfaces inherited from interface org.elasticsearch.search.facet.Facet

Facet.Type

Method Summary

TermsFacet.ComparatorType	comparatorType() The ordering of the results.
java.util.List<TermsFacet.Entry>	entries() The terms and counts.
java.lang.String	fieldName() The field name the terms were extracted from.
TermsFacet.ComparatorType	getComparatorType() The ordering of the results.
java.util.List<TermsFacet.Entry>	getEntries() The terms and counts.
java.lang.String	getFieldName() The field name the terms were extracted from.

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

getName, getType, name, type

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

fieldName

java.lang.String fieldName()

The field name the terms were extracted from.

getFieldName

java.lang.String getFieldName()

The field name the terms were extracted from.

comparatorType

TermsFacet.ComparatorType comparatorType()

The ordering of the results.

getComparatorType

TermsFacet.ComparatorType getComparatorType()

The ordering of the results.

entries

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

The terms and counts.

getEntries

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

The terms and counts.