## Uses of Class
org.apache.lucene.facet.search.FacetArrays

- Packages that use FacetArrays
  Package | Description
  --- | ---
  org.apache.lucene.facet.associations | Allows associating arbitrary values with a category.
  org.apache.lucene.facet.partitions | Category Partitions
  org.apache.lucene.facet.sampling | Facets sampling.
  org.apache.lucene.facet.search | Facets search code.

- - ### Uses of FacetArrays in org.apache.lucene.facet.associations

    Methods in org.apache.lucene.facet.associations with parameters of type FacetArrays
    Modifier and Type | Method and Description
    --- | ---
    `void` | SumIntAssociationFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `void` | SumFloatAssociationFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `void` | MultiAssociationsFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `double` | AssociationIntSumFacetRequest.`getValueOf(FacetArrays arrays, int ordinal)`
    `double` | AssociationFloatSumFacetRequest.`getValueOf(FacetArrays arrays, int ordinal)`
    `void` | SumIntAssociationFacetsAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)`
    `void` | SumFloatAssociationFacetsAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)`
    `void` | MultiAssociationsFacetsAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)`

  - ### Uses of FacetArrays in org.apache.lucene.facet.partitions

    Methods in org.apache.lucene.facet.partitions with parameters of type FacetArrays
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | PartitionsFacetResultsHandler.`isSelfPartition(int ordinal, FacetArrays facetArrays, int offset)` Check if an array contains the partition which contains ordinal

    Constructors in org.apache.lucene.facet.partitions with parameters of type FacetArrays
    Constructor and Description
    `PartitionsFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`

  - ### Uses of FacetArrays in org.apache.lucene.facet.sampling

    Constructors in org.apache.lucene.facet.sampling with parameters of type FacetArrays
    Constructor and Description
    `SamplingAccumulator(Sampler sampler, FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)`

  - ### Uses of FacetArrays in org.apache.lucene.facet.search

    Subclasses of FacetArrays in org.apache.lucene.facet.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ReusingFacetArrays` A `FacetArrays` which uses the `ArraysPool` to allocate new arrays and pool them on `free()`.

    Fields in org.apache.lucene.facet.search declared as FacetArrays
    Modifier and Type | Field and Description
    --- | ---
    `FacetArrays` | FacetsAccumulator.`facetArrays`
    `protected FacetArrays` | FacetResultsHandler.`facetArrays`

    Methods in org.apache.lucene.facet.search with parameters of type FacetArrays
    Modifier and Type | Method and Description
    --- | ---
    `void` | SumScoreFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `void` | PerCategoryListAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `abstract void` | IntRollupFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `void` | FastCountingFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `void` | FacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)` Aggregate the facets found in the given matching documents.
    `void` | CountingFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `void` | CachedOrdsCountingFacetsAggregator.`aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
    `Aggregator` | SumScoreFacetRequest.`createAggregator(boolean useComplements, FacetArrays arrays, TaxonomyReader taxonomy)`
    `Aggregator` | FacetRequest.`createAggregator(boolean useComplements, FacetArrays arrays, TaxonomyReader taxonomy)` Create an aggregator for this facet request.
    `Aggregator` | CountFacetRequest.`createAggregator(boolean useComplements, FacetArrays arrays, TaxonomyReader taxonomy)`
    `protected HashMap<CategoryListIterator,Aggregator>` | StandardFacetsAccumulator.`getCategoryListMap(FacetArrays facetArrays, int partition)` Create an `Aggregator` and a `CategoryListIterator` for each and every `FacetRequest`.
    `double` | SumScoreFacetRequest.`getValueOf(FacetArrays arrays, int ordinal)`
    `abstract double` | FacetRequest.`getValueOf(FacetArrays arrays, int idx)` Return the value of a category used for facets computations for this request.
    `double` | CountFacetRequest.`getValueOf(FacetArrays arrays, int ordinal)`
    `void` | SumScoreFacetsAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)`
    `void` | PerCategoryListAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)`
    `void` | IntRollupFacetsAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)`
    `void` | FacetsAggregator.`rollupValues(FacetRequest fr, int ordinal, int[] children, int[] siblings, FacetArrays facetArrays)` Rollup the values of the given ordinal.

    Constructors in org.apache.lucene.facet.search with parameters of type FacetArrays
    Constructor and Description
    `AdaptiveFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)` Create an `AdaptiveFacetsAccumulator`
    `DepthOneFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `FacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `FacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)` Initializes the accumulator with the given parameters as well as `FacetArrays`.
    `FloatFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `IntFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `StandardFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)`
    `TopKFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)` Construct top-K results handler.
    `TopKInEachNodeHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`

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