## 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` Deprecated. This class is not useful internally anymore and will be removed in 6.0
    `class` | `DocValuesDocIdSet` Base class for DocIdSet to be used with DocValues.
    `class` | `FilteredDocIdSet` Deprecated. This class is not useful internally anymore and will be removed in 6.0

    Fields in org.apache.lucene.search declared as DocIdSet
    Modifier and Type | Field and Description
    --- | ---
    `static DocIdSet` | DocIdSet.`EMPTY` An empty `DocIdSet` instance

    Methods in org.apache.lucene.search that return DocIdSet
    Modifier and Type | Method and Description
    --- | ---
    `protected DocIdSet` | LRUQueryCache.`cacheImpl(BulkScorer scorer, int maxDoc)` Default cache implementation: uses `RoaringDocIdSet`.
    `protected DocIdSet` | LRUFilterCache.`cacheImpl(DocIdSetIterator iterator, LeafReader reader)` Deprecated. Default cache implementation: uses `RoaringDocIdSet`.
    `protected DocIdSet` | CachingWrapperFilter.`cacheImpl(DocIdSetIterator iterator, LeafReader reader)` Deprecated. Default cache implementation: uses `RoaringDocIdSet`.
    `protected DocIdSet` | CachingWrapperQuery.`cacheImpl(DocIdSetIterator iterator, LeafReader reader)` Deprecated. Default cache implementation: uses `RoaringDocIdSet`.
    `protected DocIdSet` | LRUFilterCache.`docIdSetToCache(DocIdSet docIdSet, LeafReader reader)` Deprecated. Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
    `protected DocIdSet` | CachingWrapperFilter.`docIdSetToCache(DocIdSet docIdSet, LeafReader reader)` Deprecated. Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
    `DocIdSet` | FilteredDocIdSet.`getDelegate()` Deprecated. Return the wrapped `DocIdSet`.
    `abstract DocIdSet` | Filter.`getDocIdSet(LeafReaderContext context, Bits acceptDocs)` Deprecated. Creates a `DocIdSet` enumerating the documents that should be permitted in search results.
    `DocIdSet` | FieldValueFilter.`getDocIdSet(LeafReaderContext context, Bits acceptDocs)` Deprecated.
    `DocIdSet` | CachingWrapperFilter.`getDocIdSet(LeafReaderContext context, Bits acceptDocs)` Deprecated.
    `DocIdSet` | MultiTermQueryWrapperFilter.`getDocIdSet(LeafReaderContext context, Bits acceptDocs)` Deprecated. Returns a DocIdSet with documents that should be permitted in search results.
    `DocIdSet` | QueryWrapperFilter.`getDocIdSet(LeafReaderContext context, Bits acceptDocs)` Deprecated.
    `static DocIdSet` | BitsFilteredDocIdSet.`wrap(DocIdSet set, Bits acceptDocs)` Deprecated. 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` | LRUFilterCache.`docIdSetToCache(DocIdSet docIdSet, LeafReader reader)` Deprecated. Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
    `protected DocIdSet` | CachingWrapperFilter.`docIdSetToCache(DocIdSet docIdSet, LeafReader reader)` Deprecated. Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
    `boolean` | UsageTrackingFilterCachingPolicy.`shouldCache(Filter filter, LeafReaderContext context, DocIdSet set)`
    `boolean` | FilterCachingPolicy.`shouldCache(Filter filter, LeafReaderContext context, DocIdSet set)` Deprecated. Whether the given `DocIdSet` should be cached on a given segment.
    `boolean` | FilterCachingPolicy.CacheOnLargeSegments.`shouldCache(Filter filter, LeafReaderContext context, DocIdSet set)`
    `static DocIdSet` | BitsFilteredDocIdSet.`wrap(DocIdSet set, Bits acceptDocs)` Deprecated. 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)` Deprecated. Constructor.
    `FilteredDocIdSet(DocIdSet innerSet)` Deprecated. Constructor.

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

    Subclasses of DocIdSet in org.apache.lucene.util
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BitDocIdSet` Implementation of the `DocIdSet` interface on top of a `BitSet`.
    `class` | `NotDocIdSet` This `DocIdSet` encodes the negation of another `DocIdSet`.
    `class` | `RoaringDocIdSet` `DocIdSet` implementation inspired from http://roaringbitmap.org/ The space is divided into blocks of 2^16 bits and each block is encoded independently.

    Methods in org.apache.lucene.util that return DocIdSet
    Modifier and Type | Method and Description
    --- | ---
    `DocIdSet` | DocIdSetBuilder.`build()` Build a `DocIdSet` from the accumulated doc IDs.
    `DocIdSet` | DocIdSetBuilder.`build(long costHint)` Expert: build a `DocIdSet` with a hint on the cost that the resulting `DocIdSet` would have.

    Constructors in org.apache.lucene.util with parameters of type DocIdSet
    Constructor and Description
    `NotDocIdSet(int maxDoc, DocIdSet in)` Sole constructor.

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