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

Class SumLuceneAggregator

java.lang.Object

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

All Implemented Interfaces:

LuceneAggregator<SumAggregationResult>

public class SumLuceneAggregator
extends Object
implements LuceneAggregator<SumAggregationResult>

Nested Class Summary

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

LuceneAggregator.SubAggregatorFactory

Constructor Summary

Constructors

Constructor	Description
SumLuceneAggregator(NumericField field, String fieldName)

Method Summary

Modifier and Type	Method	Description
void	aggregate(int docId)	Aggregate the value for the given document.
SumAggregationResult	getResult()	Get the result of the aggregation.
void	loadDocValues(org.apache.lucene.index.LeafReader reader)	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

Constructor Details

SumLuceneAggregator

public SumLuceneAggregator(NumericField field,
 String fieldName)

Method Details

loadDocValues

public void loadDocValues(org.apache.lucene.index.LeafReader reader)
                   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<SumAggregationResult>

Parameters:

reader - the LeafReader 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<SumAggregationResult>

Parameters:

docId - the document ID to aggregate

Throws:

IOException - if an error occurs while aggregating the value

getResult

public SumAggregationResult getResult()

Description copied from interface: LuceneAggregator

Get the result of the aggregation.

Specified by:

getResult in interface LuceneAggregator<SumAggregationResult>

Returns:

the result of the aggregation