Class SimilarityDefinitionCollection

Namespace

Examine

Assembly

Examine.Core.dll

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

public class SimilarityDefinitionCollection : ReadOnlySimilarityDefinitionCollection, IEnumerable<SimilarityDefinition>, IEnumerable

Inheritance

object

ReadOnlySimilarityDefinitionCollection

SimilarityDefinitionCollection

Implements

IEnumerable<SimilarityDefinition>

IEnumerable

Inherited Members

ReadOnlySimilarityDefinitionCollection.TryGetValue(string, out SimilarityDefinition)

ReadOnlySimilarityDefinitionCollection.Count

ReadOnlySimilarityDefinitionCollection.DefaultSimilarityName

ReadOnlySimilarityDefinitionCollection.Definitions

ReadOnlySimilarityDefinitionCollection.GetEnumerator()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SimilarityDefinitionCollection()

Constructor

public SimilarityDefinitionCollection()

SimilarityDefinitionCollection(string?, params SimilarityDefinition[])

Constructor

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

Parameters

defaultSimilarityName string

Name of the default Similarity to use for the index

definitions SimilarityDefinition[]

Methods

AddOrUpdate(SimilarityDefinition)

Replace any definition with the specified one, if one doesn't exist then it is added

public void AddOrUpdate(SimilarityDefinition definition)

Parameters

definition SimilarityDefinition

GetOrAdd(string, Func<string, SimilarityDefinition>)

public SimilarityDefinition GetOrAdd(string fieldName, Func<string, SimilarityDefinition> add)

Parameters

fieldName string

add Func<string, SimilarityDefinition>

Returns

SimilarityDefinition

SetDefaultSimilarityName(string)

Set the name of the Similarity to use by default for the index when not specified at query time

public void SetDefaultSimilarityName(string defaultSimilarityName)

Parameters

defaultSimilarityName string

Similarity Name

TryAdd(SimilarityDefinition)

public bool TryAdd(SimilarityDefinition definition)

Parameters

definition SimilarityDefinition

Returns

bool