Package com.atlassian.jira.search.lucene.aggregation

Interface LuceneAggregatorRegistry

All Superinterfaces:

LuceneAggregatorFactory

All Known Implementing Classes:

DefaultLuceneAggregatorRegistry

public interface LuceneAggregatorRegistry
extends LuceneAggregatorFactory

Registry for LuceneAggregatorRegistry.LuceneAggregatorProviders.

Aggregators are stateful. This registry doesn't store the aggregators themselves, but rather the providers that can create them.

Since:

10.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LuceneAggregatorRegistry.LuceneAggregatorProvider<A extends Aggregation,R extends AggregationResult>	Interface for providing LuceneAggregators for Aggregations.

Method Summary

Modifier and Type	Method	Description
LuceneAggregatorRegistry.LuceneAggregatorProvider<Aggregation,AggregationResult>	getProvider(Aggregation aggregation)	Get the LuceneAggregatorRegistry.LuceneAggregatorProvider for the given Aggregation.
<A extends Aggregation, R extends AggregationResult> void	register(Class<A> clazz, LuceneAggregatorRegistry.LuceneAggregatorProvider<A,R> provider)	Register a LuceneAggregatorRegistry.LuceneAggregatorProvider for the given Aggregation class.

Methods inherited from interface com.atlassian.jira.search.lucene.aggregation.LuceneAggregatorFactory

buildAggregator, mapAggregationsRequest, mapAggregationsRequest

Method Details

getProvider

LuceneAggregatorRegistry.LuceneAggregatorProvider<Aggregation,AggregationResult> getProvider(Aggregation aggregation)

Get the LuceneAggregatorRegistry.LuceneAggregatorProvider for the given Aggregation.

Parameters:

aggregation - the aggregation definition

Returns:

the provider for the given aggregation

Throws:

IllegalArgumentException - if no provider is registered for the given aggregation

register

<A extends Aggregation,
R extends AggregationResult>
void register(Class<A> clazz,
 LuceneAggregatorRegistry.LuceneAggregatorProvider<A,R> provider)

Register a LuceneAggregatorRegistry.LuceneAggregatorProvider for the given Aggregation class.

If the given class is already registered, the new provider will replace the existing one.

Type Parameters:

A - the type of Aggregation that the provider can create aggregators for

R - the type of AggregationResult that the aggregator created by this provider will produce

Parameters:

clazz - the aggregation class

provider - the provider for the given aggregation