## Uses of Interface
org.apache.lucene.facet.search.ScoredDocIDs

- Packages that use ScoredDocIDs
  Package | Description
  --- | ---
  org.apache.lucene.facet.sampling | Facets sampling.
  org.apache.lucene.facet.search | Facets search code.
  org.apache.lucene.facet.util | Various utilities for faceted search

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

    Fields in org.apache.lucene.facet.sampling declared as ScoredDocIDs
    Modifier and Type | Field and Description
    --- | ---
    `ScoredDocIDs` | Sampler.SampleResult.`docids`

    Methods in org.apache.lucene.facet.sampling that return ScoredDocIDs
    Modifier and Type | Method and Description
    --- | ---
    `protected ScoredDocIDs` | SamplingAccumulator.`actualDocsToAccumulate(ScoredDocIDs docids)`

    Methods in org.apache.lucene.facet.sampling with parameters of type ScoredDocIDs
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | SamplingWrapper.`accumulate(ScoredDocIDs docids)`
    `List<FacetResult>` | SamplingAccumulator.`accumulate(ScoredDocIDs docids)`
    `protected ScoredDocIDs` | SamplingAccumulator.`actualDocsToAccumulate(ScoredDocIDs docids)`
    `protected abstract Sampler.SampleResult` | Sampler.`createSample(ScoredDocIDs docids, int actualSize, int sampleSetSize)` Create and return a sample of the input set
    `protected Sampler.SampleResult` | RepeatableSampler.`createSample(ScoredDocIDs docids, int actualSize, int sampleSetSize)`
    `protected Sampler.SampleResult` | RandomSampler.`createSample(ScoredDocIDs docids, int actualSize, int sampleSetSize)`
    `void` | SampleFixer.`fixResult(ScoredDocIDs origDocIds, FacetResult fres)` Alter the input result, fixing it to account for the sampling.
    `Sampler.SampleResult` | Sampler.`getSampleSet(ScoredDocIDs docids)` Compute a sample set out of the input set, based on the `SamplingParams.getSampleRatio()` in effect.
    `boolean` | Sampler.`shouldSample(ScoredDocIDs docIds)` Check if this sampler would complement for the input docIds

    Constructors in org.apache.lucene.facet.sampling with parameters of type ScoredDocIDs
    Constructor and Description
    `Sampler.SampleResult(ScoredDocIDs docids, double actualSampleRatio)`

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

    Classes in org.apache.lucene.facet.search that implement ScoredDocIDs
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MatchingDocsAsScoredDocIDs` Represents `FacetsCollector.MatchingDocs` as `ScoredDocIDs`.

    Methods in org.apache.lucene.facet.search that return ScoredDocIDs
    Modifier and Type | Method and Description
    --- | ---
    `protected ScoredDocIDs` | StandardFacetsAccumulator.`actualDocsToAccumulate(ScoredDocIDs docids)` Set the actual set of documents over which accumulation should take place.

    Methods in org.apache.lucene.facet.search with parameters of type ScoredDocIDs
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | StandardFacetsAccumulator.`accumulate(ScoredDocIDs docids)`
    `List<FacetResult>` | AdaptiveFacetsAccumulator.`accumulate(ScoredDocIDs docids)`
    `protected ScoredDocIDs` | StandardFacetsAccumulator.`actualDocsToAccumulate(ScoredDocIDs docids)` Set the actual set of documents over which accumulation should take place.
    `protected boolean` | StandardFacetsAccumulator.`shouldComplement(ScoredDocIDs docids)` Check if it is worth to use complements

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

    Methods in org.apache.lucene.facet.util that return ScoredDocIDs
    Modifier and Type | Method and Description
    --- | ---
    `static ScoredDocIDs` | ScoredDocIdsUtils.`createAllDocsScoredDocIDs(IndexReader reader)` Creates a `ScoredDocIDs` which returns document IDs all non-deleted doc ids according to the given reader.
    `static ScoredDocIDs` | ScoredDocIdsUtils.`createScoredDocIds(DocIdSet docIdSet, int maxDoc)` Create a ScoredDocIDs out of a given docIdSet and the total number of documents in an index
    `static ScoredDocIDs` | ScoredDocIdsUtils.`createScoredDocIDsSubset(ScoredDocIDs allDocIds, int[] sampleSet)` Create a subset of an existing ScoredDocIDs object.
    `static ScoredDocIDs` | ScoredDocIdsUtils.`getComplementSet(ScoredDocIDs docids, IndexReader reader)` Create a complement of the input set.

    Methods in org.apache.lucene.facet.util with parameters of type ScoredDocIDs
    Modifier and Type | Method and Description
    --- | ---
    `static ScoredDocIDs` | ScoredDocIdsUtils.`createScoredDocIDsSubset(ScoredDocIDs allDocIds, int[] sampleSet)` Create a subset of an existing ScoredDocIDs object.
    `static ScoredDocIDs` | ScoredDocIdsUtils.`getComplementSet(ScoredDocIDs docids, IndexReader reader)` Create a complement of the input set.

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