lumis.portal.bigdata.query

Class DateRangeAggregation

java.lang.Object

lumis.portal.bigdata.query.DateRangeAggregation

All Implemented Interfaces:

IAggregation, IFieldAwareAggregation, IMultiBucketAggregation, ISubAggregationAwareAggregation

@StableMinor(version="11.0",
             sinceVersion="11.0")
public class DateRangeAggregation
extends Object

Date range aggregation. Produces buckets for each interval in histogram. This aggregation produces an IDateRangeAggregationResult.

Since:

11.0.0

Version:

$Revision: 21880 $ $Date: 2018-09-21 20:07:19 +0000 (Fri, 21 Sep 2018) $

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id

Constructor Summary

Constructors

Constructor and Description
DateRangeAggregation(String id, DocumentTypeField field, Date startDate, Date endDate, int numRanges) Creates a new DateRangeAggregation that receives a start date (startDate), an end date (endDate) and a number of ranges to be produced (numRanges).

Method Summary

Modifier and Type	Method and Description
void	addSubAggregation(IAggregation aggregation) Adds the given sub-aggregation.
void	addSubAggregations(IAggregation... aggregations) Adds the given sub-aggregations.
void	addSubAggregations(List<IAggregation> aggregations) Adds the given sub-aggregations.
DocumentTypeField	getField() Returns the field this aggregation is bound to.
String	getId() Returns the aggregation identifier.
List<Range<T>>	getRanges() Returns the ranges.
List<IAggregation>	getSubAggregations() Returns an unmodifiable list of the sub-aggregations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.bigdata.query.IAggregation

getId

Field Detail

id

protected final String id

Constructor Detail

DateRangeAggregation

public DateRangeAggregation(String id,
                            DocumentTypeField field,
                            Date startDate,
                            Date endDate,
                            int numRanges)

Creates a new DateRangeAggregation that receives a start date (startDate), an end date (endDate) and a number of ranges to be produced (numRanges). It splits the interval (from start date to end date) in ranges and each range will produce a bucket (that will have the upper limit of the range as its key).

Parameters:

id - the aggregation identifier.

field - the aggregated field. Must be a date time field.

startDate - the start date.

endDate - the end date.

numRanges - the number of ranges to be produced.

Since:

11.0.0

Method Detail

getRanges

public List<Range<T>> getRanges()

Returns the ranges.

Returns:

the ranges.

Since:

11.0.0

getField

public DocumentTypeField getField()

Description copied from interface: IFieldAwareAggregation

Returns the field this aggregation is bound to.

Specified by:

getField in interface IFieldAwareAggregation

Returns:

the field this aggregation is bound to.

addSubAggregation

public void addSubAggregation(IAggregation aggregation)

Description copied from interface: ISubAggregationAwareAggregation

Adds the given sub-aggregation.

Specified by:

addSubAggregation in interface ISubAggregationAwareAggregation

getSubAggregations

public List<IAggregation> getSubAggregations()

Description copied from interface: ISubAggregationAwareAggregation

Returns an unmodifiable list of the sub-aggregations.

Specified by:

getSubAggregations in interface ISubAggregationAwareAggregation

Returns:

an unmodifiable list of the sub-aggregations.

addSubAggregations

public void addSubAggregations(IAggregation... aggregations)

Description copied from interface: ISubAggregationAwareAggregation

Adds the given sub-aggregations.

Specified by:

addSubAggregations in interface ISubAggregationAwareAggregation

Parameters:

aggregations - the sub-aggregations.

addSubAggregations

public void addSubAggregations(List<IAggregation> aggregations)

Description copied from interface: ISubAggregationAwareAggregation

Adds the given sub-aggregations.

Specified by:

addSubAggregations in interface ISubAggregationAwareAggregation

Parameters:

aggregations - the sub-aggregations.

getId

public String getId()

Description copied from interface: IAggregation

Returns the aggregation identifier.

Specified by:

getId in interface IAggregation

Returns:

the aggregation identifier.