org.elasticsearch.search.facet.histogram

Class HistogramScriptFacetBuilder

java.lang.Object

org.elasticsearch.search.facet.FacetBuilder

org.elasticsearch.search.facet.histogram.HistogramScriptFacetBuilder

All Implemented Interfaces:

ToXContent

public class HistogramScriptFacetBuilder
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
HistogramScriptFacetBuilder(String name)

Method Summary

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

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

HistogramScriptFacetBuilder

public HistogramScriptFacetBuilder(String name)

Method Detail

lang

public HistogramScriptFacetBuilder lang(String lang)

The language of the script.

keyField

public HistogramScriptFacetBuilder keyField(String keyFieldName)

keyScript

public HistogramScriptFacetBuilder keyScript(String keyScript)

valueScript

public HistogramScriptFacetBuilder valueScript(String valueScript)

interval

public HistogramScriptFacetBuilder interval(long interval)

param

public HistogramScriptFacetBuilder param(String name,
                                         Object value)

comparator

public HistogramScriptFacetBuilder comparator(HistogramFacet.ComparatorType comparatorType)

global

public HistogramScriptFacetBuilder global(boolean global)

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

Overrides:

global in class FacetBuilder

facetFilter

public HistogramScriptFacetBuilder facetFilter(FilterBuilder filter)

Overrides:

facetFilter in class FacetBuilder

nested

public HistogramScriptFacetBuilder 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

toXContent

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

Throws:

IOException