LuceneAggregatorFactory (Atlassian Jira - Server 10.7.0 API)

All Known Subinterfaces:: LuceneAggregatorRegistry

All Known Implementing Classes:: DefaultLuceneAggregatorRegistry

public interface LuceneAggregatorFactory

Factory for creating LuceneAggregators.

Since:: 10.5

Method Summary

Modifier and Type

Method

Description

LuceneAggregator<AggregationResult>

buildAggregator(SearchRequest searchRequest, Aggregation aggregation)

Build an LuceneAggregator for the given Aggregation.

default MultiAggregator

mapAggregationsRequest(SearchRequest searchRequest)

Map the given SearchRequest to a set of LuceneAggregators.

MultiAggregator

mapAggregationsRequest(SearchRequest searchRequest, AggregationsRequest aggregationsRequest)

Map the given SearchRequest to a set of LuceneAggregators.

Method Details
- mapAggregationsRequest
  
  default MultiAggregator mapAggregationsRequest(SearchRequest searchRequest)
  
  Map the given SearchRequest to a set of LuceneAggregators.
  
  Parameters:
  
  searchRequest - the request to map
  
  Returns:
  
  a multi-aggregator for the requested aggregations
- mapAggregationsRequest
  
  MultiAggregator mapAggregationsRequest(SearchRequest searchRequest, AggregationsRequest aggregationsRequest)
  
  Map the given SearchRequest to a set of LuceneAggregators.
  
  Parameters:
  
  searchRequest - the request to map
  
  aggregationsRequest - the aggregations to map
  
  Returns:
  
  a multi-aggregator for the requested aggregations
- buildAggregator
  
  LuceneAggregator<AggregationResult> buildAggregator(SearchRequest searchRequest, Aggregation aggregation)
  
  Build an LuceneAggregator for the given Aggregation.
  
  Parameters:
  
  searchRequest - the search request that is being executed
  
  aggregation - the aggregation to build an aggregator for
  
  Returns:
  
  the aggregator for the given aggregation