org.apache.lucene.facet.search.aggregator.association

Class AssociationFloatSumAggregator

java.lang.Object

org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator

All Implemented Interfaces:

Aggregator

public class AssociationFloatSumAggregator
extends java.lang.Object
implements Aggregator

An Aggregator which updates the weight of a category by summing the weights of the float association it finds for every document.

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 AssociationsPayloadIterator	associationsPayloadIterator
protected java.lang.String	field
protected float[]	sumArray

Constructor Summary

Constructors

Constructor and Description
AssociationFloatSumAggregator(org.apache.lucene.index.IndexReader reader, float[] sumArray)
AssociationFloatSumAggregator(java.lang.String field, org.apache.lucene.index.IndexReader reader, float[] sumArray)

Method Summary

Modifier and Type	Method and Description
void	aggregate(int ordinal) Collect (and do whatever an implementation deems appropriate) the category given by its ordinal.
boolean	equals(java.lang.Object obj)
int	hashCode()
void	setNextDoc(int docid, float score) Specify the document (and its score in the search) that the following Aggregator.aggregate(int) calls will pertain to.

Methods inherited from class java.lang.Object

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

Field Detail

field

protected final java.lang.String field

sumArray

protected final float[] sumArray

associationsPayloadIterator

protected final AssociationsPayloadIterator associationsPayloadIterator

Constructor Detail

AssociationFloatSumAggregator

public AssociationFloatSumAggregator(org.apache.lucene.index.IndexReader reader,
                                     float[] sumArray)
                              throws java.io.IOException

Throws:

java.io.IOException

AssociationFloatSumAggregator

public AssociationFloatSumAggregator(java.lang.String field,
                                     org.apache.lucene.index.IndexReader reader,
                                     float[] sumArray)
                              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

aggregate

public void aggregate(int ordinal)

Description copied from interface: Aggregator

Collect (and do whatever an implementation deems appropriate) the category given by its ordinal. This category belongs to a document given earlier by Aggregator.setNextDoc(int, float).

Specified by:

aggregate in interface Aggregator

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setNextDoc

public void setNextDoc(int docid,
                       float score)
                throws java.io.IOException

Description copied from interface: Aggregator

Specify the document (and its score in the search) that the following Aggregator.aggregate(int) calls will pertain to.

Specified by:

setNextDoc in interface Aggregator

Throws:

java.io.IOException