Package org.nuxeo.elasticsearch.aggregate

Class SingleBucketAggregate

java.lang.Object

org.nuxeo.ecm.platform.query.core.AggregateBase<B>

org.nuxeo.elasticsearch.aggregate.AggregateEsBase<org.opensearch.search.aggregations.bucket.SingleBucketAggregation,BucketTerm>

org.nuxeo.elasticsearch.aggregate.SingleBucketAggregate

All Implemented Interfaces:

Aggregate<BucketTerm>

Direct Known Subclasses:

MissingAggregate

public abstract class SingleBucketAggregate
extends AggregateEsBase<org.opensearch.search.aggregations.bucket.SingleBucketAggregation,BucketTerm>

An aggregate that returns a single bucket.

Since:

10.3

Field Summary

Fields

Modifier and Type	Field	Description
protected long	docCount

Fields inherited from class org.nuxeo.elasticsearch.aggregate.AggregateEsBase

ES_MUTLI_LEVEL_SEP, MAX_AGG_SIZE, XPATH_SEP

Fields inherited from class org.nuxeo.ecm.platform.query.core.AggregateBase

bucketMap, buckets, definition, extendedBuckets, searchDocument, selection

Constructor Summary

Constructors

Constructor	Description
SingleBucketAggregate(AggregateDefinition definition, DocumentModel searchDocument)

Method Summary

Modifier and Type	Method	Description
long	getDocCount()
org.opensearch.index.query.QueryBuilder	getEsFilter()	Return the Elasticsearch aggregate filter corresponding to the selection
void	parseAggregation(org.opensearch.search.aggregations.bucket.SingleBucketAggregation aggregation)	Extract the aggregation from the Elasticsearch response

Methods inherited from class org.nuxeo.elasticsearch.aggregate.AggregateEsBase

getAggSize, getEsAggregate, getField, getXPathField

Methods inherited from class org.nuxeo.ecm.platform.query.core.AggregateBase

getBucket, getBucketMap, getBuckets, getDateRanges, getExtendedBuckets, getId, getProperties, getRanges, getSearchDocument, getSelection, getType, hasBucket, resetSelection, setBuckets, setSelection, toString

Methods inherited from class java.lang.Object

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

Field Details

docCount

protected long docCount

Constructor Details

SingleBucketAggregate

public SingleBucketAggregate(AggregateDefinition definition,
 DocumentModel searchDocument)

Method Details

parseAggregation

public void parseAggregation(org.opensearch.search.aggregations.bucket.SingleBucketAggregation aggregation)

Description copied from class: AggregateEsBase

Extract the aggregation from the Elasticsearch response

Specified by:

parseAggregation in class AggregateEsBase<org.opensearch.search.aggregations.bucket.SingleBucketAggregation,BucketTerm>

getEsFilter

public org.opensearch.index.query.QueryBuilder getEsFilter()

Description copied from class: AggregateEsBase

Return the Elasticsearch aggregate filter corresponding to the selection

Specified by:

getEsFilter in class AggregateEsBase<org.opensearch.search.aggregations.bucket.SingleBucketAggregation,BucketTerm>

getDocCount

public long getDocCount()