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

Class FilterLuceneAggregator

java.lang.Object

com.atlassian.jira.search.lucene.aggregation.metric.FilterLuceneAggregator

All Implemented Interfaces:

LuceneAggregator<FilterAggregationResult>

public class FilterLuceneAggregator
extends Object
implements LuceneAggregator<FilterAggregationResult>

Lucene implementation of the FilterAggregation aggregator.

Since:

10.7

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.search.lucene.aggregation.LuceneAggregator

LuceneAggregator.SubAggregatorFactory

Constructor Summary

Constructors

Constructor	Description
FilterLuceneAggregator(org.apache.lucene.search.Query filter, org.apache.lucene.search.IndexSearcher indexSearcher, MultiAggregator subAggregator)

Method Summary

Modifier and Type	Method	Description
void	aggregate(int docId)	Aggregate the value for the given document.
FilterAggregationResult	getResult()	Get the result of the aggregation.
void	loadDocValues(org.apache.lucene.index.LeafReaderContext context)	Load the doc values for the field that this aggregator is aggregating on.

Methods inherited from class java.lang.Object

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

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

loadDocValues

Constructor Details

FilterLuceneAggregator

public FilterLuceneAggregator(org.apache.lucene.search.Query filter,
 org.apache.lucene.search.IndexSearcher indexSearcher,
 MultiAggregator subAggregator)

Method Details

loadDocValues

public void loadDocValues(org.apache.lucene.index.LeafReaderContext context)
                   throws IOException

Description copied from interface: LuceneAggregator

Load the doc values for the field that this aggregator is aggregating on.

Specified by:

loadDocValues in interface LuceneAggregator<FilterAggregationResult>

Parameters:

context - the LeafReaderContext for the current segment

Throws:

IOException - if an error occurs while loading the doc values

aggregate

public void aggregate(int docId)
               throws IOException

Description copied from interface: LuceneAggregator

Aggregate the value for the given document.

Specified by:

aggregate in interface LuceneAggregator<FilterAggregationResult>

Parameters:

docId - the document ID to aggregate

Throws:

IOException - if an error occurs while aggregating the value

getResult

public FilterAggregationResult getResult()

Description copied from interface: LuceneAggregator

Get the result of the aggregation.

Specified by:

getResult in interface LuceneAggregator<FilterAggregationResult>

Returns:

the result of the aggregation