Package org.nuxeo.elasticsearch.aggregate

Class SingleValueMetricAggregate

java.lang.Object

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

org.nuxeo.elasticsearch.aggregate.AggregateEsBase<org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue,BucketTerm>

org.nuxeo.elasticsearch.aggregate.SingleValueMetricAggregate

All Implemented Interfaces:

Aggregate<BucketTerm>

public class SingleValueMetricAggregate
extends AggregateEsBase<org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue,BucketTerm>

An aggregate that returns a single value.

Since:

10.3

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.opensearch.search.aggregations.AggregationBuilder	aggregationBuilder
protected Double	value

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
SingleValueMetricAggregate(AggregateDefinition definition, DocumentModel searchDocument)

Method Summary

Modifier and Type	Method	Description
org.opensearch.search.aggregations.AggregationBuilder	getEsAggregate()	Return the Elasticsearch aggregate builder
org.opensearch.index.query.QueryBuilder	getEsFilter()	Return the Elasticsearch aggregate filter corresponding to the selection
Double	getValue()
void	parseAggregation(org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue aggregation)	Extract the aggregation from the Elasticsearch response
org.opensearch.search.aggregations.AggregationBuilder	toBuilder(String type)	Creates an AggregationBuilder for the supplied type

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

getAggSize, 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

aggregationBuilder

protected final org.opensearch.search.aggregations.AggregationBuilder aggregationBuilder

value

protected Double value

Constructor Details

SingleValueMetricAggregate

public SingleValueMetricAggregate(AggregateDefinition definition,
 DocumentModel searchDocument)

Method Details

toBuilder

public org.opensearch.search.aggregations.AggregationBuilder toBuilder(String type)

Creates an AggregationBuilder for the supplied type

getEsAggregate

public org.opensearch.search.aggregations.AggregationBuilder getEsAggregate()

Description copied from class: AggregateEsBase

Return the Elasticsearch aggregate builder

Specified by:

getEsAggregate in class AggregateEsBase<org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue,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.metrics.NumericMetricsAggregation.SingleValue,BucketTerm>

parseAggregation

public void parseAggregation(org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue aggregation)

Description copied from class: AggregateEsBase

Extract the aggregation from the Elasticsearch response

Specified by:

parseAggregation in class AggregateEsBase<org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue,BucketTerm>

getValue

public Double getValue()