Class ReadOnlySimilarityDefinitionCollection

Namespace

Examine

Assembly

Examine.Core.dll

Manages the mappings between a similarity name and it's similarity type

public class ReadOnlySimilarityDefinitionCollection : IEnumerable<SimilarityDefinition>, IEnumerable

Inheritance

object

ReadOnlySimilarityDefinitionCollection

Implements

IEnumerable<SimilarityDefinition>

IEnumerable

Derived

SimilarityDefinitionCollection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReadOnlySimilarityDefinitionCollection()

Constructor

public ReadOnlySimilarityDefinitionCollection()

ReadOnlySimilarityDefinitionCollection(string?, params SimilarityDefinition[])

Constructor

public ReadOnlySimilarityDefinitionCollection(string? defaultSimilarityName, params SimilarityDefinition[] definitions)

Parameters

defaultSimilarityName string

definitions SimilarityDefinition[]

ReadOnlySimilarityDefinitionCollection(string?, IEnumerable<SimilarityDefinition>)

Constructor

public ReadOnlySimilarityDefinitionCollection(string? defaultSimilarityName, IEnumerable<SimilarityDefinition> definitions)

Parameters

defaultSimilarityName string

definitions IEnumerable<SimilarityDefinition>

Properties

Count

Count

public int Count { get; }

Property Value

int

DefaultSimilarityName

The name of the Similarity the index should use by default

public string? DefaultSimilarityName { get; set; }

Property Value

string

Definitions

Definitions

protected ConcurrentDictionary<string, SimilarityDefinition> Definitions { get; }

Property Value

ConcurrentDictionary<string, SimilarityDefinition>

Methods

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<SimilarityDefinition> GetEnumerator()

Returns

IEnumerator<SimilarityDefinition>

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

TryGetValue(string, out SimilarityDefinition)

Tries to get a SimilarityDefinition by similarity name

public virtual bool TryGetValue(string similarityName, out SimilarityDefinition similarityDefinition)

Parameters

similarityName string

similarityDefinition SimilarityDefinition

Returns

bool

returns true if one was found otherwise false

Remarks

Marked as virtual so developers can inherit this class and override this method in case similarity definitions are dynamic.