## 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 and Description
    --- | ---
    `protected TaxonomyReader` | DrillSideways.`taxoReader` `TaxonomyReader` passed to constructor.

    Constructors in org.apache.lucene.facet with parameters of type TaxonomyReader
    Constructor and 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 and Description
    --- | ---
    `protected TaxonomyReader` | TaxonomyFacets.`taxoReader` `TaxonomyReader` provided to the constructor.

    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.

    Methods in org.apache.lucene.facet.taxonomy with parameters of type TaxonomyReader
    Modifier and Type | Method and 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)` 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 and Description
    `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(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `FastTaxonomyFacetCounts`, using the specified `indexFieldName` for ordinals.
    `FastTaxonomyFacetCounts(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `FastTaxonomyFacetCounts`, which also counts all facet labels.
    `FloatTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)` Sole constructor.
    `IntTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Sole constructor.
    `TaxonomyFacetCounts(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetCounts`, which also counts all facet labels.
    `TaxonomyFacetLabels(TaxonomyReader taxoReader, String indexFieldName)` Sole constructor.
    `TaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)` Sole constructor.
    `TaxonomyFacetSumFloatAssociations(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetSumFloatAssociations` against the specified index field.
    `TaxonomyFacetSumFloatAssociations(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetSumFloatAssociations` against the default index field.
    `TaxonomyFacetSumIntAssociations(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetSumIntAssociations` against the specified index field.
    `TaxonomyFacetSumIntAssociations(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetSumIntAssociations` against the default index field.
    `TaxonomyFacetSumValueSource(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource vs)` Aggreggates float facet values from the provided `DoubleValuesSource`, and pulls ordinals from the provided `OrdinalsReader`.
    `TaxonomyFacetSumValueSource(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource valueSource)` Aggreggates double facet values from the provided `DoubleValuesSource`, pulling ordinals using `DocValuesOrdinalsReader` against 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 and Description
    --- | ---
    `class` | `DirectoryTaxonomyReader` A `TaxonomyReader` which retrieves stored taxonomy information from a `Directory`.

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