## Uses of Class
org.apache.lucene.search.DocIdSet

- Packages that use DocIdSet
  Package | Description
  --- | ---
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.util | Some utility classes.

- - ### Uses of DocIdSet in org.apache.lucene.search

    Subclasses of DocIdSet in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BitsFilteredDocIdSet` This implementation supplies a filtered DocIdSet, that excludes all docids which are not in a Bits instance.
    `class` | `FieldCacheDocIdSet` Base class for DocIdSet to be used with FieldCache.
    `class` | `FilteredDocIdSet` Abstract decorator class for a DocIdSet implementation that provides on-demand filtering/validation mechanism on a given DocIdSet.

    Fields in org.apache.lucene.search declared as DocIdSet
    Modifier and Type | Field and Description
    --- | ---
    `static DocIdSet` | DocIdSet.`EMPTY_DOCIDSET` An empty `DocIdSet` instance for easy use, e.g.

    Methods in org.apache.lucene.search that return DocIdSet
    Modifier and Type | Method and Description
    --- | ---
    `protected DocIdSet` | CachingWrapperFilter.`docIdSetToCache(DocIdSet docIdSet, AtomicReader reader)` Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
    `DocIdSet` | QueryWrapperFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `DocIdSet` | MultiTermQueryWrapperFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` Returns a DocIdSet with documents that should be permitted in search results.
    `abstract DocIdSet` | Filter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` Creates a `DocIdSet` enumerating the documents that should be permitted in search results.
    `DocIdSet` | FieldValueFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `DocIdSet` | FieldCacheTermsFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `abstract DocIdSet` | FieldCacheRangeFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` This method is implemented for each data type
    `abstract DocIdSet` | DocTermOrdsRangeFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` This method is implemented for each data type
    `DocIdSet` | CachingWrapperFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `static DocIdSet` | BitsFilteredDocIdSet.`wrap(DocIdSet set, Bits acceptDocs)` Convenience wrapper method: If `acceptDocs == null` it returns the original set without wrapping.

    Methods in org.apache.lucene.search with parameters of type DocIdSet
    Modifier and Type | Method and Description
    --- | ---
    `protected DocIdSet` | CachingWrapperFilter.`docIdSetToCache(DocIdSet docIdSet, AtomicReader reader)` Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
    `abstract Scorer` | FilteredQuery.FilterStrategy.`filteredScorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Weight weight, DocIdSet docIdSet)` Returns a filtered `Scorer` based on this strategy.
    `Scorer` | FilteredQuery.RandomAccessFilterStrategy.`filteredScorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Weight weight, DocIdSet docIdSet)`
    `static DocIdSet` | BitsFilteredDocIdSet.`wrap(DocIdSet set, Bits acceptDocs)` Convenience wrapper method: If `acceptDocs == null` it returns the original set without wrapping.

    Constructors in org.apache.lucene.search with parameters of type DocIdSet
    Constructor and Description
    `BitsFilteredDocIdSet(DocIdSet innerSet, Bits acceptDocs)` Constructor.
    `FilteredDocIdSet(DocIdSet innerSet)` Constructor.

  - ### Uses of DocIdSet in org.apache.lucene.util

    Subclasses of DocIdSet in org.apache.lucene.util
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DocIdBitSet` Simple DocIdSet and DocIdSetIterator backed by a BitSet
    `class` | `FixedBitSet` BitSet of fixed length (numBits), backed by accessible (`FixedBitSet.getBits()`) long[], accessed with an int index, implementing Bits and DocIdSet.
    `class` | `OpenBitSet` An "open" BitSet implementation that allows direct access to the array of words storing the bits.
    `class` | `OpenBitSetDISI` OpenBitSet with added methods to bulk-update the bits from a `DocIdSetIterator`.

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