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

- Packages that use FacetsCollector
  Package | Description
  --- | ---
  org.apache.lucene.facet | Faceted search.
  org.apache.lucene.facet.range | Provides 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 and Description
    --- | ---
    `class` | `RandomSamplingFacetsCollector` Collects hits for subsequent faceting, using sampling if needed.

    Methods in org.apache.lucene.facet that return FacetsCollector
    Modifier and Type | Method and Description
    --- | ---
    `FacetsCollector` | FacetsCollectorManager.`newCollector()`
    `FacetsCollector` | FacetsCollectorManager.`reduce(Collection<FacetsCollector> collectors)`

    Methods in org.apache.lucene.facet with parameters of type FacetsCollector
    Modifier and Type | Method and Description
    --- | ---
    `protected Facets` | DrillSideways.`buildFacetsResult(FacetsCollector drillDowns, FacetsCollector[] drillSideways, String[] drillSidewaysDims)` Subclass can override to customize per-dim Facets impl.
    `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 and Description
    --- | ---
    `FacetsCollector` | FacetsCollectorManager.`reduce(Collection<FacetsCollector> collectors)`

    Constructors in org.apache.lucene.facet with parameters of type FacetsCollector
    Constructor and Description
    `LongValueFacetCounts(String field, FacetsCollector hits, boolean multiValued)` Create `LongValueFacetCounts`, using either single-valued `NumericDocValues` or multi-valued `SortedNumericDocValues` from the specified field.
    `LongValueFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits)` Create `LongValueFacetCounts`, using the provided `LongValuesSource`.
    `LongValueFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits, boolean multiValued)` Create `LongValueFacetCounts`, using the provided `LongValuesSource`.

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

    Constructors in org.apache.lucene.facet.range with parameters of type FacetsCollector
    Constructor and Description
    `DoubleRangeFacetCounts(String field, DoubleValuesSource valueSource, FacetsCollector hits, DoubleRange... ranges)` Create `RangeFacetCounts` using the provided `DoubleValuesSource`
    `DoubleRangeFacetCounts(String field, DoubleValuesSource valueSource, FacetsCollector hits, Query fastMatchQuery, DoubleRange... ranges)` Create `RangeFacetCounts`, using the provided `DoubleValuesSource`, and using the provided Query as a fastmatch: only documents matching the query are checked for the matching ranges.
    `DoubleRangeFacetCounts(String field, FacetsCollector hits, DoubleRange... ranges)` Create `RangeFacetCounts`, using `DoubleValues` from the specified field.
    `LongRangeFacetCounts(String field, FacetsCollector hits, LongRange... ranges)` Create `LongRangeFacetCounts`, using `LongValuesSource` from the specified field.
    `LongRangeFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits, LongRange... ranges)` Create `LongRangeFacetCounts`, using the provided `LongValuesSource`.
    `LongRangeFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits, Query fastMatchQuery, LongRange... ranges)` Create `LongRangeFacetCounts`, using the provided `LongValuesSource`, and using the provided Filter as a fastmatch: only documents passing the filter are checked for the matching ranges, which is helpful when the provided `LongValuesSource` is costly per-document, such as a geo distance.

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

    Constructors in org.apache.lucene.facet.sortedset with parameters of type FacetsCollector
    Constructor and 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 and Description
    --- | ---
    `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 FacetsCollector
    Constructor and 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)` Sole constructor.
    `TaxonomyFacetCounts(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc)` Create `TaxonomyFacetCounts`, which also counts all facet labels.
    `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`.

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