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

- Packages that use FacetsCollector
  Package | Description
  --- | ---
  org.apache.lucene.facet | Faceted search.
  org.apache.lucene.facet.facetset | Provides FacetSets faceting capabilities which allows users to facet on high dimensional field values.
  org.apache.lucene.facet.range | Provides range faceting capabilities.
  org.apache.lucene.facet.rangeonrange | Provides range on range faceting capabilities.
  org.apache.lucene.facet.sortedset | Provides faceting capabilities over facets that were indexed with `SortedSetDocValuesFacetField`.
  org.apache.lucene.facet.taxonomy | Taxonomy of Categories.

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

    Subclasses of FacetsCollector in org.apache.lucene.facet
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `RandomSamplingFacetsCollector` | Collects hits for subsequent faceting, using sampling if needed.

    Fields in org.apache.lucene.facet declared as FacetsCollector
    Modifier and Type | Field | Description
    --- | --- | ---
    `FacetsCollector` | DrillSideways.DrillSidewaysResult.`drillDownFacetsCollector` | FacetsCollector populated based on hits that match the full DrillDownQuery, treating all drill down dimensions as required clauses.
    `FacetsCollector[]` | DrillSideways.DrillSidewaysResult.`drillSidewaysFacetsCollector` | FacetsCollectors populated for each drill sideways dimension.

    Methods in org.apache.lucene.facet that return FacetsCollector
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected FacetsCollector` | DrillSideways.`createDrillDownFacetsCollector()` | Deprecated. This is only used by the deprecated `DrillSideways.search(DrillDownQuery, Collector)` entry-point.
    `FacetsCollector` | FacetsCollectorManager.`newCollector()` |
    `FacetsCollector` | FacetsCollectorManager.`reduce​(Collection<FacetsCollector> collectors)` |

    Methods in org.apache.lucene.facet with parameters of type FacetsCollector
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected Facets` | DrillSideways.`buildFacetsResult​(FacetsCollector drillDowns, FacetsCollector[] drillSideways, String[] drillSidewaysDims)` | Subclass can override to customize per-dim Facets impl.

    Method parameters in org.apache.lucene.facet with type arguments of type FacetsCollector
    Modifier and Type | Method | Description
    --- | --- | ---
    `FacetsCollector` | FacetsCollectorManager.`reduce​(Collection<FacetsCollector> collectors)` |

    Constructors in org.apache.lucene.facet with parameters of type FacetsCollector
    Constructor | Description
    --- | ---
    `DrillSidewaysResult​(Facets facets, TopDocs hits, FacetsCollector drillDownFacetsCollector, FacetsCollector[] drillSidewaysFacetsCollector, String[] drillSidewaysDims)` | Sole constructor.
    `LongValueFacetCounts​(String field, FacetsCollector hits)` | Create `LongValueFacetCounts`, using either single-valued `NumericDocValues` or multi-valued `SortedNumericDocValues` from the specified field (depending on what has been indexed).
    `LongValueFacetCounts​(String field, MultiLongValuesSource valuesSource, FacetsCollector hits)` | Create `LongValueFacetCounts`, using the provided `MultiLongValuesSource` if non-null.
    `LongValueFacetCounts​(String field, LongValuesSource valueSource, FacetsCollector hits)` | Create `LongValueFacetCounts`, using the provided `LongValuesSource` if non-null.
    `StringValueFacetCounts​(StringDocValuesReaderState state, FacetsCollector facetsCollector)` | Counts facets across the provided hits.

  - ### Uses of FacetsCollector in org.apache.lucene.facet.facetset

    Constructors in org.apache.lucene.facet.facetset with parameters of type FacetsCollector
    Constructor | Description
    --- | ---
    `MatchingFacetSetsCounts​(String field, FacetsCollector hits, FacetSetDecoder facetSetDecoder, FacetSetMatcher... facetSetMatchers)` | Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.
    `MatchingFacetSetsCounts​(String field, FacetsCollector hits, FacetSetDecoder facetSetDecoder, Query fastMatchQuery, FacetSetMatcher... facetSetMatchers)` | Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.

  - ### Uses of FacetsCollector in org.apache.lucene.facet.range

    Constructors in org.apache.lucene.facet.range with parameters of type FacetsCollector
    Constructor | Description
    --- | ---
    `DoubleRangeFacetCounts​(String field, FacetsCollector hits, DoubleRange... ranges)` | Create `RangeFacetCounts`, using double value from the specified field.
    `DoubleRangeFacetCounts​(String field, MultiDoubleValuesSource valuesSource, FacetsCollector hits, DoubleRange... ranges)` | Create `RangeFacetCounts`, using the provided `MultiDoubleValuesSource` if non-null.
    `DoubleRangeFacetCounts​(String field, MultiDoubleValuesSource valuesSource, FacetsCollector hits, Query fastMatchQuery, DoubleRange... ranges)` | Create `RangeFacetCounts`, using the provided `MultiDoubleValuesSource` if non-null.
    `DoubleRangeFacetCounts​(String field, DoubleValuesSource valueSource, FacetsCollector hits, DoubleRange... ranges)` | Create `RangeFacetCounts`, using the provided `DoubleValuesSource` if non-null.
    `DoubleRangeFacetCounts​(String field, DoubleValuesSource valueSource, FacetsCollector hits, Query fastMatchQuery, DoubleRange... ranges)` | Create `RangeFacetCounts`, using the provided `DoubleValuesSource` if non-null.
    `LongRangeFacetCounts​(String field, FacetsCollector hits, LongRange... ranges)` | Create `LongRangeFacetCounts` using long values from the specified field.
    `LongRangeFacetCounts​(String field, MultiLongValuesSource valuesSource, FacetsCollector hits, LongRange... ranges)` | Create `LongRangeFacetCounts`, using the provided `MultiLongValuesSource` if non-null.
    `LongRangeFacetCounts​(String field, MultiLongValuesSource valuesSource, FacetsCollector hits, Query fastMatchQuery, LongRange... ranges)` | Create `LongRangeFacetCounts`, using the provided `MultiLongValuesSource` if non-null.
    `LongRangeFacetCounts​(String field, LongValuesSource valueSource, FacetsCollector hits, LongRange... ranges)` | Create `LongRangeFacetCounts`, using the provided `LongValuesSource` if non-null.
    `LongRangeFacetCounts​(String field, LongValuesSource valueSource, FacetsCollector hits, Query fastMatchQuery, LongRange... ranges)` | Create `LongRangeFacetCounts`, using the provided `LongValuesSource` if non-null.

  - ### Uses of FacetsCollector in org.apache.lucene.facet.rangeonrange

    Constructors in org.apache.lucene.facet.rangeonrange with parameters of type FacetsCollector
    Constructor | Description
    --- | ---
    `DoubleRangeOnRangeFacetCounts​(String field, FacetsCollector hits, RangeFieldQuery.QueryType queryType, DoubleRange... ranges)` | Constructor without the fast match query, see other constructor description for more details.
    `DoubleRangeOnRangeFacetCounts​(String field, FacetsCollector hits, RangeFieldQuery.QueryType queryType, Query fastMatchQuery, DoubleRange... ranges)` | Represents counts for double range on range faceting.
    `LongRangeOnRangeFacetCounts​(String field, FacetsCollector hits, RangeFieldQuery.QueryType queryType, LongRange... ranges)` | Constructor without the fast match query, see other constructor description for more details.
    `LongRangeOnRangeFacetCounts​(String field, FacetsCollector hits, RangeFieldQuery.QueryType queryType, Query fastMatchQuery, LongRange... ranges)` | Represents counts for long range on range faceting.

  - ### Uses of FacetsCollector in org.apache.lucene.facet.sortedset

    Constructors in org.apache.lucene.facet.sortedset with parameters of type FacetsCollector
    Constructor | Description
    --- | ---
    `ConcurrentSortedSetDocValuesFacetCounts​(SortedSetDocValuesReaderState state, FacetsCollector hits, ExecutorService exec)` | Counts all facet dimensions across the provided hits.
    `SortedSetDocValuesFacetCounts​(SortedSetDocValuesReaderState state, FacetsCollector hits)` | Counts all facet dimensions across the provided hits.

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

    Methods in org.apache.lucene.facet.taxonomy with parameters of type FacetsCollector
    Modifier and Type | Method | Description
    --- | --- | ---
    `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 FacetsCollector
    Constructor | Description
    --- | ---
    `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.
    `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.
    `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`.