Package org.nuxeo.elasticsearch.aggregate

Class NativeEsAggregate

java.lang.Object

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

org.nuxeo.elasticsearch.aggregate.AggregateEsBase<org.opensearch.search.aggregations.Aggregation,Bucket>

org.nuxeo.elasticsearch.aggregate.NativeEsAggregate

All Implemented Interfaces:

Aggregate<Bucket>

public class NativeEsAggregate
extends AggregateEsBase<org.opensearch.search.aggregations.Aggregation,Bucket>

This class is intended for internal/advanced use. It supports any ElasticSearch aggregate builder as a constructor parameter. However, it doesn't support Nuxeo page providers or the aggregation factory. The other aggregate classes are the preferred approach.

Since:

10.3

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.opensearch.search.aggregations.AggregationBuilder	nativeAggregation
protected final Consumer<org.opensearch.search.aggregations.Aggregation>	parser

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
NativeEsAggregate(AggregateDefinition definition, org.opensearch.search.aggregations.AggregationBuilder nativeAggregation, Consumer<org.opensearch.search.aggregations.Aggregation> parser)
NativeEsAggregate(org.opensearch.search.aggregations.AggregationBuilder nativeAggregation, Consumer<org.opensearch.search.aggregations.Aggregation> parser)	Construct the aggregate using an ElasticSearch aggregate builder and a parser that will consume the response.

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
protected static AggregateDefinition	makeDefinition(org.opensearch.search.aggregations.AggregationBuilder nativeAggregation)	For backwards compatibility make an AggregateDefinition.
void	parseAggregation(org.opensearch.search.aggregations.Aggregation aggregation)	Extract the aggregation from the Elasticsearch response
String	toString()

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

Methods inherited from class java.lang.Object

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

Field Details

nativeAggregation

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

parser

protected final Consumer<org.opensearch.search.aggregations.Aggregation> parser

Constructor Details

NativeEsAggregate

public NativeEsAggregate(AggregateDefinition definition,
 org.opensearch.search.aggregations.AggregationBuilder nativeAggregation,
 Consumer<org.opensearch.search.aggregations.Aggregation> parser)

NativeEsAggregate

public NativeEsAggregate(org.opensearch.search.aggregations.AggregationBuilder nativeAggregation,
 Consumer<org.opensearch.search.aggregations.Aggregation> parser)

Construct the aggregate using an ElasticSearch aggregate builder and a parser that will consume the response.

Method Details

makeDefinition

protected static AggregateDefinition makeDefinition(org.opensearch.search.aggregations.AggregationBuilder nativeAggregation)

For backwards compatibility make an AggregateDefinition.

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.Aggregation,Bucket>

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.Aggregation,Bucket>

parseAggregation

public void parseAggregation(org.opensearch.search.aggregations.Aggregation aggregation)

Description copied from class: AggregateEsBase

Extract the aggregation from the Elasticsearch response

Specified by:

parseAggregation in class AggregateEsBase<org.opensearch.search.aggregations.Aggregation,Bucket>

toString

public String toString()

Overrides:

toString in class AggregateBase<Bucket>