Package org.hibernate.search.backend.elasticsearch.search.aggregation.impl

Class AbstractElasticsearchNestableAggregation<A>

java.lang.Object

org.hibernate.search.backend.elasticsearch.search.aggregation.impl.AbstractElasticsearchAggregation<A>

org.hibernate.search.backend.elasticsearch.search.aggregation.impl.AbstractElasticsearchNestableAggregation<A>

All Implemented Interfaces:

ElasticsearchSearchAggregation<A>, SearchAggregation<A>

Direct Known Subclasses:

AbstractElasticsearchBucketAggregation

public abstract class AbstractElasticsearchNestableAggregation<A>
extends AbstractElasticsearchAggregation<A>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractElasticsearchNestableAggregation.AbstractBuilder<A>

Method Summary

Modifier and Type	Method	Description
protected abstract A	doExtract(com.google.gson.JsonObject aggregationResult, AggregationExtractContext context)
protected abstract com.google.gson.JsonObject	doRequest(AggregationRequestContext context)
A	extract(com.google.gson.JsonObject aggregationResult, AggregationExtractContext context)	Extract the result of the aggregation from the response.
protected boolean	isNested()
com.google.gson.JsonObject	request(AggregationRequestContext context)	Contribute to the request, making sure that the requirements for this aggregation are met.

Methods inherited from class org.hibernate.search.backend.elasticsearch.search.aggregation.impl.AbstractElasticsearchAggregation

getIndexNames

Methods inherited from class java.lang.Object

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

Method Detail

request

public final com.google.gson.JsonObject request(AggregationRequestContext context)

Description copied from interface: ElasticsearchSearchAggregation

Contribute to the request, making sure that the requirements for this aggregation are met.

Parameters:

context - The request context, to access context information or store information that will be made available later to the ElasticsearchSearchAggregation.extract(JsonObject, AggregationExtractContext) method.

Returns:

The JSON object representing the aggregation.

doRequest

protected abstract com.google.gson.JsonObject doRequest(AggregationRequestContext context)

extract

public final A extract(com.google.gson.JsonObject aggregationResult,
                       AggregationExtractContext context)

Description copied from interface: ElasticsearchSearchAggregation

Extract the result of the aggregation from the response.

Parameters:

aggregationResult - The part of the response body relevant to the aggregation to extract.

context - The extract context, to extract information from the response's JSON body or retrieve information that was stored earlier in the ElasticsearchSearchAggregation.request(AggregationRequestContext) method.

Returns:

The aggregation result extracted from the response.

doExtract

protected abstract A doExtract(com.google.gson.JsonObject aggregationResult,
                               AggregationExtractContext context)

isNested

protected final boolean isNested()