Package de.elo.ix.client.esearch.aggregations

Class Bucket

java.lang.Object

de.elo.ix.client.esearch.aggregations.Bucket

All Implemented Interfaces:

Serializable

public class Bucket
extends Object
implements Serializable

Represents a bucket within an AggregationResult for a bucket aggregation.

Since:

21.03.000.001

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,AggregationResult>	aggregations	In case the bucket aggregation query has defined sub-aggregations, this Map contains the results of that sub-aggregations within this bucket.
protected long	docCount	Number of documents belonging to the bucket's criteria.
protected String	from	For aggregations of type RANGE and DATE_RANGE, this value is a string representation of the lower bound of this bucket.
protected String	key	The bucket key identifying the bucket.
protected String	to	For aggregations of type RANGE and DATE_RANGE, this value is a string representation of the upper bound of this bucket.
protected AggregationTypeE	type	Type of aggregation.

Constructor Summary

Constructors

Constructor	Description
Bucket()
Bucket(String key)

Method Summary

Modifier and Type	Method	Description
Map<String,AggregationResult>	getAggregations()
long	getDocCount()
String	getFrom()
String	getKey()
String	getTo()
AggregationTypeE	getType()
void	setAggregations(Map<String,AggregationResult> aggregations)
void	setDocCount(long docCount)
void	setFrom(String from)
void	setKey(String key)
void	setTo(String to)
void	setType(AggregationTypeE type)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

key

protected String key

The bucket key identifying the bucket.

docCount

protected long docCount

Number of documents belonging to the bucket's criteria.

type

protected AggregationTypeE type

Type of aggregation.

from

protected String from

For aggregations of type RANGE and DATE_RANGE, this value is a string representation of the lower bound of this bucket.

to

protected String to

For aggregations of type RANGE and DATE_RANGE, this value is a string representation of the upper bound of this bucket.

aggregations

protected Map<String,AggregationResult> aggregations

In case the bucket aggregation query has defined sub-aggregations, this Map contains the results of that sub-aggregations within this bucket.

Constructor Details

Bucket

public Bucket()

Bucket

public Bucket(String key)

Method Details

getKey

public String getKey()

setKey

public void setKey(String key)

getDocCount

public long getDocCount()

setDocCount

public void setDocCount(long docCount)

getAggregations

public Map<String,AggregationResult> getAggregations()

setAggregations

public void setAggregations(Map<String,AggregationResult> aggregations)

getType

public AggregationTypeE getType()

setType

public void setType(AggregationTypeE type)

getFrom

public String getFrom()

setFrom

public void setFrom(String from)

getTo

public String getTo()

setTo

public void setTo(String to)

toString

public String toString()

Overrides:

toString in class Object