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

- Packages that use TaxonomyReader
  Package | Description
  --- | ---
  org.apache.lucene.facet | Faceted search.
  org.apache.lucene.facet.taxonomy | Taxonomy of Categories.
  org.apache.lucene.facet.taxonomy.directory | Taxonomy index implementation using on top of a Directory.

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

    Fields in org.apache.lucene.facet declared as TaxonomyReader
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected TaxonomyReader` | DrillSideways.`taxoReader` | `TaxonomyReader` passed to constructor.

    Constructors in org.apache.lucene.facet with parameters of type TaxonomyReader
    Constructor | Description
    --- | ---
    `DrillSideways​(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader)` | Create a new `DrillSideways` instance.
    `DrillSideways​(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader, SortedSetDocValuesReaderState state)` | Create a new `DrillSideways` instance, where some dimensions were indexed with `SortedSetDocValuesFacetField` and others were indexed with `FacetField`.
    `DrillSideways​(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader, SortedSetDocValuesReaderState state, ExecutorService executor)` | Create a new `DrillSideways` instance, where some dimensions were indexed with `SortedSetDocValuesFacetField` and others were indexed with `FacetField`.

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

    Fields in org.apache.lucene.facet.taxonomy declared as TaxonomyReader
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected TaxonomyReader` | TaxonomyFacets.`taxoReader` | Deprecated. `TaxonomyReader` provided to the constructor.

    Methods in org.apache.lucene.facet.taxonomy with type parameters of type TaxonomyReader
    Modifier and Type | Method | 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 | Description
    --- | --- | ---
    `protected abstract TaxonomyReader` | TaxonomyReader.`doOpenIfChanged()` | Implements the actual opening of a new `TaxonomyReader` instance if the taxonomy has changed.

    Methods in org.apache.lucene.facet.taxonomy with parameters of type TaxonomyReader
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | PrintTaxonomyStats.`printStats​(TaxonomyReader r, PrintStream out, boolean printTree)` | Recursively prints stats for all ordinals.
    `protected boolean` | IntTaxonomyFacets.`useHashTable​(FacetsCollector fc, TaxonomyReader taxoReader)` | Deprecated. Return true if a sparse hash table should be used for counting, instead of a dense int[].

    Constructors in org.apache.lucene.facet.taxonomy with parameters of type TaxonomyReader
    Constructor | Description
    --- | ---
    `FastTaxonomyFacetCounts​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Create `FastTaxonomyFacetCounts`, using the specified `indexFieldName` for ordinals.
    `FastTaxonomyFacetCounts​(String indexFieldName, IndexReader reader, TaxonomyReader taxoReader, FacetsConfig config)` | Create `FastTaxonomyFacetCounts`, using the specified `indexFieldName` for ordinals, and counting all non-deleted documents in the index.
    `FastTaxonomyFacetCounts​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Create `FastTaxonomyFacetCounts`, which also counts all facet labels.
    `FloatTaxonomyFacets​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)` | Deprecated. Constructor that defaults the aggregation function to `AssociationAggregationFunction.SUM`.
    `FloatTaxonomyFacets​(String indexFieldName, TaxonomyReader taxoReader, AssociationAggregationFunction aggregationFunction, FacetsConfig config)` | Deprecated. Constructor that uses the provided aggregation function.
    `IntTaxonomyFacets​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Deprecated. Constructor that defaults the aggregation function to `AssociationAggregationFunction.SUM`.
    `IntTaxonomyFacets​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, AssociationAggregationFunction aggregationFunction, FacetsCollector fc)` | Deprecated. Constructor that uses the provided aggregation function.
    `TaxonomyFacetCounts​(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Deprecated. Create `TaxonomyFacetCounts`, which also counts all facet labels.
    `TaxonomyFacetFloatAssociations​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction)` | Create `TaxonomyFacetFloatAssociations` against the specified index field.
    `TaxonomyFacetFloatAssociations​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction, DoubleValuesSource valuesSource)` | Create `TaxonomyFacetFloatAssociations` against the specified index field.
    `TaxonomyFacetFloatAssociations​(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction, DoubleValuesSource valuesSource)` | Deprecated. Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
    `TaxonomyFacetFloatAssociations​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction)` | Create `TaxonomyFacetFloatAssociations` against the default index field.
    `TaxonomyFacetFloatAssociations​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction, DoubleValuesSource valuesSource)` | Create `TaxonomyFacetFloatAssociations` against the default index field.
    `TaxonomyFacetIntAssociations​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction)` | Create `TaxonomyFacetIntAssociations` against the specified index field.
    `TaxonomyFacetIntAssociations​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction)` | Create `TaxonomyFacetIntAssociations` against the default index field.
    `TaxonomyFacetLabels​(TaxonomyReader taxoReader, String indexFieldName)` | Sole constructor.
    `TaxonomyFacets​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)` | Deprecated. Sole constructor.
    `TaxonomyFacetSumFloatAssociations​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Deprecated. Create `TaxonomyFacetSumFloatAssociations` against the specified index field.
    `TaxonomyFacetSumFloatAssociations​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Deprecated. Create `TaxonomyFacetSumFloatAssociations` against the default index field.
    `TaxonomyFacetSumIntAssociations​(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Deprecated. Create `TaxonomyFacetSumIntAssociations` against the specified index field.
    `TaxonomyFacetSumIntAssociations​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` | Deprecated. Create `TaxonomyFacetSumIntAssociations` against the default index field.
    `TaxonomyFacetSumValueSource​(String indexField, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource valueSource)` | Deprecated. Aggregates double facet values from the provided `DoubleValuesSource`, pulling ordinals from the specified indexed facet field.
    `TaxonomyFacetSumValueSource​(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource vs)` | Deprecated. Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
    `TaxonomyFacetSumValueSource​(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource valueSource)` | Deprecated. Aggregates double facet values from the provided `DoubleValuesSource`, pulling ordinals from the default indexed facet field `FacetsConfig.DEFAULT_INDEX_FIELD_NAME`.

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

    Subclasses of TaxonomyReader in org.apache.lucene.facet.taxonomy.directory
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `DirectoryTaxonomyReader` | A `TaxonomyReader` which retrieves stored taxonomy information from a `Directory`.