|
||||||||||
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.datehistogram.DateHistogramFacetBuilder
public class DateHistogramFacetBuilder
A facet builder of date histogram 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, nested, scope |
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent |
---|
EMPTY_PARAMS |
Constructor Summary | |
---|---|
DateHistogramFacetBuilder(String name)
Constructs a new date histogram facet with the provided facet logical name. |
Method Summary | |
---|---|
DateHistogramFacetBuilder |
comparator(DateHistogramFacet.ComparatorType comparatorType)
|
DateHistogramFacetBuilder |
facetFilter(FilterBuilder filter)
An additional filter used to further filter down the set of documents the facet will run on. |
DateHistogramFacetBuilder |
factor(float factor)
Sets the factor that will be used to multiply the value with before and divided by after the rounding of the results. |
DateHistogramFacetBuilder |
field(String field)
The field name to perform the histogram facet. |
DateHistogramFacetBuilder |
global(boolean global)
Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). |
DateHistogramFacetBuilder |
interval(String interval)
The interval used to control the bucket "size" where each key value of a hit will fall into. |
DateHistogramFacetBuilder |
keyField(String keyField)
The field name to use in order to control where the hit will "fall into" within the histogram entries. |
DateHistogramFacetBuilder |
lang(String lang)
The language of the value script. |
DateHistogramFacetBuilder |
nested(String nested)
Sets the nested path the facet will execute on. |
DateHistogramFacetBuilder |
param(String name,
Object value)
|
DateHistogramFacetBuilder |
postOffset(TimeValue postOffset)
Sets a post offset that will be applied after rounding the results. |
DateHistogramFacetBuilder |
postZone(String postZone)
Sets the post time zone to use when bucketing the values. |
DateHistogramFacetBuilder |
preOffset(TimeValue preOffset)
Sets a pre offset that will be applied before rounding the results. |
DateHistogramFacetBuilder |
preZone(String preZone)
Sets the pre time zone to use when bucketing the values. |
DateHistogramFacetBuilder |
preZoneAdjustLargeInterval(boolean preZoneAdjustLargeInterval)
Should pre zone be adjusted for large (day and above) intervals. |
DateHistogramFacetBuilder |
scope(String scope)
Marks the facet to run in a specific scope. |
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params)
|
DateHistogramFacetBuilder |
valueField(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). |
DateHistogramFacetBuilder |
valueScript(String valueScript)
|
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 DateHistogramFacetBuilder(String name)
name
- The logical name of the facetMethod Detail |
---|
public DateHistogramFacetBuilder field(String field)
keyField(String)
and valueField(String)
.
public DateHistogramFacetBuilder keyField(String keyField)
public DateHistogramFacetBuilder valueField(String valueField)
public DateHistogramFacetBuilder valueScript(String valueScript)
public DateHistogramFacetBuilder param(String name, Object value)
public DateHistogramFacetBuilder lang(String lang)
public DateHistogramFacetBuilder interval(String interval)
public DateHistogramFacetBuilder preZoneAdjustLargeInterval(boolean preZoneAdjustLargeInterval)
public DateHistogramFacetBuilder preZone(String preZone)
public DateHistogramFacetBuilder postZone(String postZone)
public DateHistogramFacetBuilder preOffset(TimeValue preOffset)
public DateHistogramFacetBuilder postOffset(TimeValue postOffset)
public DateHistogramFacetBuilder factor(float factor)
public DateHistogramFacetBuilder comparator(DateHistogramFacet.ComparatorType comparatorType)
public DateHistogramFacetBuilder global(boolean global)
global
in class AbstractFacetBuilder
public DateHistogramFacetBuilder scope(String scope)
scope
in class AbstractFacetBuilder
public DateHistogramFacetBuilder facetFilter(FilterBuilder filter)
facetFilter
in class AbstractFacetBuilder
public DateHistogramFacetBuilder nested(String nested)
nested
in class AbstractFacetBuilder
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |