org.elasticsearch.search.facet.statistical
Class StatisticalFacetBuilder

java.lang.Object
  org.elasticsearch.search.facet.AbstractFacetBuilder
      org.elasticsearch.search.facet.statistical.StatisticalFacetBuilder

All Implemented Interfaces:

ToXContent

public class StatisticalFacetBuilder
extends AbstractFacetBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.facet.AbstractFacetBuilder

facetFilter, name, nested, scope

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

StatisticalFacetBuilder(String name)

Method Summary

StatisticalFacetBuilder	facetFilter(FilterBuilder filter)
StatisticalFacetBuilder	field(String field)
StatisticalFacetBuilder	fields(String... fields) The fields the terms will be collected from.
StatisticalFacetBuilder	global(boolean global) Marks the facet to run in a global scope, not bounded by any query.
StatisticalFacetBuilder	nested(String nested) Sets the nested path the facet will execute on.
StatisticalFacetBuilder	scope(String scope) Marks the facet to run in a specific scope.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.facet.AbstractFacetBuilder

addFilterFacetAndGlobal

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticalFacetBuilder

public StatisticalFacetBuilder(String name)

Method Detail

field

public StatisticalFacetBuilder field(String field)

fields

public StatisticalFacetBuilder fields(String... fields)

The fields the terms will be collected from.

global

public StatisticalFacetBuilder global(boolean global)

Marks the facet to run in a global scope, not bounded by any query.

Overrides:

global in class AbstractFacetBuilder

scope

public StatisticalFacetBuilder scope(String scope)

Marks the facet to run in a specific scope.

Overrides:

scope in class AbstractFacetBuilder

facetFilter

public StatisticalFacetBuilder facetFilter(FilterBuilder filter)

Overrides:

facetFilter in class AbstractFacetBuilder

nested

public StatisticalFacetBuilder nested(String nested)

Sets the nested path the facet will execute on. A match (root object) will then cause all the nested objects matching the path to be computed into the facet.

Overrides:

nested in class AbstractFacetBuilder

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Throws:

IOException