## Uses of Class
org.apache.lucene.facet.params.FacetSearchParams

- Packages that use FacetSearchParams
  Package | Description
  --- | ---
  org.apache.lucene.facet.sampling | Facets sampling.
  org.apache.lucene.facet.search | Facets search code.

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

    Methods in org.apache.lucene.facet.sampling that return FacetSearchParams
    Modifier and Type | Method and Description
    --- | ---
    `FacetSearchParams` | Sampler.`overSampledSearchParams(FacetSearchParams original)` Over-sampled search params, wrapping each request with an over-sampled one.

    Methods in org.apache.lucene.facet.sampling with parameters of type FacetSearchParams
    Modifier and Type | Method and Description
    --- | ---
    `SampleFixer` | Sampler.`getSampleFixer(IndexReader indexReader, TaxonomyReader taxonomyReader, FacetSearchParams searchParams)` Get a fixer of sample facet accumulation results.
    `FacetSearchParams` | Sampler.`overSampledSearchParams(FacetSearchParams original)` Over-sampled search params, wrapping each request with an over-sampled one.

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

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

    Fields in org.apache.lucene.facet.search declared as FacetSearchParams
    Modifier and Type | Field and Description
    --- | ---
    `FacetSearchParams` | FacetsAccumulator.`searchParams`

    Methods in org.apache.lucene.facet.search with parameters of type FacetSearchParams
    Modifier and Type | Method and Description
    --- | ---
    `static FacetsCollector` | FacetsCollector.`create(FacetSearchParams fsp, IndexReader indexReader, TaxonomyReader taxoReader)` Creates a `FacetsCollector` using the `FacetsAccumulator` from `FacetsAccumulator.create(org.apache.lucene.facet.params.FacetSearchParams, org.apache.lucene.index.IndexReader, org.apache.lucene.facet.taxonomy.TaxonomyReader)`.
    `static FacetsAccumulator` | FacetsAccumulator.`create(FacetSearchParams fsp, IndexReader indexReader, TaxonomyReader taxoReader)` Creates an appropriate `FacetsAccumulator`, returning `FacetsAccumulator` when all requests are `CountFacetRequest` and only one partition is in use, otherwise `StandardFacetsAccumulator`.
    `protected FacetsAccumulator` | DrillSideways.`getDrillDownAccumulator(FacetSearchParams fsp)` Override this to use a custom drill-down `FacetsAccumulator`.
    `protected FacetsAccumulator` | DrillSideways.`getDrillSidewaysAccumulator(String dim, FacetSearchParams fsp)` Override this to use a custom drill-sideways `FacetsAccumulator`.
    `DrillSideways.DrillSidewaysResult` | DrillSideways.`search(DrillDownQuery query, Collector hitCollector, FacetSearchParams fsp)` Search, collecting hits with a `Collector`, and computing drill down and sideways counts.
    `DrillSideways.DrillSidewaysResult` | DrillSideways.`search(DrillDownQuery query, Filter filter, FieldDoc after, int topN, Sort sort, boolean doDocScores, boolean doMaxScore, FacetSearchParams fsp)` Search, sorting by `Sort`, and computing drill down and sideways counts.
    `DrillSideways.DrillSidewaysResult` | DrillSideways.`search(ScoreDoc after, DrillDownQuery query, int topN, FacetSearchParams fsp)` Search, sorting by score, and computing drill down and sideways counts.

    Constructors in org.apache.lucene.facet.search with parameters of type FacetSearchParams
    Constructor and Description
    `AdaptiveFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)` Create an `AdaptiveFacetsAccumulator`
    `AdaptiveFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)` Create an `AdaptiveFacetsAccumulator`
    `FacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)` Initializes the accumulator with the given search params, index reader and taxonomy reader.
    `FacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)` Initializes the accumulator with the given parameters as well as `FacetArrays`.
    `StandardFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)`
    `StandardFacetsAccumulator(FacetSearchParams searchParams, IndexReader indexReader, TaxonomyReader taxonomyReader, FacetArrays facetArrays)`

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