org.apache.lucene.facet.search.aggregator.associations

Class AssociationIntSumAggregator

java.lang.Object

org.apache.lucene.facet.search.aggregator.associations.AssociationIntSumAggregator

All Implemented Interfaces:

Aggregator

public class AssociationIntSumAggregator
extends Object
implements Aggregator

An Aggregator which computes the weight of a category as the sum of the integer values associated with it in the result documents.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
protected IntAssociationsPayloadIterator	associations
protected String	field
protected int[]	sumArray

Constructor Summary

Constructors

Constructor and Description
AssociationIntSumAggregator(int[] sumArray)
AssociationIntSumAggregator(String field, int[] sumArray)

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregate(int docID, float score, IntsRef ordinals) Aggregate the ordinals of the given document ID (and its score).
boolean	equals(Object obj)
int	hashCode()
boolean	setNextReader(AtomicReaderContext context) Sets the AtomicReaderContext for which Aggregator.aggregate(int, float, IntsRef) calls will be made.

Methods inherited from class java.lang.Object

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

Field Detail

field

protected final String field

sumArray

protected final int[] sumArray

associations

protected final IntAssociationsPayloadIterator associations

Constructor Detail

AssociationIntSumAggregator

public AssociationIntSumAggregator(int[] sumArray)
                            throws IOException

Throws:

IOException

AssociationIntSumAggregator

public AssociationIntSumAggregator(String field,
                           int[] sumArray)
                            throws IOException

Throws:

IOException

Method Detail

aggregate

public void aggregate(int docID,
             float score,
             IntsRef ordinals)
               throws IOException

Description copied from interface: Aggregator

Aggregate the ordinals of the given document ID (and its score). The given ordinals offset is always zero.

Specified by:

aggregate in interface Aggregator

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setNextReader

public boolean setNextReader(AtomicReaderContext context)
                      throws IOException

Description copied from interface: Aggregator

Sets the AtomicReaderContext for which Aggregator.aggregate(int, float, IntsRef) calls will be made. If this method returns false, Aggregator.aggregate(int, float, IntsRef) should not be called for this reader.

Specified by:

setNextReader in interface Aggregator

Throws:

IOException