org.elasticsearch.search.facet.statistical

Class StatisticalScriptFacetBuilder

java.lang.Object

org.elasticsearch.search.facet.FacetBuilder

org.elasticsearch.search.facet.statistical.StatisticalScriptFacetBuilder

All Implemented Interfaces:

ToXContent

public class StatisticalScriptFacetBuilder
extends FacetBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.facet.FacetBuilder

FacetBuilder.Mode

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

facetFilter, global, mode, name, nested

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
StatisticalScriptFacetBuilder(String name)

Method Summary

Modifier and Type	Method and Description
StatisticalScriptFacetBuilder	facetFilter(FilterBuilder filter)
StatisticalScriptFacetBuilder	global(boolean global) Marks the facet to run in a global scope, not bounded by any query.
StatisticalScriptFacetBuilder	lang(String lang) The language of the script.
StatisticalScriptFacetBuilder	nested(String nested) Sets the nested path the facet will execute on.
StatisticalScriptFacetBuilder	param(String name, Object value)
StatisticalScriptFacetBuilder	script(String script)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

addFilterFacetAndGlobal, mode

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticalScriptFacetBuilder

public StatisticalScriptFacetBuilder(String name)

Method Detail

global

public StatisticalScriptFacetBuilder global(boolean global)

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

Overrides:

global in class FacetBuilder

facetFilter

public StatisticalScriptFacetBuilder facetFilter(FilterBuilder filter)

Overrides:

facetFilter in class FacetBuilder

nested

public StatisticalScriptFacetBuilder 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 FacetBuilder

lang

public StatisticalScriptFacetBuilder lang(String lang)

The language of the script.

script

public StatisticalScriptFacetBuilder script(String script)

param

public StatisticalScriptFacetBuilder param(String name,
                                           Object value)

toXContent

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

Throws:

IOException