Class BitsFilteredDocIdSet

This implementation supplies a filtered DocIdSet, that excludes all docids which are not in a IBits instance. This is especially useful in Filter to apply the acceptDocs passed to GetDocIdSet(AtomicReaderContext, IBits) before returning the final DocIdSet.

Inheritance
object
DocIdSet
FilteredDocIdSet
BitsFilteredDocIdSet
Inherited Members
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public sealed class BitsFilteredDocIdSet : FilteredDocIdSet

Constructors

BitsFilteredDocIdSet(DocIdSet, IBits)

Constructor.

Declaration
public BitsFilteredDocIdSet(DocIdSet innerSet, IBits acceptDocs)
Parameters
Type Name Description
DocIdSet innerSet

Underlying DocIdSet
IBits acceptDocs

Allowed docs, all docids not in this set will not be returned by this DocIdSet
See Also

Methods

Match(int)

Validation method to determine whether a docid should be in the result set.

Declaration
protected override bool Match(int docid)
Parameters
Type Name Description
int docid

docid to be tested
Returns
Type Description
bool

true if input docid should be in the result set, false otherwise.
Overrides
See Also

Wrap(DocIdSet, IBits)

Convenience wrapper method: If acceptDocs is null it returns the original set without wrapping.

Declaration
public static DocIdSet Wrap(DocIdSet set, IBits acceptDocs)
Parameters
Type Name Description
DocIdSet set

Underlying DocIdSet. If null, this method returns null
IBits 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.
Returns
Type Description
DocIdSet
See Also

See Also