# Deprecated API

## Contents

- Classes
- Fields
- Methods
- Constructors

- Classes
  Class | Description
  --- | ---
  org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues | Only here for back-compat support. Should be removed with Lucene 10.
  org.apache.lucene.facet.taxonomy.CachedOrdinalsReader | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
  org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
  org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets | Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to taxonomy faceting,and is not intended as an extension point for user-created `Facets` implementations. If your code is relying on this, please migrate necessary functionality down into your own class.
  org.apache.lucene.facet.taxonomy.IntTaxonomyFacets | Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to `FastTaxonomyFacetCounts` and `TaxonomyFacetIntAssociations`,and is not intended as an extension point for user-created `Facets` implementations. If your code is relying on this, please migrate necessary functionality down into your own class.
  org.apache.lucene.facet.taxonomy.OrdinalsReader | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
  org.apache.lucene.facet.taxonomy.TaxonomyFacetCounts | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9. Please switch to `FastTaxonomyFacetCounts` or implement your own `Facets` implementation if you have custom needs.
  org.apache.lucene.facet.taxonomy.TaxonomyFacets | Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to taxonomy faceting,and is not intended as an extension point for user-created `Facets` implementations. If your code is relying on this, please migrate necessary functionality down into your own class.
  org.apache.lucene.facet.taxonomy.TaxonomyFacetSumFloatAssociations | This class is being deprecated in favor of `TaxonomyFacetFloatAssociations`, which provides more flexible aggregation functionality beyond just "sum"
  org.apache.lucene.facet.taxonomy.TaxonomyFacetSumIntAssociations | This class is being deprecated in favor of `TaxonomyFacetIntAssociations`, which provides more flexible aggregation functionality beyond just "sum"
  org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource | This class is being deprecated in favor of `TaxonomyFacetFloatAssociations`, which provides more flexible aggregation functionality beyond just "sum"
  org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache | Use `LruTaxonomyWriterCache` instead.

- Fields
  Field | Description
  --- | ---
  org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField.label | This field will be removed in a future version. `FacetsConfig.pathToString(String[])` can be applied to `path` as a replacement if string path is desired.

- Methods
  Method | Description
  --- | ---
  org.apache.lucene.facet.DrillSideways.createDrillDownFacetsCollector() | This is only used by the deprecated `DrillSideways.search(DrillDownQuery, Collector)` entry-point. Please use `DrillSideways.search(DrillDownQuery, CollectorManager)` instead, and leverage `DrillSideways.createDrillDownFacetsCollectorManager()` as necessary
  org.apache.lucene.facet.DrillSideways.search​(DrillDownQuery, Collector) | This method is deprecated in interest of the `DrillSideways.search(DrillDownQuery, CollectorManager)` method.
  org.apache.lucene.facet.FacetsConfig.dedupAndEncode​(IntsRef) | Starting in Lucene 9, we moved to a more straight-forward numeric doc values encoding and no longer support custom binary encodings.
  org.apache.lucene.facet.FacetUtils.loadOrdinalValues​(LeafReader, String) | Please do not rely on this method. It is added as a temporary measure for providing index backwards-compatibility with Lucene 8 and earlier indexes, and will be removed in Lucene 10.
  org.apache.lucene.facet.LongValueFacetCounts.getTopChildrenSortByCount​(int) | Please use `LongValueFacetCounts.getTopChildren(int, String, String...)` instead for the same functionality.
  org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader.encode​(IntsRef) | Custom binary formats are no longer directly supported for taxonomy faceting starting in Lucene 9
  org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader.getOrdinalsReader​(String) | Custom binary formats are no longer directly supported for taxonomy faceting starting in Lucene 9
  org.apache.lucene.facet.taxonomy.TaxonomyWriter.useNumericDocValuesForOrdinals() | Please don't rely on this method as it will be removed in Lucene 10. It's being introduced to support backwards-compatibility with Lucene 8 and earlier index formats temporarily.

- Constructors
  Constructor | Description
  --- | ---
  org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState​(IndexReader) | Users should explicitly provide facet configuration during instantiation. See `DefaultSortedSetDocValuesReaderState(IndexReader, FacetsConfig)`. To maintain all existing behavior, a "default" facet configuration can be provided with `FacetsConfig()`.
  org.apache.lucene.facet.taxonomy.TaxonomyFacetFloatAssociations​(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction, DoubleValuesSource) | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
  org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels.FacetLabelReader​(OrdinalsReader, LeafReaderContext) | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
  org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource​(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector, DoubleValuesSource) | Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9