lumis.portal.bigdata.query

Class HistogramAggregation

java.lang.Object

lumis.portal.bigdata.query.AbstractSubAggregationAwareAggregation

lumis.portal.bigdata.query.HistogramAggregation

All Implemented Interfaces:

IAggregation, IFieldAwareAggregation, IMultiBucketAggregation, ISubAggregationAwareAggregation

@StableMinor(version="12.3",
             sinceVersion="11.0")
public class HistogramAggregation
extends AbstractSubAggregationAwareAggregation

Histogram aggregation. Produces buckets for each interval in histogram. This aggregation produces an IHistogramAggregationResult.

Since:

11.0.0

Version:

$Revision: 23746 $ $Date: 2020-04-07 23:14:34 +0000 (Tue, 07 Apr 2020) $

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id

Constructor Summary

Constructors

Constructor and Description
HistogramAggregation(String id, DocumentTypeField field) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
DocumentTypeField	getField() Returns the field this aggregation is bound to.
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 String id

Constructor Detail

HistogramAggregation

public HistogramAggregation(String id,
                            DocumentTypeField field)

Creates a new instance.

Parameters:

id - the aggregation identifier.

field - the field this histogram 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 String getId()

Description copied from interface: IAggregation

Returns the aggregation identifier.

Specified by:

getId in interface IAggregation

Returns:

the aggregation identifier.