org.elasticsearch.search.facet

Interface FacetParser

All Known Implementing Classes:

DateHistogramFacetParser, FilterFacetParser, GeoDistanceFacetParser, HistogramFacetParser, QueryFacetParser, RangeFacetParser, StatisticalFacetParser, TermsFacetParser, TermsStatsFacetParser

public interface FacetParser

A facet parser parses the relevant matching "type" of facet into a FacetExecutor.

The parser also suggest the default FacetExecutor.Mode both for global and main executions.

Method Summary

Modifier and Type	Method and Description
FacetExecutor.Mode	defaultGlobalMode() The default mode to use when executed as a "global" (all docs) facet.
FacetExecutor.Mode	defaultMainMode() The default mode to use when executed as a "main" (query level) facet.
FacetExecutor	parse(String facetName, XContentParser parser, SearchContext context) Parses the facet into a FacetExecutor.
String[]	types() The type of the facet, for example, terms.

Method Detail

types

String[] types()

The type of the facet, for example, terms.

defaultMainMode

FacetExecutor.Mode defaultMainMode()

The default mode to use when executed as a "main" (query level) facet.

defaultGlobalMode

FacetExecutor.Mode defaultGlobalMode()

The default mode to use when executed as a "global" (all docs) facet.

parse

FacetExecutor parse(String facetName,
                    XContentParser parser,
                    SearchContext context)
             throws IOException

Parses the facet into a FacetExecutor.

Throws:

IOException