## 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 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.

  - ### 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, FacetsCollector hits, DoubleRange... ranges)` Create `RangeFacetCounts`, using `DoubleFieldSource` from the specified field.
    `DoubleRangeFacetCounts(String field, ValueSource valueSource, FacetsCollector hits, DoubleRange... ranges)` Create `RangeFacetCounts`, using the provided `ValueSource`.
    `DoubleRangeFacetCounts(String field, ValueSource valueSource, FacetsCollector hits, Query fastMatchQuery, DoubleRange... ranges)` Create `RangeFacetCounts`, using the provided `ValueSource`, and using the provided Query as a fastmatch: only documents passing the filter are checked for the matching ranges.
    `LongRangeFacetCounts(String field, FacetsCollector hits, LongRange... ranges)` Create `LongRangeFacetCounts`, using `LongFieldSource` from the specified field.
    `LongRangeFacetCounts(String field, ValueSource valueSource, FacetsCollector hits, LongRange... ranges)` Create `RangeFacetCounts`, using the provided `ValueSource`.
    `LongRangeFacetCounts(String field, ValueSource valueSource, FacetsCollector hits, Query fastMatchQuery, LongRange... ranges)` Create `RangeFacetCounts`, using the provided `ValueSource`, and using the provided Filter as a fastmatch: only documents passing the filter are checked for the matching ranges.

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

    Constructors in org.apache.lucene.facet.sortedset with parameters of type FacetsCollector
    Constructor and Description
    `SortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState state, FacetsCollector hits)` Sparse faceting: returns any dimension that had any hits, topCount labels per dimension.

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

    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.
    `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, ValueSource valueSource)` Aggreggates float facet values from the provided `ValueSource`, and pulls ordinals from the provided `OrdinalsReader`.
    `TaxonomyFacetSumValueSource(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, ValueSource valueSource)` Aggreggates float facet values from the provided `ValueSource`, pulling ordinals using `DocValuesOrdinalsReader` against the default indexed facet field `FacetsConfig.DEFAULT_INDEX_FIELD_NAME`.

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