org.elasticsearch.search.facet.range

Class RangeScriptFacetBuilder

java.lang.Object

org.elasticsearch.search.facet.FacetBuilder

org.elasticsearch.search.facet.range.RangeScriptFacetBuilder

All Implemented Interfaces:

ToXContent

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

Method Summary

Modifier and Type	Method and Description
RangeScriptFacetBuilder	addRange(double from, double to) Adds a range entry with explicit from and to.
RangeScriptFacetBuilder	addUnboundedFrom(double to) Adds a range entry with explicit to and unbounded from.
RangeScriptFacetBuilder	addUnboundedTo(double from) Adds a range entry with explicit from and unbounded to.
RangeScriptFacetBuilder	facetFilter(FilterBuilder filter)
RangeScriptFacetBuilder	global(boolean global) Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query).
RangeScriptFacetBuilder	keyScript(String keyScript)
RangeScriptFacetBuilder	lang(String lang) The language of the script.
RangeScriptFacetBuilder	nested(String nested) Sets the nested path the facet will execute on.
RangeScriptFacetBuilder	param(String name, Object value)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
RangeScriptFacetBuilder	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

RangeScriptFacetBuilder

public RangeScriptFacetBuilder(String name)

Method Detail

lang

public RangeScriptFacetBuilder lang(String lang)

The language of the script.

keyScript

public RangeScriptFacetBuilder keyScript(String keyScript)

valueScript

public RangeScriptFacetBuilder valueScript(String valueScript)

param

public RangeScriptFacetBuilder param(String name,
                                     Object value)

addRange

public RangeScriptFacetBuilder addRange(double from,
                                        double to)

Adds a range entry with explicit from and to.

Parameters:

from - The from range limit

to - The to range limit

addUnboundedTo

public RangeScriptFacetBuilder addUnboundedTo(double from)

Adds a range entry with explicit from and unbounded to.

Parameters:

from - the from range limit, to is unbounded.

addUnboundedFrom

public RangeScriptFacetBuilder addUnboundedFrom(double to)

Adds a range entry with explicit to and unbounded from.

Parameters:

to - the to range limit, from is unbounded.

global

public RangeScriptFacetBuilder global(boolean global)

Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). Defaults to false.

Overrides:

global in class FacetBuilder

facetFilter

public RangeScriptFacetBuilder facetFilter(FilterBuilder filter)

Overrides:

facetFilter in class FacetBuilder

nested

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