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

- Packages that use TaxonomyReader
  Package | Description
  --- | ---
  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.partitions | Category Partitions
  org.apache.lucene.facet.sampling | Facets sampling.
  org.apache.lucene.facet.search | Facets search code.
  org.apache.lucene.facet.taxonomy | Taxonomy of Categories
  org.apache.lucene.facet.taxonomy.directory | Taxonomy index implementation using on top of a Directory.
  org.apache.lucene.facet.util | Various utilities for faceted search

- - ### Uses of TaxonomyReader in org.apache.lucene.facet.complements

    Methods in org.apache.lucene.facet.complements with parameters of type TaxonomyReader
    Modifier and Type | Method and Description
    --- | ---
    `TotalFacetCounts` | TotalFacetCountsCache.`getTotalCounts(IndexReader indexReader, TaxonomyReader taxonomy, FacetIndexingParams facetIndexingParams)` Get the total facet counts for a reader/taxonomy pair and facet indexing parameters.
    `void` | TotalFacetCountsCache.`load(File inputFile, 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, IndexReader indexReader, TaxonomyReader taxonomy, FacetIndexingParams facetIndexingParams)` Store the `TotalFacetCounts` matching input parameters into the provided outputFile, making them available for a later call to `TotalFacetCountsCache.load(File, IndexReader, TaxonomyReader, FacetIndexingParams)`.

  - ### Uses of TaxonomyReader in org.apache.lucene.facet.partitions

    Constructors in org.apache.lucene.facet.partitions with parameters of type TaxonomyReader
    Constructor and Description
    `PartitionsFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`

  - ### Uses of TaxonomyReader in org.apache.lucene.facet.sampling

    Methods in org.apache.lucene.facet.sampling with parameters of type TaxonomyReader
    Modifier and Type | Method and Description
    --- | ---
    `SampleFixer` | Sampler.`getSampleFixer(IndexReader indexReader, TaxonomyReader taxonomyReader, FacetSearchParams searchParams)` Get a fixer of sample facet accumulation results.

    Constructors in org.apache.lucene.facet.sampling with parameters of type TaxonomyReader
    Constructor and Description
    `SamplingAccumulator(Sampler sampler, FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)` Constructor...
    `SamplingAccumulator(Sampler sampler, FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)`

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

    Fields in org.apache.lucene.facet.search declared as TaxonomyReader
    Modifier and Type | Field and Description
    --- | ---
    `TaxonomyReader` | FacetsAccumulator.`taxonomyReader`
    `TaxonomyReader` | FacetResultsHandler.`taxonomyReader`
    `protected TaxonomyReader` | DrillSideways.`taxoReader`

    Methods in org.apache.lucene.facet.search with parameters of type TaxonomyReader
    Modifier and Type | Method and Description
    --- | ---
    `static FacetsCollector` | FacetsCollector.`create(FacetSearchParams fsp, IndexReader indexReader, TaxonomyReader taxoReader)` Creates a `FacetsCollector` using the `FacetsAccumulator` from `FacetsAccumulator.create(org.apache.lucene.facet.params.FacetSearchParams, org.apache.lucene.index.IndexReader, org.apache.lucene.facet.taxonomy.TaxonomyReader)`.
    `static FacetsAccumulator` | FacetsAccumulator.`create(FacetSearchParams fsp, IndexReader indexReader, TaxonomyReader taxoReader)` Creates an appropriate `FacetsAccumulator`, returning `FacetsAccumulator` when all requests are `CountFacetRequest` and only one partition is in use, otherwise `StandardFacetsAccumulator`.
    `Aggregator` | SumScoreFacetRequest.`createAggregator(boolean useComplements, FacetArrays arrays, TaxonomyReader taxonomy)`
    `Aggregator` | FacetRequest.`createAggregator(boolean useComplements, FacetArrays arrays, TaxonomyReader taxonomy)` Create an aggregator for this facet request.
    `Aggregator` | CountFacetRequest.`createAggregator(boolean useComplements, FacetArrays arrays, TaxonomyReader taxonomy)`

    Constructors in org.apache.lucene.facet.search with parameters of type TaxonomyReader
    Constructor and Description
    `AdaptiveFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)` Create an `AdaptiveFacetsAccumulator`
    `AdaptiveFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)` Create an `AdaptiveFacetsAccumulator`
    `DepthOneFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `DrillSideways(IndexSearcher searcher, TaxonomyReader taxoReader)` Create a new `DrillSideways` instance.
    `FacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `FacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)` Initializes the accumulator with the given search params, index reader and taxonomy reader.
    `FacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)` Initializes the accumulator with the given parameters as well as `FacetArrays`.
    `FloatFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `IntFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `StandardFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)`
    `StandardFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)`
    `TopKFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)` Construct top-K results handler.
    `TopKInEachNodeHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`

  - ### Uses of TaxonomyReader in org.apache.lucene.facet.taxonomy

    Methods in org.apache.lucene.facet.taxonomy with type parameters of type TaxonomyReader
    Modifier and Type | Method and Description
    --- | ---
    `static <T extends TaxonomyReader> T` | TaxonomyReader.`openIfChanged(T oldTaxoReader)` If the taxonomy has changed since the provided reader was opened, open and return a new `TaxonomyReader`; else, return `null`.

    Methods in org.apache.lucene.facet.taxonomy that return TaxonomyReader
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract TaxonomyReader` | TaxonomyReader.`doOpenIfChanged()` Implements the actual opening of a new `TaxonomyReader` instance if the taxonomy has changed.

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

    Subclasses of TaxonomyReader in org.apache.lucene.facet.taxonomy.directory
    Modifier and Type | Class and Description
    --- | ---
    `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
    Modifier and Type | Method and Description
    --- | ---
    `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 void` | PrintTaxonomyStats.`printStats(TaxonomyReader r, PrintStream out, boolean printTree)`

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