Class FixedBitSetCachingWrapperFilter

A Lucene.Net.Search.CachingWrapperFilter that caches sets using a Lucene.Net.Util.FixedBitSet, as required for joins.

Inheritance

object

Filter

CachingWrapperFilter

FixedBitSetCachingWrapperFilter

Inherited Members

CachingWrapperFilter.Filter

CachingWrapperFilter.GetDocIdSet(AtomicReaderContext, IBits)

CachingWrapperFilter.ToString()

CachingWrapperFilter.Equals(object)

CachingWrapperFilter.GetHashCode()

CachingWrapperFilter.GetSizeInBytes()

Filter.NewAnonymous(Func<AtomicReaderContext, IBits, DocIdSet>)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Search.Join

Assembly: Lucene.Net.Join.dll

Syntax

public sealed class FixedBitSetCachingWrapperFilter : CachingWrapperFilter

Constructors

FixedBitSetCachingWrapperFilter(Filter)

Sole constructor, see Lucene.Net.Search.CachingWrapperFilter.CachingWrapperFilter(Lucene.Net.Search.Filter).

Declaration

public FixedBitSetCachingWrapperFilter(Filter filter)

Parameters

Type	Name	Description
Filter	filter

Methods

DocIdSetToCache(DocIdSet, AtomicReader)

Provide the Lucene.Net.Search.DocIdSet to be cached, using the Lucene.Net.Search.DocIdSet provided by the wrapped Filter.

This implementation returns the given Lucene.Net.Search.DocIdSet, if Lucene.Net.Search.DocIdSet.IsCacheable returns true, else it calls Lucene.Net.Search.CachingWrapperFilter.CacheImpl(Lucene.Net.Search.DocIdSetIterator, Lucene.Net.Index.AtomicReader)

Note: this method returns Lucene.Net.Search.CachingWrapperFilter.EMPTY_DOCIDSET if the given docIdSet is null or if Lucene.Net.Search.DocIdSet.GetIterator() return null. The empty instance is use as a placeholder in the cache instead of the null value.

Declaration

protected override DocIdSet DocIdSetToCache(DocIdSet docIdSet, AtomicReader reader)

Parameters

Type	Name	Description
DocIdSet	docIdSet
AtomicReader	reader

Returns

Type	Description
DocIdSet

Overrides

Lucene.Net.Search.CachingWrapperFilter.DocIdSetToCache(Lucene.Net.Search.DocIdSet, Lucene.Net.Index.AtomicReader)