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 Lucene.Net.Search.BitsFilteredDocIdSet.acceptDocs passed to GetDocIdSet(AtomicReaderContext, IBits) before returning the final DocIdSet.

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

Constructors

| Improve this Doc View Source

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

Methods

| Improve this Doc View Source

Match(Int32)

Declaration
protected override bool Match(int docid)
Parameters
Type Name Description
System.Int32 docid
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

Wrap(DocIdSet, IBits)

Convenience wrapper method: If acceptDocs == 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