## Uses of Package
org.apache.lucene.facet.search

Packages that use org.apache.lucene.facet.search
org.apache.lucene.facet.associations: Allows associating arbitrary values with a category.
org.apache.lucene.facet.complements: Allows to cache the total counts of categories, so that during search which returns a large number of results (>60% of segment size), the complement set of matching documents is counted.
org.apache.lucene.facet.params: Facets indexing and search parameters.
org.apache.lucene.facet.partitions: Category Partitions
org.apache.lucene.facet.sampling: Facets sampling.
org.apache.lucene.facet.search: Facets search code.
org.apache.lucene.facet.util: Various utilities for faceted search

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.associations
FacetArrays Provider of arrays used for facets aggregation.
FacetRequest Request to accumulate facet information for a specified facet and possibly also some of its descendants, upto a specified depth.
FacetRequest.FacetArraysSource Specifies which array of `FacetArrays` should be used to resolve values.
FacetsAggregator Aggregates categories that were found in result documents (specified by `FacetsCollector.MatchingDocs`).
FacetsCollector.MatchingDocs Holds the documents that were matched in the `AtomicReaderContext`.

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.complements
Aggregator Aggregates the categories of documents given to `Aggregator.aggregate(int, float, IntsRef)`.
CountingAggregator A CountingAggregator updates a counter array with the size of the whole taxonomy, counting the number of times each category appears in the given set of documents.

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.params
CategoryListIterator An interface for obtaining the category ordinals of documents.
FacetRequest Request to accumulate facet information for a specified facet and possibly also some of its descendants, upto a specified depth.

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.partitions
FacetArrays Provider of arrays used for facets aggregation.
FacetRequest Request to accumulate facet information for a specified facet and possibly also some of its descendants, upto a specified depth.
FacetResult Result of faceted search.
FacetResultsHandler Computes the top categories for a given `FacetRequest`.

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.sampling
FacetArrays Provider of arrays used for facets aggregation.
FacetResult Result of faceted search.
FacetsAccumulator Driver for Accumulating facets of faceted search requests over given documents.
ScoredDocIDs Document IDs with scores for each, driving facets accumulation.
StandardFacetsAccumulator Standard implementation for `FacetsAccumulator`, utilizing partitions to save on memory.

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.search
Aggregator Aggregates the categories of documents given to `Aggregator.aggregate(int, float, IntsRef)`.
ArraysPool A thread-safe pool of `int[]` and `float[]` arrays.
CategoryListIterator An interface for obtaining the category ordinals of documents.
DepthOneFacetResultsHandler A `FacetResultsHandler` which counts the top-K facets at depth 1 only and always labels all result categories.
DrillDownQuery A `Query` for drill-down over `categories`.
DrillSideways.DrillSidewaysResult Represents the returned result from a drill sideways search.
FacetArrays Provider of arrays used for facets aggregation.
FacetRequest Request to accumulate facet information for a specified facet and possibly also some of its descendants, upto a specified depth.
FacetRequest.FacetArraysSource Specifies which array of `FacetArrays` should be used to resolve values.
FacetRequest.ResultMode Result structure manner of applying request's limits such as `FacetRequest.getNumLabel()` and `FacetRequest.numResults`.
FacetRequest.SortOrder Requested sort order for the results.
FacetResult Result of faceted search.
FacetResultNode Result of faceted search for a certain taxonomy node.
FacetResultsHandler Computes the top categories for a given `FacetRequest`.
FacetsAccumulator Driver for Accumulating facets of faceted search requests over given documents.
FacetsAggregator Aggregates categories that were found in result documents (specified by `FacetsCollector.MatchingDocs`).
FacetsCollector A `Collector` which executes faceted search and computes the weight of requested facets.
FacetsCollector.MatchingDocs Holds the documents that were matched in the `AtomicReaderContext`.
IntRollupFacetsAggregator A `FacetsAggregator` which implements `IntRollupFacetsAggregator.rollupValues(FacetRequest, int, int[], int[], FacetArrays)` by summing the values from `FacetArrays.getIntArray()`.
OrdinalsCache.CachedOrds Holds the cached ordinals in two paralel `int[]` arrays.
ScoredDocIDs Document IDs with scores for each, driving facets accumulation.
ScoredDocIDsIterator Iterator over document IDs and their scores.
StandardFacetsAccumulator Standard implementation for `FacetsAccumulator`, utilizing partitions to save on memory.
TopKInEachNodeHandler.AACO Maintains an array of `AggregatedCategory`.

Classes in org.apache.lucene.facet.search used by org.apache.lucene.facet.util
CategoryListIterator An interface for obtaining the category ordinals of documents.
FacetRequest Request to accumulate facet information for a specified facet and possibly also some of its descendants, upto a specified depth.
FacetResultNode Result of faceted search for a certain taxonomy node.
Heap Declares an interface for heap (and heap alike) structures, handling a given type T
ScoredDocIDs Document IDs with scores for each, driving facets accumulation.

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