Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket.histogram

Class DateIntervalWrapper

java.lang.Object

org.elasticsearch.search.aggregations.bucket.histogram.DateIntervalWrapper

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class DateIntervalWrapper
extends Object
implements ToXContentFragment, Writeable

A class that handles all the parsing, bwc and deprecations surrounding date histogram intervals. - Provides parser helpers for the new calendar/fixed interval parameters - Can write new intervals to old format when streaming out - Provides a variety of helper methods to interpret the intervals as different types, depending on caller's need

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DateIntervalWrapper.IntervalTypeEnum

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DateIntervalWrapper()
DateIntervalWrapper(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	calendarInterval(DateHistogramInterval interval)	Sets the interval of the DateHistogram using calendar units (`1d`, `1w`, `1M`, etc).
Rounding	createRounding(ZoneId timeZone, long offset)
static <T extends DateIntervalConsumer<T>> void	declareIntervalFields(ObjectParser<T,String> parser)
boolean	equals(Object other)
void	fixedInterval(DateHistogramInterval interval)	Sets the interval of the DateHistogram using fixed units (`1ms`, `1s`, `10m`, `4h`, etc).
DateHistogramInterval	getAsCalendarInterval()	Returns the interval as a calendar interval.
DateHistogramInterval	getAsFixedInterval()	Returns the interval as a Fixed interval.
DateIntervalWrapper.IntervalTypeEnum	getIntervalType()
int	hashCode()
boolean	isEmpty()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

DateIntervalWrapper

public DateIntervalWrapper()

DateIntervalWrapper

public DateIntervalWrapper(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

declareIntervalFields

public static <T extends DateIntervalConsumer<T>>
void declareIntervalFields(ObjectParser<T,String> parser)

getIntervalType

public DateIntervalWrapper.IntervalTypeEnum getIntervalType()

getAsCalendarInterval

public DateHistogramInterval getAsCalendarInterval()

Returns the interval as a calendar interval. Throws an exception if the value cannot be converted into a calendar interval

calendarInterval

public void calendarInterval(DateHistogramInterval interval)

Sets the interval of the DateHistogram using calendar units (`1d`, `1w`, `1M`, etc). These units are calendar-aware, meaning they respect leap additions, variable days per month, etc. This is mutually exclusive with fixedInterval(DateHistogramInterval)

Parameters:

interval - The fixed interval to use

getAsFixedInterval

public DateHistogramInterval getAsFixedInterval()

Returns the interval as a Fixed interval. Throws an exception if the value cannot be converted into a fixed interval

fixedInterval

public void fixedInterval(DateHistogramInterval interval)

Sets the interval of the DateHistogram using fixed units (`1ms`, `1s`, `10m`, `4h`, etc). These are not calendar aware and are simply multiples of fixed, SI units. This is mutually exclusive with calendarInterval(DateHistogramInterval)

Parameters:

interval - The fixed interval to use

createRounding

public Rounding createRounding(ZoneId timeZone,
 long offset)

isEmpty

public boolean isEmpty()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object