C# Class Lucene.Net.Search.BitsFilteredDocIdSet

this implementation supplies a filtered DocIdSet, that excludes all docids which are not in a Bits instance. this is especially useful in Lucene.Net.Search.Filter to apply the {@code acceptDocs} passed to {@code getDocIdSet()} before returning the final DocIdSet.

Inheritance: FilteredDocIdSet

Show file Open project: apache/lucenenet Class Usage Examples

Public Methods

Method	Description
BitsFilteredDocIdSet ( Lucene.Net.Search.DocIdSet innerSet, Lucene.Net.Util.Bits acceptDocs )	Constructor.
Wrap ( Lucene.Net.Search.DocIdSet set, Lucene.Net.Util.Bits acceptDocs ) : Lucene.Net.Search.DocIdSet	Convenience wrapper method: If {@code acceptDocs == null} it returns the original set without wrapping.

Protected Methods

Method	Description
Match ( int docid ) : bool

Method Details

BitsFilteredDocIdSet() public method

Constructor.

public BitsFilteredDocIdSet ( Lucene.Net.Search.DocIdSet innerSet, Lucene.Net.Util.Bits acceptDocs )
innerSet	Lucene.Net.Search.DocIdSet	Underlying DocIdSet
acceptDocs	Lucene.Net.Util.Bits	Allowed docs, all docids not in this set will not be returned by this DocIdSet

Match() protected method

protected Match ( int docid ) : bool
docid	int
return	bool

Wrap() public static method

Convenience wrapper method: If {@code acceptDocs == null} it returns the original set without wrapping.

public static Wrap ( Lucene.Net.Search.DocIdSet set, Lucene.Net.Util.Bits acceptDocs ) : Lucene.Net.Search.DocIdSet
set	Lucene.Net.Search.DocIdSet	Underlying DocIdSet. If {@code null}, this method returns {@code null}
acceptDocs	Lucene.Net.Util.Bits	Allowed docs, all docids not in this set will not be returned by this DocIdSet. /// If {@code null}, this method returns the original set without wrapping.
return	Lucene.Net.Search.DocIdSet