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

Packages that use Bits

Package	Description
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.lucene40	Lucene 4.0 file format.
org.apache.lucene.codecs.lucene41	Lucene 4.1 file format.
org.apache.lucene.codecs.lucene45	Lucene 4.5 file format.
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 Bits in org.apache.lucene.codecs

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

Modifier and Type	Class	Description
static class	DocValuesProducer.SortedDocsWithField	A simple implementation of DocValuesProducer.getDocsWithField(org.apache.lucene.index.FieldInfo) that returns true if a document has an ordinal >= 0
static class	DocValuesProducer.SortedSetDocsWithField	A simple implementation of DocValuesProducer.getDocsWithField(org.apache.lucene.index.FieldInfo) that returns true if a document has any ordinals.

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

Modifier and Type	Method	Description
abstract Bits	DocValuesProducer.getDocsWithField(FieldInfo field)	Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field.
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 DocsEnum	PostingsReaderBase.docs(FieldInfo fieldInfo, BlockTermState state, Bits skipDocs, DocsEnum reuse, int flags)	Must fully consume state, since after this call that TermState may be reused.
abstract DocsAndPositionsEnum	PostingsReaderBase.docsAndPositions(FieldInfo fieldInfo, BlockTermState state, Bits skipDocs, DocsAndPositionsEnum reuse, int flags)	Must fully consume state, since after this call that TermState may be reused.
abstract MutableBits	LiveDocsFormat.newLiveDocs(Bits existing)	Creates a new mutablebits of the same bits set and size of existing.

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

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

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

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

Modifier and Type	Method	Description
DocsEnum	Lucene40PostingsReader.docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)	Deprecated.
DocsAndPositionsEnum	Lucene40PostingsReader.docsAndPositions(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsAndPositionsEnum reuse, int flags)	Deprecated.
MutableBits	Lucene40LiveDocsFormat.newLiveDocs(Bits existing)

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

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

Modifier and Type	Method	Description
DocsEnum	Lucene41PostingsReader.docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)
DocsAndPositionsEnum	Lucene41PostingsReader.docsAndPositions(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsAndPositionsEnum reuse, int flags)

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

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

Modifier and Type	Method	Description
Bits	Lucene45DocValuesProducer.getDocsWithField(FieldInfo field)

Uses of Bits in org.apache.lucene.index

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

Modifier and Type	Method	Description
abstract Bits	AtomicReader.getDocsWithField(String field)	Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field.
Bits	FilterAtomicReader.getDocsWithField(String field)
static Bits	MultiDocValues.getDocsWithField(IndexReader r, String field)	Returns a Bits for a reader's docsWithField (potentially merging on-the-fly)
Bits	ParallelAtomicReader.getDocsWithField(String field)
Bits	SegmentReader.getDocsWithField(String field)
Bits	SlowCompositeReaderWrapper.getDocsWithField(String field)
abstract Bits	AtomicReader.getLiveDocs()	Returns the Bits representing live (not deleted) docs.
Bits	FilterAtomicReader.getLiveDocs()
static Bits	MultiFields.getLiveDocs(IndexReader reader)	Returns a single Bits instance for this reader, merging live Documents on the fly.
Bits	ParallelAtomicReader.getLiveDocs()
Bits	SegmentReader.getLiveDocs()
Bits	SlowCompositeReaderWrapper.getLiveDocs()

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

Modifier and Type	Method	Description
DocsEnum	FilterAtomicReader.FilterTermsEnum.docs(Bits liveDocs, DocsEnum reuse, int flags)
DocsEnum	FilteredTermsEnum.docs(Bits bits, DocsEnum reuse, int flags)
DocsEnum	MultiTermsEnum.docs(Bits liveDocs, DocsEnum reuse, int flags)
final DocsEnum	TermsEnum.docs(Bits liveDocs, DocsEnum reuse)	Get DocsEnum for the current term.
abstract DocsEnum	TermsEnum.docs(Bits liveDocs, DocsEnum reuse, int flags)	Get DocsEnum for the current term, with control over whether freqs are required.
DocsAndPositionsEnum	FilterAtomicReader.FilterTermsEnum.docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, int flags)
DocsAndPositionsEnum	FilteredTermsEnum.docsAndPositions(Bits bits, DocsAndPositionsEnum reuse, int flags)
DocsAndPositionsEnum	MultiTermsEnum.docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, int flags)
final DocsAndPositionsEnum	TermsEnum.docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse)	Get DocsAndPositionsEnum for the current term.
abstract DocsAndPositionsEnum	TermsEnum.docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, int flags)	Get DocsAndPositionsEnum for the current term, with control over whether offsets and payloads are required.
static DocsEnum	MultiFields.getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)	Returns DocsEnum for the specified field & term.
static DocsEnum	MultiFields.getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)	Returns DocsEnum for the specified field & term, with control over whether freqs are required.
static DocsAndPositionsEnum	MultiFields.getTermPositionsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)	Returns DocsAndPositionsEnum for the specified field & term.
static DocsAndPositionsEnum	MultiFields.getTermPositionsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)	Returns DocsAndPositionsEnum for the specified field & term, with control over whether offsets and payloads are required.
protected void	DocTermOrds.uninvert(AtomicReader reader, Bits liveDocs, BytesRef termPrefix)	Call this only once (if you subclass!)

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

Modifier	Constructor	Description
	DocTermOrds(AtomicReader reader, Bits liveDocs, String field)	Inverts all terms
	DocTermOrds(AtomicReader reader, Bits liveDocs, String field, BytesRef termPrefix)	Inverts only terms starting w/ prefix
	DocTermOrds(AtomicReader reader, Bits liveDocs, String field, BytesRef termPrefix, int maxTermDocFreq)	Inverts only terms starting w/ prefix, and only terms whose docFreq (not taking deletions into account) is <= maxTermDocFreq
	DocTermOrds(AtomicReader reader, Bits liveDocs, String field, BytesRef termPrefix, int maxTermDocFreq, int indexIntervalBits)	Inverts only terms starting w/ prefix, and only terms whose docFreq (not taking deletions into account) is <= maxTermDocFreq, with a custom indexing interval (default is every 128nd term).

Uses of Bits in org.apache.lucene.search

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

Modifier and Type	Field	Description
protected final Bits	FieldCacheDocIdSet.acceptDocs
protected Bits	FieldComparator.NumericComparator.docsWithField

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.
final Bits	FieldCacheDocIdSet.bits()
Bits	FilteredDocIdSet.bits()
Bits	FieldCache.getDocsWithField(AtomicReader reader, String field)	Checks the internal cache for an appropriate entry, and if none is found, reads the terms in field and returns a bit set at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field.

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

Modifier and Type	Method	Description
DocsEnum	FuzzyTermsEnum.docs(Bits liveDocs, DocsEnum reuse, int flags)
DocsAndPositionsEnum	FuzzyTermsEnum.docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, int flags)
DocIdSet	CachingWrapperFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)
abstract DocIdSet	DocTermOrdsRangeFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)	This method is implemented for each data type
abstract DocIdSet	FieldCacheRangeFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)	This method is implemented for each data type
DocIdSet	FieldCacheTermsFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)
DocIdSet	FieldValueFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)
abstract DocIdSet	Filter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)	Creates a DocIdSet enumerating the documents that should be permitted in search results.
DocIdSet	MultiTermQueryWrapperFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)	Returns a DocIdSet with documents that should be permitted in search results.
DocIdSet	QueryWrapperFilter.getDocIdSet(AtomicReaderContext context, Bits acceptDocs)
Scorer	BooleanQuery.BooleanWeight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)
Scorer	ConstantScoreQuery.ConstantWeight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)
Scorer	DisjunctionMaxQuery.DisjunctionMaxWeight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)	Create the scorer used to score our associated DisjunctionMaxQuery
abstract Scorer	Weight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)	Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.
protected boolean	FilteredQuery.RandomAccessFilterStrategy.useRandomAccess(Bits bits, int firstFilterDoc)	Expert: decides if a filter should be executed as "random-access" or not.
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 Bits

Modifier	Constructor	Description
	BitsFilteredDocIdSet(DocIdSet innerSet, Bits acceptDocs)	Constructor.
	FieldCacheDocIdSet(int maxDoc, Bits acceptDocs)

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

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

Modifier and Type	Method	Description
Scorer	PayloadNearQuery.PayloadNearSpanWeight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)
Scorer	PayloadTermQuery.PayloadTermWeight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)

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

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

Modifier and Type	Method	Description
Spans	FieldMaskingSpanQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
Spans	SpanMultiTermQueryWrapper.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
Spans	SpanNearQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
Spans	SpanNotQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
Spans	SpanOrQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
Spans	SpanPositionCheckQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
abstract Spans	SpanQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)	Expert: Returns the matches for this query in an index.
Spans	SpanTermQuery.getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
Scorer	SpanWeight.scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)

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

Modifier	Constructor	Description
	NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
	NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts, boolean collectPayloads)
	NearSpansUnordered(SpanNearQuery query, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)
	PositionCheckSpan(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)

Uses of Bits in org.apache.lucene.util

Subinterfaces of Bits in org.apache.lucene.util

Modifier and Type	Interface	Description
interface	MutableBits	Extension of Bits for live documents.

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	DocIdBitSet	Simple DocIdSet and DocIdSetIterator backed by a BitSet
final 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.

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	DocIdBitSet.bits()
Bits	FixedBitSet.bits()
Bits	OpenBitSet.bits()