Package lumis.portal.bigdata.query

Class DateHistogramAggregation

java.lang.Object

lumis.portal.bigdata.query.AbstractSubAggregationAwareAggregation

lumis.portal.bigdata.query.DateHistogramAggregation

All Implemented Interfaces:

IAggregation, IFieldAwareAggregation, IMultiBucketAggregation, ISubAggregationAwareAggregation

@StableMinor(version="17.0",
             sinceVersion="11.0")
public class DateHistogramAggregation
extends AbstractSubAggregationAwareAggregation

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

Since:

11.0.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateHistogramAggregation.Interval	Date histogram interval.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	id

Constructor Summary

Constructors

Constructor	Description
DateHistogramAggregation(java.lang.String id, DocumentTypeField field)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
DocumentTypeField	getField()	Returns the field this aggregation is bound to.
java.lang.String	getId()	Returns the aggregation identifier.
I	getInterval()	Returns the interval.
B	getLowerBound()	Returns the lowerBound.
I	getOffset()	Returns the offset.
B	getUpperBound()	Returns the upperBound.
void	setExtendedBounds(B lowerBound, B upperBound)	Sets the extended bounds. lowerBound and upperBound must be both not null or both null.
void	setInterval(I interval)	Sets the interval.
void	setOffset(I offset)	Sets the offset.

Methods inherited from class lumis.portal.bigdata.query.AbstractSubAggregationAwareAggregation

addSubAggregation, addSubAggregations, addSubAggregations, getSubAggregations

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 java.lang.String id

Constructor Detail

DateHistogramAggregation

public DateHistogramAggregation(java.lang.String id,
                                DocumentTypeField field)

Creates a new instance.

Parameters:

id - the aggregation identifier.

field - the field this aggregation will be performed on.

Since:

11.0.0

Method Detail

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.

getInterval

public I getInterval()

Returns the interval.

Returns:

the interval

Since:

11.0.0

setInterval

public void setInterval(I interval)

Sets the interval.

Parameters:

interval - the interval value to set.

Since:

11.0.0

getOffset

public I getOffset()

Returns the offset.

Returns:

the offset

Since:

11.0.0

setOffset

public void setOffset(I offset)

Sets the offset.

Parameters:

offset - the offset value to set.

Since:

11.0.0

setExtendedBounds

public void setExtendedBounds(B lowerBound,
                              B upperBound)

Sets the extended bounds.
lowerBound and upperBound must be both not null or both null. When a histogram aggregation has a lower and upper bounds, the histogram will return buckets for the given limits, even if no documents fill a given interval bucket.

Parameters:

lowerBound - the lower limit.

upperBound - the upper limit.

Since:

11.0.0

getLowerBound

public B getLowerBound()

Returns the lowerBound.

Returns:

the lowerBound

Since:

11.0.0

getUpperBound

public B getUpperBound()

Returns the upperBound.

Returns:

the upperBound

Since:

11.0.0

getId

public java.lang.String getId()

Description copied from interface: IAggregation

Returns the aggregation identifier.

Specified by:

getId in interface IAggregation

Returns:

the aggregation identifier.