org.elasticsearch.search.facet
Interface Facets

All Superinterfaces:

java.lang.Iterable<Facet>

All Known Implementing Classes:

InternalFacets

public interface Facets
extends java.lang.Iterable<Facet>

Facets of search action.

Method Summary

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

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

facets

java.util.List<Facet> facets()

The list of Facets.

getFacets

java.util.Map<java.lang.String,Facet> getFacets()

Returns the Facets keyed by facet name.

facetsAsMap

java.util.Map<java.lang.String,Facet> facetsAsMap()

Returns the Facets keyed by facet name.

facet

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

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

facet

<T extends Facet> T facet(java.lang.String name)

A facet of the specified name.