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

- Packages that use FacetResult
  Package | Description
  --- | ---
  org.apache.lucene.facet.partitions | Category Partitions
  org.apache.lucene.facet.sampling | Facets sampling.
  org.apache.lucene.facet.search | Facets search code.

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

    Methods in org.apache.lucene.facet.partitions that return FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | PartitionsFacetResultsHandler.`compute()`
    `abstract FacetResult` | PartitionsFacetResultsHandler.`rearrangeFacetResult(FacetResult facetResult)` Perform any rearrangement as required on a facet result that has changed after it was rendered.
    `abstract FacetResult` | PartitionsFacetResultsHandler.`renderFacetResult(IntermediateFacetResult tmpResult)` Create a facet result from the temporary result.

    Methods in org.apache.lucene.facet.partitions with parameters of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | PartitionsFacetResultsHandler.`labelResult(FacetResult facetResult)` Label results according to settings in `FacetRequest`, such as `FacetRequest.getNumLabel()`.
    `abstract FacetResult` | PartitionsFacetResultsHandler.`rearrangeFacetResult(FacetResult facetResult)` Perform any rearrangement as required on a facet result that has changed after it was rendered.

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

    Methods in org.apache.lucene.facet.sampling that return FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | Sampler.`trimResult(FacetResult facetResult)` Trim the input facet result. Note: It is only valid to call this method with result obtained for a facet request created through `Sampler.overSampledSearchParams(FacetSearchParams)`.

    Methods in org.apache.lucene.facet.sampling that return types with arguments of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | SamplingWrapper.`accumulate(ScoredDocIDs docids)`
    `List<FacetResult>` | SamplingAccumulator.`accumulate(ScoredDocIDs docids)`

    Methods in org.apache.lucene.facet.sampling with parameters of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `void` | SampleFixer.`fixResult(ScoredDocIDs origDocIds, FacetResult fres)` Alter the input result, fixing it to account for the sampling.
    `FacetResult` | Sampler.`trimResult(FacetResult facetResult)` Trim the input facet result. Note: It is only valid to call this method with result obtained for a facet request created through `Sampler.overSampledSearchParams(FacetSearchParams)`.

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

    Fields in org.apache.lucene.facet.search with type parameters of type FacetResult
    Modifier and Type | Field and Description
    --- | ---
    `List<FacetResult>` | DrillSideways.DrillSidewaysResult.`facetResults` Combined drill down & sideways results.

    Methods in org.apache.lucene.facet.search that return FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `abstract FacetResult` | FacetResultsHandler.`compute()` Computes the `FacetResult` for the given `FacetArrays`.
    `FacetResult` | DepthOneFacetResultsHandler.`compute()`
    `FacetResult` | TopKInEachNodeHandler.`rearrangeFacetResult(FacetResult facetResult)`
    `FacetResult` | TopKFacetResultsHandler.`rearrangeFacetResult(FacetResult facetResult)`
    `FacetResult` | TopKInEachNodeHandler.`renderFacetResult(IntermediateFacetResult tmpResult)`
    `FacetResult` | TopKFacetResultsHandler.`renderFacetResult(IntermediateFacetResult tmpResult)`

    Methods in org.apache.lucene.facet.search that return types with arguments of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | StandardFacetsAccumulator.`accumulate(List<FacetsCollector.MatchingDocs> matchingDocs)`
    `List<FacetResult>` | FacetsAccumulator.`accumulate(List<FacetsCollector.MatchingDocs> matchingDocs)` Used by `FacetsCollector` to build the list of `facet results` that match the `facet requests` that were given in the constructor.
    `List<FacetResult>` | StandardFacetsAccumulator.`accumulate(ScoredDocIDs docids)`
    `List<FacetResult>` | AdaptiveFacetsAccumulator.`accumulate(ScoredDocIDs docids)`
    `List<FacetResult>` | FacetsCollector.`getFacetResults()` Returns a `FacetResult` per `FacetRequest` set in `FacetSearchParams`.

    Methods in org.apache.lucene.facet.search with parameters of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `void` | TopKInEachNodeHandler.`labelResult(FacetResult facetResult)`
    `void` | TopKFacetResultsHandler.`labelResult(FacetResult facetResult)`
    `FacetResult` | TopKInEachNodeHandler.`rearrangeFacetResult(FacetResult facetResult)`
    `FacetResult` | TopKFacetResultsHandler.`rearrangeFacetResult(FacetResult facetResult)`

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