org.apache.lucene.facet.associations

Class SumFloatAssociationFacetsAggregator

java.lang.Object

org.apache.lucene.facet.associations.SumFloatAssociationFacetsAggregator

All Implemented Interfaces:

FacetsAggregator

public class SumFloatAssociationFacetsAggregator
extends Object
implements FacetsAggregator

A FacetsAggregator which computes the weight of a category as the sum of the float values associated with it in the result documents. Assumes that the association encoded for each ordinal is CategoryFloatAssociation.

NOTE: this aggregator does not support rollupValues(FacetRequest, int, int[], int[], FacetArrays). It only aggregates the categories for which you added a CategoryAssociation.

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

Constructor Summary

Constructors

Constructor and Description
SumFloatAssociationFacetsAggregator()

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays) Aggregate the facets found in the given matching documents.
boolean	requiresDocScores() Returns true if this aggregator requires document scores.
void	rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays) Rollup the values of the given ordinal.

Methods inherited from class java.lang.Object

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

Constructor Detail

SumFloatAssociationFacetsAggregator

public SumFloatAssociationFacetsAggregator()

Method Detail

aggregate

public void aggregate(FacetsCollector.MatchingDocs matchingDocs,
             CategoryListParams clp,
             FacetArrays facetArrays)
               throws IOException

Description copied from interface: FacetsAggregator

Aggregate the facets found in the given matching documents.

Specified by:

aggregate in interface FacetsAggregator

Throws:

IOException

requiresDocScores

public boolean requiresDocScores()

Description copied from interface: FacetsAggregator

Returns true if this aggregator requires document scores.

Specified by:

requiresDocScores in interface FacetsAggregator

rollupValues

public void rollupValues(FacetRequest fr,
                int ordinal,
                int[] children,
                int[] siblings,
                FacetArrays facetArrays)

Description copied from interface: FacetsAggregator

Rollup the values of the given ordinal. This method is called when a category was indexed with CategoryListParams.OrdinalPolicy.NO_PARENTS. The given ordinal is the requested category, and you should use the children and siblings arrays to traverse its sub-tree.

Specified by:

rollupValues in interface FacetsAggregator