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

Packages that use DocIdSetIterator
Package | Description
--- | ---
org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.index | Code to maintain and access indices.
org.apache.lucene.search | Code to search indices.
org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.spans | The calculus of spans.
org.apache.lucene.util | Some utility classes.

### Uses of DocIdSetIterator in org.apache.lucene.codecs

Subclasses of DocIdSetIterator in org.apache.lucene.codecs
Modifier and Type | Class and Description
--- | ---
`class` | `MappingMultiDocsAndPositionsEnum` Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).
`class` | `MappingMultiDocsEnum` Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).

### Uses of DocIdSetIterator in org.apache.lucene.index

Subclasses of DocIdSetIterator in org.apache.lucene.index
Modifier and Type | Class and Description
--- | ---
`class` | `DocsAndPositionsEnum` Also iterates through positions.
`class` | `DocsEnum` Iterates through the documents and term freqs.
`static class` | `FilterAtomicReader.FilterDocsAndPositionsEnum` Base class for filtering `DocsAndPositionsEnum` implementations.
`static class` | `FilterAtomicReader.FilterDocsEnum` Base class for filtering `DocsEnum` implementations.
`class` | `MultiDocsAndPositionsEnum` Exposes flex API, merged from flex API of sub-segments.
`class` | `MultiDocsEnum` Exposes `DocsEnum`, merged from `DocsEnum` API of sub-segments.

### Uses of DocIdSetIterator in org.apache.lucene.search

Subclasses of DocIdSetIterator in org.apache.lucene.search
Modifier and Type | Class and Description
--- | ---
`protected class` | `ConstantScoreQuery.ConstantScorer`
`class` | `FilteredDocIdSetIterator` Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator.
`class` | `ScoreCachingWrappingScorer` A `Scorer` which wraps another scorer and caches the score of the current document.
`class` | `Scorer` Expert: Common scoring functionality for different types of queries.

Fields in org.apache.lucene.search declared as DocIdSetIterator
Modifier and Type | Field and Description
--- | ---
`protected DocIdSetIterator` | FilteredDocIdSetIterator.`_innerIter`

Methods in org.apache.lucene.search that return DocIdSetIterator
Modifier and Type | Method and Description
--- | ---
`DocIdSetIterator` | FilteredDocIdSet.`iterator()` Implementation of the contract to build a DocIdSetIterator.
`DocIdSetIterator` | FieldCacheDocIdSet.`iterator()`
`abstract DocIdSetIterator` | DocIdSet.`iterator()` Provides a `DocIdSetIterator` to access the set.

Constructors in org.apache.lucene.search with parameters of type DocIdSetIterator
Constructor and Description
`ConstantScoreQuery.ConstantScorer(DocIdSetIterator docIdSetIterator, Weight w, float theScore)`
`FilteredDocIdSetIterator(DocIdSetIterator innerIter)` Constructor.

### Uses of DocIdSetIterator in org.apache.lucene.search.payloads

Subclasses of DocIdSetIterator in org.apache.lucene.search.payloads
Modifier and Type | Class and Description
--- | ---
`class` | `PayloadNearQuery.PayloadNearSpanScorer`
`protected class` | `PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer`

### Uses of DocIdSetIterator in org.apache.lucene.search.spans

Subclasses of DocIdSetIterator in org.apache.lucene.search.spans
Modifier and Type | Class and Description
--- | ---
`class` | `SpanScorer` Public for extension only.

### Uses of DocIdSetIterator in org.apache.lucene.util

Subclasses of DocIdSetIterator in org.apache.lucene.util
Modifier and Type | Class and Description
--- | ---
`class` | `OpenBitSetIterator` An iterator to iterate over set bits in an OpenBitSet.

Methods in org.apache.lucene.util that return DocIdSetIterator
Modifier and Type | Method and Description
--- | ---
`DocIdSetIterator` | OpenBitSet.`iterator()`
`DocIdSetIterator` | FixedBitSet.`iterator()`
`DocIdSetIterator` | DocIdBitSet.`iterator()`

Methods in org.apache.lucene.util with parameters of type DocIdSetIterator
Modifier and Type | Method and Description
--- | ---
`void` | FixedBitSet.`and(DocIdSetIterator iter)` Does in-place AND of the bits provided by the iterator.
`void` | FixedBitSet.`andNot(DocIdSetIterator iter)` Does in-place AND NOT of the bits provided by the iterator.
`void` | OpenBitSetDISI.`inPlaceAnd(DocIdSetIterator disi)` Perform an inplace AND with the doc ids from a given DocIdSetIterator, leaving only the bits set for which the doc ids are in common.
`void` | OpenBitSetDISI.`inPlaceNot(DocIdSetIterator disi)` Perform an inplace NOT with the doc ids from a given DocIdSetIterator, clearing all the bits for each such doc id.
`void` | OpenBitSetDISI.`inPlaceOr(DocIdSetIterator disi)` Perform an inplace OR with the doc ids from a given DocIdSetIterator, setting the bit for each such doc id.
`void` | OpenBitSetDISI.`inPlaceXor(DocIdSetIterator disi)` Perform an inplace XOR with the doc ids from a given DocIdSetIterator, flipping all the bits for each such doc id.
`void` | FixedBitSet.`or(DocIdSetIterator iter)` Does in-place OR of the bits provided by the iterator.

Constructors in org.apache.lucene.util with parameters of type DocIdSetIterator
Constructor and Description
`OpenBitSetDISI(DocIdSetIterator disi, int maxSize)` Construct an OpenBitSetDISI with its bits set from the doc ids of the given DocIdSetIterator.