org.elasticsearch.search.facet
Interface Facets

All Superinterfaces:

Iterable<Facet>

All Known Implementing Classes:

InternalFacets

public interface Facets
extends Iterable<Facet>

Facets of search action.

Method Summary

<T extends Facet> T	facet(Class<T> facetType, String name) Returns the facet by name already casted to the specified type.
<T extends Facet> T	facet(String name) A facet of the specified name.
List<Facet>	facets() The list of Facets.
Map<String,Facet>	facetsAsMap() Returns the Facets keyed by facet name.
Map<String,Facet>	getFacets() Returns the Facets keyed by facet name.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

facets

List<Facet> facets()

The list of Facets.

getFacets

Map<String,Facet> getFacets()

Returns the Facets keyed by facet name.

facetsAsMap

Map<String,Facet> facetsAsMap()

Returns the Facets keyed by facet name.

facet

<T extends Facet> T facet(Class<T> facetType,
                          String name)

Returns the facet by name already casted to the specified type.

facet

<T extends Facet> T facet(String name)

A facet of the specified name.