Uses of Interface
org.apache.lucene.util.Bits

Packages that use Bits

Package	Description
org.apache.lucene.analysis.util	Utility functions for text analysis.
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.idversion	A primary-key postings format that associates a version (long) with each term and can provide fail-fast lookups by ID and version.
org.apache.lucene.codecs.lucene50	Components from the Lucene 5.0 index format See org.apache.lucene.codecs.lucene80 for an overview of the index format.
org.apache.lucene.codecs.memory	Term dictionary, DocValues or Postings formats that are read entirely into memory.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
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.index.memory	High-performance single-document main memory Apache Lucene fulltext search index.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	Grouping.
org.apache.lucene.search.highlight	Highlighting search terms.
org.apache.lucene.search.join	Support for index-time and query-time joins.
org.apache.lucene.search.suggest	Support for Autocomplete/Autosuggest
org.apache.lucene.search.suggest.document	Support for document suggestion
org.apache.lucene.util	Some utility classes.

Uses of Bits in org.apache.lucene.analysis.util

Fields in org.apache.lucene.analysis.util declared as Bits

Modifier and Type	Field	Description
static final Bits	UnicodeProps.WHITESPACE	Bitset with Unicode WHITESPACE code points.

Methods in org.apache.lucene.analysis.util that return Bits

Modifier and Type	Method	Description
private static Bits	UnicodeProps.createBits(int... codepoints)

Uses of Bits in org.apache.lucene.codecs

Methods in org.apache.lucene.codecs that return Bits

Modifier and Type	Method	Description
abstract Bits	LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)	Read live docs bits.

Methods in org.apache.lucene.codecs with parameters of type Bits

Modifier and Type	Method	Description
abstract void	LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)	Persist live docs bits.

Uses of Bits in org.apache.lucene.codecs.idversion

Fields in org.apache.lucene.codecs.idversion declared as Bits

Modifier and Type	Field	Description
private final Bits	IDVersionPostingsWriter.liveDocs

Constructors in org.apache.lucene.codecs.idversion with parameters of type Bits

Modifier	Constructor	Description
	IDVersionPostingsWriter(Bits liveDocs)

Uses of Bits in org.apache.lucene.codecs.lucene50

Methods in org.apache.lucene.codecs.lucene50 that return Bits

Modifier and Type	Method	Description
Bits	Lucene50LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)

Methods in org.apache.lucene.codecs.lucene50 with parameters of type Bits

Modifier and Type	Method	Description
void	Lucene50LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)

Uses of Bits in org.apache.lucene.codecs.memory

Fields in org.apache.lucene.codecs.memory declared as Bits

Modifier and Type	Field	Description
private final Bits	LegacyBinaryDocValuesWrapper.docsWithField	Deprecated.
private final Bits	LegacyNumericDocValuesWrapper.docsWithField	Deprecated.

Methods in org.apache.lucene.codecs.memory that return Bits

Modifier and Type	Method	Description
private Bits	DirectDocValuesProducer.getMissingBits(FieldInfo field, long offset, long length)

Constructors in org.apache.lucene.codecs.memory with parameters of type Bits

Modifier	Constructor	Description
	LegacyBinaryDocValuesWrapper(Bits docsWithField, LegacyBinaryDocValues values)	Deprecated.
	LegacyNumericDocValuesWrapper(Bits docsWithField, LegacyNumericDocValues values)	Deprecated.

Uses of Bits in org.apache.lucene.codecs.simpletext

Classes in org.apache.lucene.codecs.simpletext that implement Bits

Modifier and Type	Class	Description
(package private) static class	SimpleTextLiveDocsFormat.SimpleTextBits

Methods in org.apache.lucene.codecs.simpletext that return Bits

Modifier and Type	Method	Description
Bits	SimpleTextLiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)

Methods in org.apache.lucene.codecs.simpletext with parameters of type Bits

Modifier and Type	Method	Description
void	SimpleTextLiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)

Uses of Bits in org.apache.lucene.document

Fields in org.apache.lucene.document declared as Bits

Modifier and Type	Field	Description
(package private) Bits	FloatPointNearestNeighbor.NearestVisitor.curLiveDocs

Uses of Bits in org.apache.lucene.index

Classes in org.apache.lucene.index that implement Bits

Modifier and Type	Class	Description
(package private) final class	BitsSlice	Exposes a slice of an existing Bits as a new Bits.
final class	MultiBits	Concatenates multiple Bits together, on every lookup.
private static class	SortingCodecReader.SortingBits

Fields in org.apache.lucene.index declared as Bits

Modifier and Type	Field	Description
(package private) final Bits	MergePolicy.MergeReader.hardLiveDocs
private final Bits	SegmentReader.hardLiveDocs
private final Bits	SortingCodecReader.SortingBits.in
final Bits[]	MergeState.liveDocs	Live docs for each reader
(package private) final Bits	MultiSorter.LeafAndDocID.liveDocs
private Bits	PendingDeletes.liveDocs
(package private) final Bits	PKIndexSplitter.DocumentFilteredLeafIndexReader.liveDocs
private final Bits	SegmentReader.liveDocs
private final Bits	BitsSlice.parent
private final Bits[]	MultiBits.subs
private final Bits	FieldUpdatesBuffer.BufferedUpdateIterator.updatesWithValue

Methods in org.apache.lucene.index that return Bits

Modifier and Type	Method	Description
(package private) Bits	PendingDeletes.getHardLiveDocs()	Returns a snapshot of the hard live docs.
(package private) Bits	PendingSoftDeletes.getHardLiveDocs()
Bits	ReadersAndUpdates.getHardLiveDocs()	Returns the live-docs bits excluding documents that are not live due to soft-deletes
Bits	SegmentReader.getHardLiveDocs()	Returns the live docs that are not hard-deleted.
final Bits	DocValuesLeafReader.getLiveDocs()
Bits	FilterCodecReader.getLiveDocs()
Bits	FilterLeafReader.getLiveDocs()
abstract Bits	LeafReader.getLiveDocs()	Returns the Bits representing live (not deleted) docs.
Bits	MergeReaderWrapper.getLiveDocs()
static Bits	MultiBits.getLiveDocs(IndexReader reader)	Returns a single Bits instance for this reader, merging live Documents on the fly.
Bits	MultiPassIndexSplitter.FakeDeleteLeafIndexReader.getLiveDocs()
Bits	ParallelLeafReader.getLiveDocs()
(package private) Bits	PendingDeletes.getLiveDocs()	Returns a snapshot of the current live docs.
Bits	PKIndexSplitter.DocumentFilteredLeafIndexReader.getLiveDocs()
Bits	ReadersAndUpdates.getLiveDocs()	Returns a snapshot of the live docs.
Bits	SegmentReader.getLiveDocs()
Bits	SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader.getLiveDocs()
Bits	SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterLeafReader.getLiveDocs()
Bits	SortingCodecReader.getLiveDocs()

Methods in org.apache.lucene.index with parameters of type Bits

Modifier and Type	Method	Description
private boolean	PendingDeletes.assertCheckLiveDocs(Bits bits, int expectedLength, int expectedDeleteCount)
private static boolean	SegmentReader.assertLiveDocs(boolean isNRT, Bits hardLiveDocs, Bits liveDocs)
private static void	IndexWriter.carryOverHardDeletes(ReadersAndUpdates mergedReadersAndUpdates, int maxDoc, Bits mergeLiveDocs, Bits prevHardLiveDocs, Bits currentHardLiveDocs, MergeState.DocMap segDocMap, MergeState.DocMap segLeafDocMap)	This method carries over hard-deleted documents that are applied to the source segment during a merge.
private static CheckIndex.Status.TermIndexStatus	CheckIndex.checkFields(Fields fields, Bits liveDocs, int maxDoc, FieldInfos fieldInfos, NormsProducer normsProducer, boolean doPrint, boolean isVectors, PrintStream infoStream, boolean verbose, boolean doSlowChecks)	checks Fields api is consistent with itself.
private void	IndexWriter.countSoftDeletes(CodecReader reader, Bits wrappedLiveDocs, Bits hardLiveDocs, Counter softDeleteCounter, Counter hardDeleteCounter)
(package private) static int	PendingSoftDeletes.countSoftDeletes(DocIdSetIterator softDeletedDocs, Bits hardDeletes)
(package private) static PackedLongValues	MergeState.removeDeletes(int maxDoc, Bits liveDocs)
private FixedBitSet	DocumentsWriterPerThread.sortLiveDocs(Bits liveDocs, Sorter.DocMap sortMap)
(package private) static FilterCodecReader	FilterCodecReader.wrapLiveDocs(CodecReader reader, Bits liveDocs, int numDocs)	Returns a filtered codec reader with the given live docs and numDocs.

Constructors in org.apache.lucene.index with parameters of type Bits

Modifier	Constructor	Description
	BitsSlice(Bits parent, ReaderSlice slice)
	LeafAndDocID(int readerIndex, Bits liveDocs, int maxDoc, int numComparables)
(package private)	MergeReader(SegmentReader reader, Bits hardLiveDocs)
private	MultiBits(Bits[] subs, int[] starts, boolean defaultValue)
(package private)	PendingDeletes(SegmentCommitInfo info, Bits liveDocs, boolean liveDocsInitialized)
(package private)	SegmentReader(SegmentCommitInfo si, SegmentReader sr, Bits liveDocs, Bits hardLiveDocs, int numDocs, boolean isNRT)	Create new SegmentReader sharing core from a previous SegmentReader and using the provided liveDocs, and recording whether those liveDocs were carried in ram (isNRT=true).
(package private)	SortingBits(Bits in, Sorter.DocMap docMap)

Uses of Bits in org.apache.lucene.index.memory

Methods in org.apache.lucene.index.memory that return Bits

Modifier and Type	Method	Description
Bits	MemoryIndex.MemoryIndexReader.getLiveDocs()

Uses of Bits in org.apache.lucene.search

Fields in org.apache.lucene.search declared as Bits

Modifier and Type	Field	Description
Bits	NearestNeighbor.NearestVisitor.curLiveDocs

Methods in org.apache.lucene.search that return Bits

Modifier and Type	Method	Description
Bits	DocIdSet.bits()	Optionally provides a Bits interface for random access to matching documents.

Methods in org.apache.lucene.search with parameters of type Bits

Modifier and Type	Method	Description
(package private) void	BooleanScorer.BulkScorerAndDoc.score(LeafCollector collector, Bits acceptDocs, int min, int max)
int	BooleanScorer.score(LeafCollector collector, Bits acceptDocs, int min, int max)
void	BulkScorer.score(LeafCollector collector, Bits acceptDocs)	Scores and collects all matching documents.
abstract int	BulkScorer.score(LeafCollector collector, Bits acceptDocs, int min, int max)	Collects matching documents in a range and return an estimation of the next matching document which is on or after max.
int	ConstantScoreQuery.ConstantBulkScorer.score(LeafCollector collector, Bits acceptDocs, int min, int max)
int	ReqExclBulkScorer.score(LeafCollector collector, Bits acceptDocs, int min, int max)
int	Weight.DefaultBulkScorer.score(LeafCollector collector, Bits acceptDocs, int min, int max)
(package private) static void	Weight.DefaultBulkScorer.scoreAll(LeafCollector collector, DocIdSetIterator iterator, TwoPhaseIterator twoPhase, Bits acceptDocs)	Specialized method to bulk-score all hits; we separate this from Weight.DefaultBulkScorer.scoreRange(org.apache.lucene.search.LeafCollector, org.apache.lucene.search.DocIdSetIterator, org.apache.lucene.search.TwoPhaseIterator, org.apache.lucene.util.Bits, int, int) to help out hotspot.
(package private) static int	Weight.DefaultBulkScorer.scoreRange(LeafCollector collector, DocIdSetIterator iterator, TwoPhaseIterator twoPhase, Bits acceptDocs, int currentDoc, int end)	Specialized method to bulk-score a range of hits; we separate this from Weight.DefaultBulkScorer.scoreAll(org.apache.lucene.search.LeafCollector, org.apache.lucene.search.DocIdSetIterator, org.apache.lucene.search.TwoPhaseIterator, org.apache.lucene.util.Bits) to help out hotspot.
private BooleanScorer.BulkScorerAndDoc	BooleanScorer.scoreWindow(BooleanScorer.BulkScorerAndDoc top, LeafCollector collector, Bits acceptDocs, int min, int max)
private void	BooleanScorer.scoreWindowIntoBitSetAndReplay(LeafCollector collector, Bits acceptDocs, int base, int min, int max, BooleanScorer.BulkScorerAndDoc[] scorers, int numScorers)
private void	BooleanScorer.scoreWindowMultipleScorers(LeafCollector collector, Bits acceptDocs, int windowBase, int windowMin, int windowMax, int maxFreq)
private void	BooleanScorer.scoreWindowSingleScorer(BooleanScorer.BulkScorerAndDoc bulkScorer, LeafCollector collector, Bits acceptDocs, int windowMin, int windowMax, int max)

Uses of Bits in org.apache.lucene.search.grouping

Fields in org.apache.lucene.search.grouping declared as Bits

Modifier and Type	Field	Description
private Bits	GroupingSearch.matchingGroupHeads

Methods in org.apache.lucene.search.grouping that return Bits

Modifier and Type	Method	Description
Bits	GroupingSearch.getAllGroupHeads()	Returns the matching group heads if GroupingSearch.setAllGroupHeads(boolean) was set to true or an empty bit set.

Uses of Bits in org.apache.lucene.search.highlight

Methods in org.apache.lucene.search.highlight that return Bits

Modifier and Type	Method	Description
Bits	TermVectorLeafReader.getLiveDocs()

Uses of Bits in org.apache.lucene.search.join

Methods in org.apache.lucene.search.join that return Bits

Modifier and Type	Method	Description
static Bits	BlockJoinSelector.wrap(Bits docsWithValue, BitSet parents, BitSet children)	Return a Bits instance that returns true if, and only if, any of the children of the given parent document has a value.

Methods in org.apache.lucene.search.join with parameters of type Bits

Modifier and Type	Method	Description
static Bits	BlockJoinSelector.wrap(Bits docsWithValue, BitSet parents, BitSet children)	Return a Bits instance that returns true if, and only if, any of the children of the given parent document has a value.

Uses of Bits in org.apache.lucene.search.suggest

Fields in org.apache.lucene.search.suggest declared as Bits

Modifier and Type	Field	Description
private final Bits	DocumentDictionary.DocumentInputIterator.liveDocs

Methods in org.apache.lucene.search.suggest that return Bits

Modifier and Type	Method	Description
abstract Bits	BitsProducer.getBits(LeafReaderContext context)	Return Bits for the given leaf.

Uses of Bits in org.apache.lucene.search.suggest.document

Fields in org.apache.lucene.search.suggest.document declared as Bits

Modifier and Type	Field	Description
private final Bits	CompletionScorer.filterDocs

Methods in org.apache.lucene.search.suggest.document with parameters of type Bits

Modifier and Type	Method	Description
final boolean	CompletionScorer.accept(int docID, Bits liveDocs)	Returns true if a document with docID is accepted, false if the docID maps to a deleted document or has been filtered out
void	NRTSuggester.lookup(CompletionScorer scorer, Bits acceptDocs, TopSuggestDocsCollector collector)	Collects at most TopSuggestDocsCollector.getCountToCollect() completions that match the provided CompletionScorer.
int	CompletionScorer.score(LeafCollector collector, Bits acceptDocs, int min, int max)

Constructors in org.apache.lucene.search.suggest.document with parameters of type Bits

Modifier	Constructor	Description
protected	CompletionScorer(CompletionWeight weight, NRTSuggester suggester, LeafReader reader, Bits filterDocs, boolean filtered, Automaton automaton)	Creates a scorer for a field-specific suggester scoped by acceptDocs

Uses of Bits in org.apache.lucene.util

Classes in org.apache.lucene.util that implement Bits

Modifier and Type	Class	Description
static class	Bits.MatchAllBits	Bits impl of the specified length with all bits set.
static class	Bits.MatchNoBits	Bits impl of the specified length with no bits set.
class	BitSet	Base implementation for a bit set.
(package private) final class	FixedBits	Immutable twin of FixedBitSet.
final class	FixedBitSet	BitSet of fixed length (numBits), backed by accessible (FixedBitSet.getBits()) long[], accessed with an int index, implementing Bits and DocIdSet.
class	SparseFixedBitSet	A bit set that only stores longs that have at least one bit which is set.

Fields in org.apache.lucene.util declared as Bits

Modifier and Type	Field	Description
static final Bits[]	Bits.EMPTY_ARRAY

Methods in org.apache.lucene.util that return Bits

Modifier and Type	Method	Description
Bits	FixedBitSet.asReadOnlyBits()	Convert this instance to read-only Bits.
Bits	NotDocIdSet.bits()

Methods in org.apache.lucene.util with parameters of type Bits

Modifier and Type	Method	Description
static FixedBitSet	FixedBitSet.copyOf(Bits bits)	Make a copy of the given bits.