Table of Contents

Class SimilarityFactoryCollection

Namespace
Examine.Lucene
Assembly
Examine.Lucene.dll

Manages the collection of ISimilarityTypeFactory

public class SimilarityFactoryCollection : IEnumerable<KeyValuePair<string, ISimilarityTypeFactory>>, IEnumerable
Inheritance
SimilarityFactoryCollection
Implements
Inherited Members

Constructors

SimilarityFactoryCollection(IReadOnlyDictionary<string, ISimilarityTypeFactory>)

Constructor

public SimilarityFactoryCollection(IReadOnlyDictionary<string, ISimilarityTypeFactory> valueTypeFactories)

Parameters

valueTypeFactories IReadOnlyDictionary<string, ISimilarityTypeFactory>

Properties

Count

The ammount of key/value pairs in the collection

public int Count { get; }

Property Value

int

Methods

GetDefaultSimilarities()

Returns the default index similarity types that is used in normal construction of an indexer

public static IReadOnlyDictionary<string, ISimilarityTypeFactory> GetDefaultSimilarities()

Returns

IReadOnlyDictionary<string, ISimilarityTypeFactory>

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<KeyValuePair<string, ISimilarityTypeFactory>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, ISimilarityTypeFactory>>

An enumerator that can be used to iterate through the collection.

GetRequiredFactory(string)

Returns the ISimilarityTypeFactory by name, if it's not found an exception is thrown

public ISimilarityTypeFactory GetRequiredFactory(string valueTypeName)

Parameters

valueTypeName string

Returns

ISimilarityTypeFactory

TryGetFactory(string, out ISimilarityTypeFactory)

Try get for the factory

public bool TryGetFactory(string valueTypeName, out ISimilarityTypeFactory fieldValueTypeFactory)

Parameters

valueTypeName string
fieldValueTypeFactory ISimilarityTypeFactory

Returns

bool