Package org.elasticsearch.search.aggregations.bucket.range

Class DateRangeAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>

org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder<DateRangeAggregationBuilder,RangeAggregator.Range>

org.elasticsearch.search.aggregations.bucket.range.DateRangeAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class DateRangeAggregationBuilder
extends AbstractRangeBuilder<DateRangeAggregationBuilder,RangeAggregator.Range>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME
static org.elasticsearch.common.xcontent.ObjectParser<DateRangeAggregationBuilder,String>	PARSER
static ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder

keyed, rangeFactory, ranges

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

metadata

Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	DateRangeAggregationBuilder(String name)
	DateRangeAggregationBuilder(StreamInput in)	Read from a stream.
protected	DateRangeAggregationBuilder(DateRangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
DateRangeAggregationBuilder	addRange(double from, double to)	Same as addRange(String, double, double) but the key will be automatically generated based on from and to.
DateRangeAggregationBuilder	addRange(String key, double from, double to)	Add a new range to this aggregation.
DateRangeAggregationBuilder	addRange(String from, String to)	Same as addRange(String, String, String) but the key will be automatically generated based on from and to.
DateRangeAggregationBuilder	addRange(String key, String from, String to)	Add a new range to this aggregation.
DateRangeAggregationBuilder	addRange(String key, ZonedDateTime from, ZonedDateTime to)	Add a new range to this aggregation.
DateRangeAggregationBuilder	addRange(ZonedDateTime from, ZonedDateTime to)	Same as addRange(String, ZonedDateTime, ZonedDateTime) but the key will be automatically generated based on from and to.
DateRangeAggregationBuilder	addUnboundedFrom(double from)	Same as addUnboundedFrom(String, double) but the key will be computed automatically.
DateRangeAggregationBuilder	addUnboundedFrom(String from)	Same as addUnboundedFrom(String, String) but the key will be computed automatically.
DateRangeAggregationBuilder	addUnboundedFrom(String key, double from)	Add a new range with no upper bound.
DateRangeAggregationBuilder	addUnboundedFrom(String key, String from)	Add a new range with no upper bound.
DateRangeAggregationBuilder	addUnboundedFrom(String key, ZonedDateTime from)	Add a new range with no upper bound.
DateRangeAggregationBuilder	addUnboundedFrom(ZonedDateTime from)	Same as addUnboundedFrom(String, ZonedDateTime) but the key will be computed automatically.
DateRangeAggregationBuilder	addUnboundedTo(double to)	Same as addUnboundedTo(String, double) but the key will be computed automatically.
DateRangeAggregationBuilder	addUnboundedTo(String to)	Same as addUnboundedTo(String, String) but the key will be computed automatically.
DateRangeAggregationBuilder	addUnboundedTo(String key, double to)	Add a new range with no lower bound.
DateRangeAggregationBuilder	addUnboundedTo(String key, String to)	Add a new range with no lower bound.
DateRangeAggregationBuilder	addUnboundedTo(String key, ZonedDateTime to)	Add a new range with no lower bound.
DateRangeAggregationBuilder	addUnboundedTo(ZonedDateTime to)	Same as addUnboundedTo(String, ZonedDateTime) but the key will be computed automatically.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()	The name of the type of aggregation built by this builder.
protected DateRangeAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

Methods inherited from class org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder

addRange, bucketCardinality, doXContentBody, equals, hashCode, innerWriteTo, keyed, keyed, processRanges, ranges

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier> REGISTRY_KEY

PARSER

public static final org.elasticsearch.common.xcontent.ObjectParser<DateRangeAggregationBuilder,String> PARSER

Constructor Details

DateRangeAggregationBuilder

public DateRangeAggregationBuilder(String name)

DateRangeAggregationBuilder

protected DateRangeAggregationBuilder(DateRangeAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

DateRangeAggregationBuilder

public DateRangeAggregationBuilder(StreamInput in)
                            throws IOException

Read from a stream.

Throws:

IOException

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<DateRangeAggregationBuilder>

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Overrides:

defaultValueSourceType in class AbstractRangeBuilder<DateRangeAggregationBuilder,RangeAggregator.Range>

Returns:

The CoreValuesSourceType we expect this script to yield.

addRange

public DateRangeAggregationBuilder addRange(String key,
 String from,
 String to)

Add a new range to this aggregation.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the dates, inclusive

to - the upper bound on the dates, exclusive

addRange

public DateRangeAggregationBuilder addRange(String from,
 String to)

Same as addRange(String, String, String) but the key will be automatically generated based on from and to.

addUnboundedTo

public DateRangeAggregationBuilder addUnboundedTo(String key,
 String to)

Add a new range with no lower bound.

Parameters:

key - the key to use for this range in the response

to - the upper bound on the dates, exclusive

addUnboundedTo

public DateRangeAggregationBuilder addUnboundedTo(String to)

Same as addUnboundedTo(String, String) but the key will be computed automatically.

addUnboundedFrom

public DateRangeAggregationBuilder addUnboundedFrom(String key,
 String from)

Add a new range with no upper bound.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

addUnboundedFrom

public DateRangeAggregationBuilder addUnboundedFrom(String from)

Same as addUnboundedFrom(String, String) but the key will be computed automatically.

addRange

public DateRangeAggregationBuilder addRange(String key,
 double from,
 double to)

Add a new range to this aggregation.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the dates, inclusive

to - the upper bound on the dates, exclusive

addRange

public DateRangeAggregationBuilder addRange(double from,
 double to)

Same as addRange(String, double, double) but the key will be automatically generated based on from and to.

addUnboundedTo

public DateRangeAggregationBuilder addUnboundedTo(String key,
 double to)

Add a new range with no lower bound.

Parameters:

key - the key to use for this range in the response

to - the upper bound on the dates, exclusive

addUnboundedTo

public DateRangeAggregationBuilder addUnboundedTo(double to)

Same as addUnboundedTo(String, double) but the key will be computed automatically.

addUnboundedFrom

public DateRangeAggregationBuilder addUnboundedFrom(String key,
 double from)

Add a new range with no upper bound.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

addUnboundedFrom

public DateRangeAggregationBuilder addUnboundedFrom(double from)

Same as addUnboundedFrom(String, double) but the key will be computed automatically.

addRange

public DateRangeAggregationBuilder addRange(String key,
 ZonedDateTime from,
 ZonedDateTime to)

Add a new range to this aggregation.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the dates, inclusive

to - the upper bound on the dates, exclusive

addRange

public DateRangeAggregationBuilder addRange(ZonedDateTime from,
 ZonedDateTime to)

Same as addRange(String, ZonedDateTime, ZonedDateTime) but the key will be automatically generated based on from and to.

addUnboundedTo

public DateRangeAggregationBuilder addUnboundedTo(String key,
 ZonedDateTime to)

Add a new range with no lower bound.

Parameters:

key - the key to use for this range in the response

to - the upper bound on the dates, exclusive

addUnboundedTo

public DateRangeAggregationBuilder addUnboundedTo(ZonedDateTime to)

Same as addUnboundedTo(String, ZonedDateTime) but the key will be computed automatically.

addUnboundedFrom

public DateRangeAggregationBuilder addUnboundedFrom(String key,
 ZonedDateTime from)

Add a new range with no upper bound.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

addUnboundedFrom

public DateRangeAggregationBuilder addUnboundedFrom(ZonedDateTime from)

Same as addUnboundedFrom(String, ZonedDateTime) but the key will be computed automatically.

innerBuild

protected DateRangeAggregatorFactory innerBuild(AggregationContext context,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                         throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<DateRangeAggregationBuilder>

Throws:

IOException