Class DocIdSet

A DocIdSet contains a set of doc ids. Implementing classes must only implement GetIterator() to provide access to the set.

Inheritance
System.Object
DocIdSet
FieldCacheDocIdSet
FilteredDocIdSet
DocIdBitSet
FixedBitSet
OpenBitSet
EliasFanoDocIdSet
PForDeltaDocIdSet
WAH8DocIdSet
Assembly: DistributedLucene.Net.dll
Syntax
public abstract class DocIdSet : object

Properties

Name Description
Bits

Optionally provides a IBits interface for random access to matching documents.

IsCacheable

This method is a hint for CachingWrapperFilter, if this DocIdSet should be cached without copying it. The default is to return false. If you have an own DocIdSet implementation that does its iteration very effective and fast without doing disk I/O, override this property and return true.

Methods

Name Description
GetIterator()

Provides a DocIdSetIterator to access the set. This implementation can return null if there are no docs that match.
NewAnonymous(Func<DocIdSetIterator>)

Creates a new instance with the ability to specify the body of the GetIterator() method through the getIterator parameter. Simple example:

    var docIdSet = DocIdSet.NewAnonymous(getIterator: () =>
    {
        OpenBitSet bitset = new OpenBitSet(5);
        bitset.Set(0, 5);
        return new DocIdBitSet(bitset);
    });

LUCENENET specific
NewAnonymous(Func<DocIdSetIterator>, Func<IBits>)

Creates a new instance with the ability to specify the body of the GetIterator() method through the getIterator parameter and the body of the Bits property through the bits parameter. Simple example:

    var docIdSet = DocIdSet.NewAnonymous(getIterator: () =>
    {
        OpenBitSet bitset = new OpenBitSet(5);
        bitset.Set(0, 5);
        return new DocIdBitSet(bitset);
    }, bits: () => 
    {
        return bits;
    });

LUCENENET specific
NewAnonymous(Func<DocIdSetIterator>, Func<IBits>, Func<Boolean>)

Creates a new instance with the ability to specify the body of the GetIterator() method through the getIterator parameter and the body of the Bits property through the bits parameter. Simple example:

    var docIdSet = DocIdSet.NewAnonymous(getIterator: () =>
    {
        OpenBitSet bitset = new OpenBitSet(5);
        bitset.Set(0, 5);
        return new DocIdBitSet(bitset);
    }, bits: () => 
    {
        return bits;
    }, isCacheable: () =>
    {
        return true;
    });

LUCENENET specific
NewAnonymous(Func<DocIdSetIterator>, Func<Boolean>)

Creates a new instance with the ability to specify the body of the GetIterator() method through the getIterator parameter and the body of the IsCacheable property through the isCacheable parameter. Simple example:

    var docIdSet = DocIdSet.NewAnonymous(getIterator: () =>
    {
        OpenBitSet bitset = new OpenBitSet(5);
        bitset.Set(0, 5);
        return new DocIdBitSet(bitset);
    }, isCacheable: () =>
    {
        return true;
    });

LUCENENET specific

Extension Methods