org.apache.lucene.facet.search

Class DepthOneFacetResultsHandler

java.lang.Object

org.apache.lucene.facet.search.FacetResultsHandler

org.apache.lucene.facet.search.DepthOneFacetResultsHandler

public class DepthOneFacetResultsHandler
extends FacetResultsHandler

A FacetResultsHandler which counts the top-K facets at depth 1 only and always labels all result categories. The results are always sorted by value, in descending order.

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

Field Summary

Fields inherited from class org.apache.lucene.facet.search.FacetResultsHandler

facetArrays, facetRequest, resolver, taxonomyReader

Constructor Summary

Constructors

Constructor and Description
DepthOneFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays, OrdinalValueResolver resolver)

Method Summary

Methods

Modifier and Type	Method and Description
FacetResult	compute() Computes the FacetResult for the given FacetArrays.

Methods inherited from class java.lang.Object

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

Constructor Detail

DepthOneFacetResultsHandler

public DepthOneFacetResultsHandler(TaxonomyReader taxonomyReader,
                           FacetRequest facetRequest,
                           FacetArrays facetArrays,
                           OrdinalValueResolver resolver)

Method Detail

compute

public final FacetResult compute()
                          throws IOException

Description copied from class: FacetResultsHandler

Computes the FacetResult for the given FacetArrays.

Specified by:

compute in class FacetResultsHandler

Throws:

IOException