org.apache.lucene.facet.search

Class FacetResultsHandler

java.lang.Object

org.apache.lucene.facet.search.FacetResultsHandler

Direct Known Subclasses:

DepthOneFacetResultsHandler, PartitionsFacetResultsHandler

public abstract class FacetResultsHandler
extends Object

Computes the top categories for a given FacetRequest.

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 FacetArrays	facetArrays
FacetRequest	facetRequest
TaxonomyReader	taxonomyReader

Constructor Summary

Constructors

Constructor and Description
FacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)

Method Summary

Methods

Modifier and Type	Method and Description
abstract 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

Field Detail

taxonomyReader

public final TaxonomyReader taxonomyReader

facetRequest

public final FacetRequest facetRequest

facetArrays

protected final FacetArrays facetArrays

Constructor Detail

FacetResultsHandler

public FacetResultsHandler(TaxonomyReader taxonomyReader,
                   FacetRequest facetRequest,
                   FacetArrays facetArrays)

Method Detail

compute

public abstract FacetResult compute()
                             throws IOException

Computes the FacetResult for the given FacetArrays.

Throws:

IOException