## Uses of Interface
org.apache.lucene.facet.taxonomy.TaxonomyReader

Packages that use TaxonomyReader
org.apache.lucene.facet.search: Faceted Search API
org.apache.lucene.facet.search.cache: Caching to speed up facets accumulation.
org.apache.lucene.facet.search.params: Parameters for Faceted Search
org.apache.lucene.facet.search.params.association: Association-based Parameters for Faceted Search.
org.apache.lucene.facet.search.results: Results of Faceted Search
org.apache.lucene.facet.search.sampling: Sampling for facets accumulation
org.apache.lucene.facet.taxonomy.directory: Taxonomy implemented using a Lucene-Index
org.apache.lucene.facet.util: Various utilities for faceted search

Uses of TaxonomyReader in org.apache.lucene.facet.search

Fields in org.apache.lucene.facet.search declared as TaxonomyReader
`protected TaxonomyReader` `FacetResultsHandler.taxonomyReader` Taxonomy for which facets are handled
`protected TaxonomyReader` `FacetsAccumulator.taxonomyReader`

Methods in org.apache.lucene.facet.search that return TaxonomyReader
`TaxonomyReader` `FacetResultsHandler.getTaxonomyReader()` Return taxonomy reader used for current facets accumulation operation.

Methods in org.apache.lucene.facet.search with parameters of type TaxonomyReader
`TotalFacetCounts` `TotalFacetCountsCache.getTotalCounts(org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomy, FacetIndexingParams facetIndexingParams, CategoryListCache clCache)` Get the total facet counts for a reader/taxonomy pair and facet indexing parameters.
`protected FacetsAccumulator` `FacetsCollector.initFacetsAccumulator(FacetSearchParams facetSearchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)` Create the `FacetsAccumulator` to be used.
`protected ScoredDocIdCollector` `FacetsCollector.initScoredDocCollector(FacetSearchParams facetSearchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)` Create a `ScoredDocIdCollector` to be used as the first phase of the facet collection.
`void` `TotalFacetCountsCache.load(File inputFile, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomy, FacetIndexingParams facetIndexingParams)` Load `TotalFacetCounts` matching input parameters from the provided outputFile and add them into the cache for the provided indexReader, taxonomy, and facetIndexingParams.

`void`

`TotalFacetCountsCache.store(File outputFile, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomy, FacetIndexingParams facetIndexingParams, CategoryListCache clCache)`
Store the `TotalFacetCounts` matching input parameters into the provided outputFile, making them available for a later call to `TotalFacetCountsCache.load(File, IndexReader, TaxonomyReader, FacetIndexingParams)`.

Constructors in org.apache.lucene.facet.search with parameters of type TaxonomyReader
`AdaptiveFacetsAccumulator(FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)` Create an `AdaptiveFacetsAccumulator`
`AdaptiveFacetsAccumulator(FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader, IntArrayAllocator intArrayAllocator, FloatArrayAllocator floatArrayAllocator)` Create an `AdaptiveFacetsAccumulator`
`FacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest)` Create a faceted search handler.
`FacetsAccumulator(FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)`
`FacetsCollector(FacetSearchParams facetSearchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)` Create a collector for accumulating facets while collecting documents during search.
`StandardFacetsAccumulator(FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)`
`StandardFacetsAccumulator(FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader, IntArrayAllocator intArrayAllocator, FloatArrayAllocator floatArrayAllocator)`
`TopKFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest)` Construct top-K results handler.
`TopKInEachNodeHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest)`

Uses of TaxonomyReader in org.apache.lucene.facet.search.cache

Methods in org.apache.lucene.facet.search.cache with parameters of type TaxonomyReader
`void` `CategoryListCache.loadAndRegister(CategoryListParams clp, org.apache.lucene.index.IndexReader reader, TaxonomyReader taxo, FacetIndexingParams iparams)` Load and register `CategoryListData`.

Uses of TaxonomyReader in org.apache.lucene.facet.search.params

Methods in org.apache.lucene.facet.search.params with parameters of type TaxonomyReader
`Aggregator` `CountFacetRequest.createAggregator(boolean useComplements, FacetArrays arrays, org.apache.lucene.index.IndexReader reader, TaxonomyReader taxonomy)`
`abstract Aggregator` `FacetRequest.createAggregator(boolean useComplements, FacetArrays arrays, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomy)` Create an aggregator for this facet request.
`Aggregator` `ScoreFacetRequest.createAggregator(boolean useComplements, FacetArrays arrays, org.apache.lucene.index.IndexReader reader, TaxonomyReader taxonomy)`
`CategoryListIterator` `FacetRequest.createCategoryListIterator(org.apache.lucene.index.IndexReader reader, TaxonomyReader taxo, FacetSearchParams sParams, int partition)` Create the category list iterator for the specified partition.
`FacetResultsHandler` `FacetRequest.createFacetResultsHandler(TaxonomyReader taxonomyReader)` Creates a new `FacetResultsHandler` that matches the request logic and current settings, such as `depth`, `limits-mode`, etc, as well as the passed in `TaxonomyReader`.

Uses of TaxonomyReader in org.apache.lucene.facet.search.params.association

Methods in org.apache.lucene.facet.search.params.association with parameters of type TaxonomyReader
`Aggregator` `AssociationIntSumFacetRequest.createAggregator(boolean useComplements, FacetArrays arrays, org.apache.lucene.index.IndexReader reader, TaxonomyReader taxonomy)`
`Aggregator` `AssociationFloatSumFacetRequest.createAggregator(boolean useComplements, FacetArrays arrays, org.apache.lucene.index.IndexReader reader, TaxonomyReader taxonomy)`

Uses of TaxonomyReader in org.apache.lucene.facet.search.results

Methods in org.apache.lucene.facet.search.results with parameters of type TaxonomyReader
`CategoryPath` `FacetResultNode.getLabel(TaxonomyReader taxonomyReader)` Category path of the category of this result.
`CategoryPath` `MutableFacetResultNode.getLabel(TaxonomyReader taxonomyReader)`

Uses of TaxonomyReader in org.apache.lucene.facet.search.sampling

Methods in org.apache.lucene.facet.search.sampling with parameters of type TaxonomyReader
`SampleFixer` `Sampler.getSampleFixer(org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader, FacetSearchParams searchParams)` Get a fixer of sample facet accumulation results.

Constructors in org.apache.lucene.facet.search.sampling with parameters of type TaxonomyReader
`SamplingAccumulator(Sampler sampler, FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)` Constructor...
`SamplingAccumulator(Sampler sampler, FacetSearchParams searchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader, IntArrayAllocator intArrayAllocator, FloatArrayAllocator floatArrayAllocator)` Constructor...

Uses of TaxonomyReader in org.apache.lucene.facet.taxonomy.directory

Classes in org.apache.lucene.facet.taxonomy.directory that implement TaxonomyReader
`class` `DirectoryTaxonomyReader` A `TaxonomyReader` which retrieves stored taxonomy information from a `Directory`.

Uses of TaxonomyReader in org.apache.lucene.facet.util

Methods in org.apache.lucene.facet.util with parameters of type TaxonomyReader
`static int` `PartitionsUtils.partitionOffset(FacetIndexingParams iParams, int partitionNumber, TaxonomyReader taxonomyReader)` Get the offset for a given partition.
`static int` `PartitionsUtils.partitionOffset(FacetSearchParams sParams, int partitionNumber, TaxonomyReader taxonomyReader)`
`static int` `PartitionsUtils.partitionSize(FacetIndexingParams indexingParams, TaxonomyReader taxonomyReader)` Get the partition size in this parameter, or return the size of the taxonomy, which is smaller.
`static int` `PartitionsUtils.partitionSize(FacetSearchParams sParams, TaxonomyReader taxonomyReader)`