org.apache.lucene.facet.search
Class SumScoreFacetRequest

java.lang.Object
  extended by org.apache.lucene.facet.search.FacetRequest
      extended by org.apache.lucene.facet.search.SumScoreFacetRequest

public class SumScoreFacetRequest
extends FacetRequest

A FacetRequest for weighting facets by summing the scores of matching documents.

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

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.facet.search.FacetRequest
FacetRequest.ResultMode, FacetRequest.SortOrder
 
Field Summary
 
Fields inherited from class org.apache.lucene.facet.search.FacetRequest
categoryPath, numResults
 
Constructor Summary
SumScoreFacetRequest(CategoryPath path, int num)
          Create a score facet request for a given node in the taxonomy.
 
Method Summary
 FacetsAggregator createFacetsAggregator(FacetIndexingParams fip)
          Returns the FacetsAggregator which can aggregate the categories of this facet request.
 
Methods inherited from class org.apache.lucene.facet.search.FacetRequest
equals, getDepth, getNumLabel, getResultMode, getSortOrder, hashCode, setDepth, setNumLabel, setResultMode, setSortOrder, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SumScoreFacetRequest

public SumScoreFacetRequest(CategoryPath path,
                            int num)
Create a score facet request for a given node in the taxonomy.

Method Detail

createFacetsAggregator

public FacetsAggregator createFacetsAggregator(FacetIndexingParams fip)
Description copied from class: FacetRequest
Returns the FacetsAggregator which can aggregate the categories of this facet request. The aggregator is expected to aggregate category values into FacetArrays. If the facet request does not support that, e.g. RangeFacetRequest, it can return null. Note though that such requests require a dedicated FacetsAccumulator.

Specified by:
createFacetsAggregator in class FacetRequest


Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.