org.apache.lucene.facet.associations

Class SumIntAssociationFacetsAggregator

java.lang.Object

org.apache.lucene.facet.associations.SumIntAssociationFacetsAggregator

All Implemented Interfaces:

FacetsAggregator

public class SumIntAssociationFacetsAggregator
extends Object
implements FacetsAggregator

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

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

Constructor Summary

Constructors

Constructor and Description
SumIntAssociationFacetsAggregator()

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.
OrdinalValueResolver	createOrdinalValueResolver(FacetRequest facetRequest, FacetArrays arrays) Creates the appropriate OrdinalValueResolver for this aggregator and the given FacetRequest.
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

SumIntAssociationFacetsAggregator

public SumIntAssociationFacetsAggregator()

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

createOrdinalValueResolver

public OrdinalValueResolver createOrdinalValueResolver(FacetRequest facetRequest,
                                              FacetArrays arrays)

Description copied from interface: FacetsAggregator

Creates the appropriate OrdinalValueResolver for this aggregator and the given FacetRequest. The request is passed so that compound aggregators can return the correct OrdinalValueResolver.

Specified by:

createOrdinalValueResolver in interface FacetsAggregator