org.elasticsearch.search.facet

Class FacetExecutor

java.lang.Object

org.elasticsearch.search.facet.FacetExecutor

Direct Known Subclasses:

CountDateHistogramFacetExecutor, CountHistogramFacetExecutor, FieldsTermsStringFacetExecutor, FilterFacetExecutor, FullHistogramFacetExecutor, GeoDistanceFacetExecutor, KeyValueRangeFacetExecutor, NestedFacetExecutor, QueryFacetExecutor, RangeFacetExecutor, ScriptHistogramFacetExecutor, ScriptRangeFacetExecutor, ScriptStatisticalFacetExecutor, ScriptTermsStringFieldFacetExecutor, StatisticalFacetExecutor, StatisticalFieldsFacetExecutor, TermsDoubleFacetExecutor, TermsLongFacetExecutor, TermsStatsDoubleFacetExecutor, TermsStatsLongFacetExecutor, TermsStatsStringFacetExecutor, TermsStringFacetExecutor, TermsStringOrdinalsFacetExecutor, UnmappedFieldExecutor, ValueDateHistogramFacetExecutor, ValueHistogramFacetExecutor, ValueScriptDateHistogramFacetExecutor, ValueScriptHistogramFacetExecutor

public abstract class FacetExecutor
extends Object

A facet processor ends up actually executing the relevant facet for a specific search request.

The facet executor requires at least the collector() method to be implemented, with an optional post() implementation if specific optimizations can be done.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetExecutor.Collector Simple extension to XCollector that implements methods that are typically not needed when doing collector based faceting.
static class	FacetExecutor.Mode The mode of the execution.
static class	FacetExecutor.Post A post class extends this class to implement post hits processing.

Constructor Summary

Constructors

Constructor and Description
FacetExecutor()

Method Summary

Modifier and Type	Method and Description
abstract InternalFacet	buildFacet(String facetName) Builds the facet.
abstract FacetExecutor.Collector	collector() A collector based facet implementation, collection the facet as hits match.
FacetExecutor.Post	post() A post based facet that executes the facet using the aggregated docs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FacetExecutor

public FacetExecutor()

Method Detail

buildFacet

public abstract InternalFacet buildFacet(String facetName)

Builds the facet.

collector

public abstract FacetExecutor.Collector collector()

A collector based facet implementation, collection the facet as hits match.

post

public FacetExecutor.Post post()

A post based facet that executes the facet using the aggregated docs. By default uses the FacetExecutor.Post.Collector based implementation.

Can be overridden if a more optimized non collector based implementation can be implemented.