Class BitsFilteredDocIdSet

  • All Implemented Interfaces:
    org.apache.lucene.util.Accountable

    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 in Filter to apply the acceptDocs passed to getDocIdSet() before returning the final DocIdSet.
    See Also:
    DocIdSet, Filter
    • Constructor Detail

      • BitsFilteredDocIdSet

        public BitsFilteredDocIdSet​(org.apache.lucene.search.DocIdSet innerSet,
                                    org.apache.lucene.util.Bits acceptDocs)
        Constructor.
        Parameters:
        innerSet - Underlying DocIdSet
        acceptDocs - Allowed docs, all docids not in this set will not be returned by this DocIdSet
    • Method Detail

      • wrap

        public static org.apache.lucene.search.DocIdSet wrap​(org.apache.lucene.search.DocIdSet set,
                                                             org.apache.lucene.util.Bits acceptDocs)
        Convenience wrapper method: If acceptDocs == null it returns the original set without wrapping.
        Parameters:
        set - Underlying DocIdSet. If null, this method returns null
        acceptDocs - Allowed docs, all docids not in this set will not be returned by this DocIdSet. If null, this method returns the original set without wrapping.
      • match

        protected boolean match​(int docid)
        Description copied from class: FilteredDocIdSet
        Validation method to determine whether a docid should be in the result set.
        Specified by:
        match in class FilteredDocIdSet
        Parameters:
        docid - docid to be tested
        Returns:
        true if input docid should be in the result set, false otherwise.