Class BloomFilterFactory

Class used to create index-time FuzzySet appropriately configured for each field. Also called to right-size bitsets for serialization.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

BloomFilterFactory

DefaultBloomFilterFactory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs.Bloom

Assembly: Lucene.Net.Codecs.dll

Syntax

public abstract class BloomFilterFactory

Methods

Downsize(FieldInfo, FuzzySet)

Called when downsizing bitsets for serialization.

Declaration

public virtual FuzzySet Downsize(FieldInfo fieldInfo, FuzzySet initialSet)

Parameters

Type	Name	Description
FieldInfo	fieldInfo	The field with sparse set bits.
FuzzySet	initialSet	The bits accumulated.

Returns

Type	Description
FuzzySet	null or a hopefully more densely packed, smaller bitset.

GetSetForField(SegmentWriteState, FieldInfo)

Class used to create index-time FuzzySet appropriately configured for each field. Also called to right-size bitsets for serialization.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public abstract FuzzySet GetSetForField(SegmentWriteState state, FieldInfo info)

Parameters

Type	Name	Description
SegmentWriteState	state	The content to be indexed.
FieldInfo	info	The field requiring a BloomFilter.

Returns

Type	Description
FuzzySet	An appropriately sized set or null if no BloomFiltering required.

IsSaturated(FuzzySet, FieldInfo)

Used to determine if the given filter has reached saturation and should be retired i.e. not saved any more.

Declaration

public abstract bool IsSaturated(FuzzySet bloomFilter, FieldInfo fieldInfo)

Parameters

Type	Name	Description
FuzzySet	bloomFilter	The bloomFilter being tested.
FieldInfo	fieldInfo	The field with which this filter is associated.

Returns

Type	Description
bool	true if the set has reached saturation and should be retired.