## Uses of Class
org.apache.lucene.facet.FacetsConfig

- Packages that use FacetsConfig
  Package | Description
  --- | ---
  org.apache.lucene.facet | Faceted search.
  org.apache.lucene.facet.taxonomy | Taxonomy of Categories.

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

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

    Methods in org.apache.lucene.facet with parameters of type FacetsConfig
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | RandomSamplingFacetsCollector.`amortizeFacetCounts(FacetResult res, FacetsConfig config, IndexSearcher searcher)` Note: if you use a counting `Facets` implementation, you can amortize the sampled counts by calling this method.

    Constructors in org.apache.lucene.facet with parameters of type FacetsConfig
    Constructor and Description
    `DrillDownQuery(FacetsConfig config)` Creates a new `DrillDownQuery` without a base query, to perform a pure browsing query (equivalent to using `MatchAllDocsQuery` as base).
    `DrillDownQuery(FacetsConfig config, Query baseQuery)` Creates a new `DrillDownQuery` over the given base query.
    `DrillSideways(IndexSearcher searcher, FacetsConfig config, SortedSetDocValuesReaderState state)` Create a new `DrillSideways` instance, assuming the categories were indexed with `SortedSetDocValuesFacetField`.
    `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`.
    `FacetQuery(FacetsConfig facetsConfig, String dimension, String... path)` Creates a new `FacetQuery` filtering the query on the given dimension.
    `MultiFacetQuery(FacetsConfig facetsConfig, String dimension, String[]... paths)` Creates a new `MultiFacetQuery` filtering the query on the given dimension.

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

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

    Methods in org.apache.lucene.facet.taxonomy with parameters of type FacetsConfig
    Modifier and Type | Method and Description
    --- | ---
    `static void` | TaxonomyMergeUtils.`merge(Directory srcIndexDir, Directory srcTaxoDir, DirectoryTaxonomyWriter.OrdinalMap map, IndexWriter destIndexWriter, DirectoryTaxonomyWriter destTaxoWriter, FacetsConfig srcConfig)` Merges the given taxonomy and index directories and commits the changes to the given writers.

    Constructors in org.apache.lucene.facet.taxonomy with parameters of type FacetsConfig
    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.
    `OrdinalMappingLeafReader(LeafReader in, int[] ordinalMap, FacetsConfig srcConfig)` Wraps an LeafReader, mapping ordinals according to the ordinalMap, using the provided `FacetsConfig` which was used to build the wrapped reader.
    `TaxonomyFacetCounts(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetCounts`, which also counts all facet labels.
    `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 `DEFAULT_INDEX_FIELD_NAME`.

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