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

Packages that use DocIdSetIterator
Package
Description
org.apache.lucene.codecs.lucene90
Lucene 9.0 file format.
org.apache.lucene.document
The logical representation of a `Document` for indexing and searching.
org.apache.lucene.index
Code to maintain and access indices.
org.apache.lucene.search
Code to search indices.
org.apache.lucene.search.comparators
Comparators, used to compare hits so as to determine their sort order when collecting the top results with `TopFieldCollector`.
org.apache.lucene.util
Some utility classes.

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

Subclasses of DocIdSetIterator in org.apache.lucene.codecs.lucene90
Modifier and Type
Class
Description
`final class`
`IndexedDISI`
Disk-based implementation of a `DocIdSetIterator` which can return the index of the current document, i.e.
Methods in org.apache.lucene.codecs.lucene90 with parameters of type DocIdSetIterator
Modifier and Type
Method
Description
`static short`
IndexedDISI.`writeBitSet(DocIdSetIterator it, IndexOutput out, byte denseRankPower)`
Writes the docIDs from it to out, in logical blocks, one for each 65536 docIDs in monotonically increasing gap-less order.

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

Subclasses of DocIdSetIterator in org.apache.lucene.document
Modifier and Type
Class
Description
`class`
`BinaryRangeDocValues`
A binary representation of a range that wraps a BinaryDocValues field

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

Subclasses of DocIdSetIterator in org.apache.lucene.index
Modifier and Type
Class
Description
`class`
`BinaryDocValues`
A per-document numeric value.
`class`
`FilterBinaryDocValues`
Delegates all methods to a wrapped `BinaryDocValues`.
`static class`
`FilterLeafReader.FilterPostingsEnum`
Base class for filtering `PostingsEnum` implementations.
`class`
`FilterNumericDocValues`
Delegates all methods to a wrapped `NumericDocValues`.
`class`
`FilterSortedDocValues`
Delegates all methods to a wrapped `SortedDocValues`.
`class`
`FilterSortedNumericDocValues`
Delegates all methods to a wrapped `SortedNumericDocValues`.
`class`
`FilterSortedSetDocValues`
Delegates all methods to a wrapped `SortedSetDocValues`.
`class`
`ImpactsEnum`
Extension of `PostingsEnum` which also provides information about upcoming impacts.
`static class`
`KnnVectorValues.DocIndexIterator`
A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.
`static class`
`MultiDocValues.MultiSortedDocValues`
Implements SortedDocValues over n subs, using an OrdinalMap
`static class`
`MultiDocValues.MultiSortedSetDocValues`
Implements MultiSortedSetDocValues over n subs, using an OrdinalMap
`final class`
`MultiPostingsEnum`
Exposes `PostingsEnum`, merged from `PostingsEnum` API of sub-segments.
`class`
`NumericDocValues`
A per-document numeric value.
`class`
`PostingsEnum`
Iterates through the postings.
`final class`
`SlowImpactsEnum`
`ImpactsEnum` that doesn't index impacts but implements the API in a legal way.
`class`
`SortedDocValues`
A per-document byte[] with presorted values.
`class`
`SortedNumericDocValues`
A list of per-document numeric values, sorted according to `Long.compare(long, long)`.
`class`
`SortedSetDocValues`
A multi-valued version of `SortedDocValues`.
`static class`
`SortingCodecReader.SortingValuesIterator`
Iterator over KnnVectorValues accepting a mapping to differently-sorted docs.
Methods in org.apache.lucene.index that return DocIdSetIterator
Modifier and Type
Method
Description
`DocIdSetIterator`
DocsWithFieldSet.`iterator()`
Methods in org.apache.lucene.index with parameters of type DocIdSetIterator
Modifier and Type
Method
Description
`protected static KnnVectorValues.DocIndexIterator`
KnnVectorValues.`fromDISI(DocIdSetIterator docsWithField)`
Creates an iterator from a DocIdSetIterator indicating which docs have values, and for which ordinals increase monotonically with docid.
`default void`
PointValues.IntersectVisitor.`visit(DocIdSetIterator iterator)`
Similar to `PointValues.IntersectVisitor.visit(int)`, but a bulk visit and implementations may have their optimizations.
`default void`
PointValues.IntersectVisitor.`visit(DocIdSetIterator iterator, byte[] packedValue)`
Similar to `PointValues.IntersectVisitor.visit(int, byte[])` but in this case the packedValue can have more than one docID associated to it.

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

Subclasses of DocIdSetIterator in org.apache.lucene.search
Modifier and Type
Class
Description
`class`
`DisjunctionDISIApproximation`
A `DocIdSetIterator` which is a disjunction of the approximations of the provided iterators.
`class`
`FilteredDocIdSetIterator`
Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator.
`final class`
`ImpactsDISI`
`DocIdSetIterator` that skips non-competitive docs thanks to the indexed impacts.
`static class`
`MultiPhraseQuery.UnionFullPostingsEnum`
Slower version of UnionPostingsEnum that delegates offsets and positions, for use by MatchesIterator
`static class`
`MultiPhraseQuery.UnionPostingsEnum`
Takes the logical union of multiple PostingsEnum iterators.
Fields in org.apache.lucene.search declared as DocIdSetIterator
Modifier and Type
Field
Description
`protected DocIdSetIterator`
FilteredDocIdSetIterator.`_innerIter`
`final DocIdSetIterator`
DisiWrapper.`approximation`
`protected final DocIdSetIterator`
TwoPhaseIterator.`approximation`
`final DocIdSetIterator`
DisiWrapper.`iterator`
Methods in org.apache.lucene.search that return DocIdSetIterator
Modifier and Type
Method
Description
`static final DocIdSetIterator`
DocIdSetIterator.`all(int maxDoc)`
A `DocIdSetIterator` that matches all documents up to `maxDoc - 1`.
`DocIdSetIterator`
TwoPhaseIterator.`approximation()`
Return an approximation.
`static DocIdSetIterator`
TwoPhaseIterator.`asDocIdSetIterator(TwoPhaseIterator twoPhaseIterator)`
Return a `DocIdSetIterator` view of the provided `TwoPhaseIterator`.
`default DocIdSetIterator`
LeafCollector.`competitiveIterator()`
Optionally returns an iterator over competitive documents.
`default DocIdSetIterator`
LeafFieldComparator.`competitiveIterator()`
Returns a competitive iterator
`static DocIdSetIterator`
ConjunctionUtils.`createConjunction(List<DocIdSetIterator> allIterators, List<TwoPhaseIterator> twoPhaseIterators)`
Create a conjunction over the provided set of DocIdSetIterators and TwoPhaseIterators, using two-phase iterator where possible.
`static final DocIdSetIterator`
DocIdSetIterator.`empty()`
An empty `DocIdSetIterator` instance
`DocIdSetIterator`
FilteredDocIdSetIterator.`getDelegate()`
Return the wrapped `DocIdSetIterator`.
`static DocIdSetIterator`
FieldExistsQuery.`getDocValuesDocIdSetIterator(String field, LeafReader reader)`
Returns a `DocIdSetIterator` from the given field or null if the field doesn't exist in the reader or if the reader has no doc values for the field.
`static DocIdSetIterator`
ConjunctionUtils.`intersectIterators(List<? extends DocIdSetIterator> iterators)`
Create a conjunction over the provided DocIdSetIterators.
`static DocIdSetIterator`
ConjunctionUtils.`intersectScorers(Collection<Scorer> scorers)`
Create a conjunction over the provided `Scorer`s.
`DocIdSetIterator`
ConstantScoreScorer.`iterator()`
`abstract DocIdSetIterator`
DocIdSet.`iterator()`
Provides a `DocIdSetIterator` to access the set.
`final DocIdSetIterator`
FilterScorer.`iterator()`
`DocIdSetIterator`
IndriDisjunctionScorer.`iterator()`
`abstract DocIdSetIterator`
IndriScorer.`iterator()`
`DocIdSetIterator`
LRUQueryCache.CacheAndCount.`iterator()`
`abstract DocIdSetIterator`
Scorer.`iterator()`
Return a `DocIdSetIterator` over matching documents.
`DocIdSetIterator`
TermScorer.`iterator()`
`DocIdSetIterator`
VectorScorer.`iterator()`
`static final DocIdSetIterator`
DocIdSetIterator.`range(int minDoc, int maxDoc)`
A `DocIdSetIterator` that matches a range documents from minDocID (inclusive) to maxDocID (exclusive).
Methods in org.apache.lucene.search with parameters of type DocIdSetIterator
Modifier and Type
Method
Description
`static void`
ConjunctionUtils.`addIterator(DocIdSetIterator disi, List<DocIdSetIterator> allIterators, List<TwoPhaseIterator> twoPhaseIterators)`
Given a DocIdSetIterator, find any sub-iterators or two-phase iterators and add them to the provided DocIdSetIterator and TwoPhaseIterator lists
`static TwoPhaseIterator`
TwoPhaseIterator.`unwrap(DocIdSetIterator iterator)`
If the given `DocIdSetIterator` has been created with `TwoPhaseIterator.asDocIdSetIterator(org.apache.lucene.search.TwoPhaseIterator)`, then this will return the wrapped `TwoPhaseIterator`.
Method parameters in org.apache.lucene.search with type arguments of type DocIdSetIterator
Modifier and Type
Method
Description
`static void`
ConjunctionUtils.`addIterator(DocIdSetIterator disi, List<DocIdSetIterator> allIterators, List<TwoPhaseIterator> twoPhaseIterators)`
Given a DocIdSetIterator, find any sub-iterators or two-phase iterators and add them to the provided DocIdSetIterator and TwoPhaseIterator lists
`static void`
ConjunctionUtils.`addTwoPhaseIterator(TwoPhaseIterator twoPhaseIter, List<DocIdSetIterator> allIterators, List<TwoPhaseIterator> twoPhaseIterators)`
Given a two-phase iterator, find any sub-iterators and add them to the provided DocIdSetIterator and TwoPhaseIterator lists
`static DocIdSetIterator`
ConjunctionUtils.`createConjunction(List<DocIdSetIterator> allIterators, List<TwoPhaseIterator> twoPhaseIterators)`
Create a conjunction over the provided set of DocIdSetIterators and TwoPhaseIterators, using two-phase iterator where possible.
`static DocIdSetIterator`
ConjunctionUtils.`intersectIterators(List<? extends DocIdSetIterator> iterators)`
Create a conjunction over the provided DocIdSetIterators.
Constructors in org.apache.lucene.search with parameters of type DocIdSetIterator
Modifier
Constructor
Description
``
`ConstantScoreScorer(float score, ScoreMode scoreMode, DocIdSetIterator disi)`
Constructor based on a `DocIdSetIterator` which will be used to drive iteration.
``
`FilteredDocIdSetIterator(DocIdSetIterator innerIter)`
Constructor.
``
`ImpactsDISI(DocIdSetIterator in, MaxScoreCache maxScoreCache)`
Sole constructor.
`protected`
`TwoPhaseIterator(DocIdSetIterator approximation)`
Takes the approximation to be returned by `TwoPhaseIterator.approximation`.

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

Subclasses of DocIdSetIterator in org.apache.lucene.search.comparators
Modifier and Type
Class
Description
`class`
`MinDocIterator`
Docs iterator that starts iterating from a configurable minimum document
Methods in org.apache.lucene.search.comparators that return DocIdSetIterator
Modifier and Type
Method
Description
`DocIdSetIterator`
NumericComparator.NumericLeafComparator.`competitiveIterator()`

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

Subclasses of DocIdSetIterator in org.apache.lucene.util
Modifier and Type
Class
Description
`class`
`BitSetIterator`
A `DocIdSetIterator` which iterates over set bits in a bit set.
`class`
`DocBaseBitSetIterator`
A `DocIdSetIterator` like `BitSetIterator` but has a doc base in onder to avoid storing previous 0s.
Methods in org.apache.lucene.util that return DocIdSetIterator
Modifier and Type
Method
Description
`DocIdSetIterator`
BitDocIdSet.`iterator()`
`DocIdSetIterator`
NotDocIdSet.`iterator()`
`DocIdSetIterator`
RoaringDocIdSet.`iterator()`
Methods in org.apache.lucene.util with parameters of type DocIdSetIterator
Modifier and Type
Method
Description
`void`
DocIdSetBuilder.`add(DocIdSetIterator iter)`
Add the content of the provided `DocIdSetIterator` to this builder.
`void`
DocIdSetBuilder.BulkAdder.`add(DocIdSetIterator iterator)`
`RoaringDocIdSet.Builder`
RoaringDocIdSet.Builder.`add(DocIdSetIterator disi)`
Add the content of the provided `DocIdSetIterator`.
`void`
FixedBitSet.`andNot(DocIdSetIterator iter)`
`protected final void`
BitSet.`checkUnpositioned(DocIdSetIterator iter)`
Assert that the current doc is -1.
`static FixedBitSet`
BitSetIterator.`getFixedBitSetOrNull(DocIdSetIterator iterator)`
If the provided iterator wraps a `FixedBitSet`, returns it, otherwise returns null.
`static SparseFixedBitSet`
BitSetIterator.`getSparseFixedBitSetOrNull(DocIdSetIterator iterator)`
If the provided iterator wraps a `SparseFixedBitSet`, returns it, otherwise returns null.
`static BitSet`
BitSet.`of(DocIdSetIterator it, int maxDoc)`
Build a `BitSet` from the content of the provided `DocIdSetIterator`.
`void`
BitSet.`or(DocIdSetIterator iter)`
Does in-place OR of the bits provided by the iterator.
`void`
FixedBitSet.`or(DocIdSetIterator iter)`
`void`
SparseFixedBitSet.`or(DocIdSetIterator it)`
`void`
FixedBitSet.`xor(DocIdSetIterator iter)`
Does in-place XOR of the bits provided by the iterator.