Package org.apache.lucene.search
Class BitsFilteredDocIdSet
- java.lang.Object
-
- org.apache.lucene.search.DocIdSet
-
- org.apache.lucene.search.FilteredDocIdSet
-
- org.apache.lucene.search.BitsFilteredDocIdSet
-
public final class BitsFilteredDocIdSet extends FilteredDocIdSet
This implementation supplies a filtered DocIdSet, that excludes all docids which are not in a Bits instance. This is especially useful inFilter
to apply theacceptDocs
passed togetDocIdSet()
before returning the final DocIdSet.
-
-
Constructor Summary
Constructors Constructor Description BitsFilteredDocIdSet(DocIdSet innerSet, Bits acceptDocs)
Constructor.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static DocIdSet
wrap(DocIdSet set, Bits acceptDocs)
Convenience wrapper method: IfacceptDocs == null
it returns the original set without wrapping.-
Methods inherited from class org.apache.lucene.search.FilteredDocIdSet
bits, isCacheable, iterator
-
-
-
-
Method Detail
-
wrap
public static DocIdSet wrap(DocIdSet set, Bits acceptDocs)
Convenience wrapper method: IfacceptDocs == null
it returns the original set without wrapping.- Parameters:
set
- Underlying DocIdSet. Ifnull
, this method returnsnull
acceptDocs
- Allowed docs, all docids not in this set will not be returned by this DocIdSet. Ifnull
, this method returns the original set without wrapping.
-
-