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

- Packages that use FacetRequest
  Package | Description
  --- | ---
  org.apache.lucene.facet.associations | Allows associating arbitrary values with a category.
  org.apache.lucene.facet.params | Facets indexing and search parameters.
  org.apache.lucene.facet.partitions | Category Partitions
  org.apache.lucene.facet.search | Facets search code.
  org.apache.lucene.facet.util | Various utilities for faceted search

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

    Subclasses of FacetRequest in org.apache.lucene.facet.associations
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AssociationFloatSumFacetRequest` A `FacetRequest` for weighting facets according to their float association by summing the association values.
    `class` | `AssociationIntSumFacetRequest` A `FacetRequest` for weighting facets according to their integer association by summing the association values.

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

    Fields in org.apache.lucene.facet.params with type parameters of type FacetRequest
    Modifier and Type | Field and Description
    --- | ---
    `List<FacetRequest>` | FacetSearchParams.`facetRequests`

    Constructors in org.apache.lucene.facet.params with parameters of type FacetRequest
    Constructor and Description
    `FacetSearchParams(FacetIndexingParams indexingParams, FacetRequest... facetRequests)` Initializes with the given `requests` and `FacetIndexingParams`.
    `FacetSearchParams(FacetRequest... facetRequests)` Initializes with the given `requests` and default `FacetIndexingParams.DEFAULT`.

    Constructor parameters in org.apache.lucene.facet.params with type arguments of type FacetRequest
    Constructor and Description
    `FacetSearchParams(FacetIndexingParams indexingParams, List<FacetRequest> facetRequests)` Initializes with the given `requests` and `FacetIndexingParams`.
    `FacetSearchParams(List<FacetRequest> facetRequests)` Initializes with the given `requests` and default `FacetIndexingParams.DEFAULT`.

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

    Methods in org.apache.lucene.facet.partitions that return FacetRequest
    Modifier and Type | Method and Description
    --- | ---
    `FacetRequest` | IntermediateFacetResult.`getFacetRequest()` Facet request for which this temporary result was created.

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

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

    Subclasses of FacetRequest in org.apache.lucene.facet.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CountFacetRequest` Facet request for counting facets.
    `class` | `SumScoreFacetRequest` A `FacetRequest` for weighting facets by summing the scores of matching documents.

    Fields in org.apache.lucene.facet.search declared as FacetRequest
    Modifier and Type | Field and Description
    --- | ---
    `FacetRequest` | FacetResultsHandler.`facetRequest`

    Methods in org.apache.lucene.facet.search that return FacetRequest
    Modifier and Type | Method and Description
    --- | ---
    `FacetRequest` | TopKInEachNodeHandler.IntermediateFacetResultWithHash.`getFacetRequest()`
    `FacetRequest` | FacetResult.`getFacetRequest()` Request for which this result was obtained.

    Methods in org.apache.lucene.facet.search with parameters of type FacetRequest
    Modifier and Type | Method and Description
    --- | ---
    `protected PartitionsFacetResultsHandler` | StandardFacetsAccumulator.`createFacetResultsHandler(FacetRequest fr)`
    `protected FacetResultsHandler` | FacetsAccumulator.`createFacetResultsHandler(FacetRequest fr)` Creates a `FacetResultsHandler` that matches the given `FacetRequest`.
    `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 FacetRequest
    Constructor and Description
    `DepthOneFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `FacetResult(FacetRequest facetRequest, FacetResultNode rootNode, int numValidDescendants)`
    `FacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `FloatFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `IntFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`
    `TopKFacetResultsHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)` Construct top-K results handler.
    `TopKInEachNodeHandler.IntermediateFacetResultWithHash(FacetRequest facetReq, IntToObjectMap<TopKInEachNodeHandler.AACO> mapToAACOs)`
    `TopKInEachNodeHandler(TaxonomyReader taxonomyReader, FacetRequest facetRequest, FacetArrays facetArrays)`

  - ### Uses of FacetRequest in org.apache.lucene.facet.util

    Methods in org.apache.lucene.facet.util with parameters of type FacetRequest
    Modifier and Type | Method and Description
    --- | ---
    `static Heap<FacetResultNode>` | ResultSortUtils.`createSuitableHeap(FacetRequest facetRequest)` Create a suitable heap according to facet request being served.

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