|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.search.facet.AbstractFacetBuilder org.elasticsearch.search.facet.range.RangeFacetBuilder
public class RangeFacetBuilder
A facet builder of range facets.
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, scope |
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent |
---|
EMPTY_PARAMS |
Constructor Summary | |
---|---|
RangeFacetBuilder(java.lang.String name)
Constructs a new range facet with the provided facet logical name. |
Method Summary | |
---|---|
RangeFacetBuilder |
addRange(double from,
double to)
Adds a range entry with explicit from and to. |
RangeFacetBuilder |
addRange(java.lang.String from,
java.lang.String to)
|
RangeFacetBuilder |
addUnboundedFrom(double to)
Adds a range entry with explicit to and unbounded from. |
RangeFacetBuilder |
addUnboundedFrom(java.lang.String to)
|
RangeFacetBuilder |
addUnboundedTo(double from)
Adds a range entry with explicit from and unbounded to. |
RangeFacetBuilder |
addUnboundedTo(java.lang.String from)
|
RangeFacetBuilder |
facetFilter(XContentFilterBuilder filter)
An additional filter used to further filter down the set of documents the facet will run on. |
RangeFacetBuilder |
field(java.lang.String field)
The field name to perform the range facet. |
RangeFacetBuilder |
global(boolean global)
Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). |
RangeFacetBuilder |
keyField(java.lang.String keyField)
The field name to use in order to control where the hit will "fall into" within the range entries. |
RangeFacetBuilder |
scope(java.lang.String scope)
Marks the facet to run in a specific scope. |
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params)
|
RangeFacetBuilder |
valueField(java.lang.String valueField)
The field name to use as the value of the hit to compute data based on values within the interval (for example, total). |
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 |
---|
public RangeFacetBuilder(java.lang.String name)
name
- The logical name of the facetMethod Detail |
---|
public RangeFacetBuilder field(java.lang.String field)
keyField(String)
and valueField(String)
.
public RangeFacetBuilder keyField(java.lang.String keyField)
public RangeFacetBuilder valueField(java.lang.String valueField)
public RangeFacetBuilder addRange(double from, double to)
from
- The from range limitto
- The to range limitpublic RangeFacetBuilder addRange(java.lang.String from, java.lang.String to)
public RangeFacetBuilder addUnboundedTo(double from)
from
- the from range limit, to is unbounded.public RangeFacetBuilder addUnboundedTo(java.lang.String from)
public RangeFacetBuilder addUnboundedFrom(double to)
to
- the to range limit, from is unbounded.public RangeFacetBuilder addUnboundedFrom(java.lang.String to)
public RangeFacetBuilder global(boolean global)
global
in class AbstractFacetBuilder
public RangeFacetBuilder scope(java.lang.String scope)
scope
in class AbstractFacetBuilder
public RangeFacetBuilder facetFilter(XContentFilterBuilder filter)
facetFilter
in class AbstractFacetBuilder
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |