Interface IIcuCollationTokenFilter

Collations are used for sorting documents in a language-specific word order. The icu_collation token filter is available to all indices and defaults to using the DUCET collation, which is a best-effort attempt at language-neutral sorting. Part of the analysis-icu plugin:

Inherited Members

ITokenFilter.Type

ITokenFilter.Version

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public interface IIcuCollationTokenFilter : ITokenFilter

Remarks

Requires analysis-icu plugin to be installed

Properties

Alternate

Sets the alternate handling for strength quaternary to be either shifted or non-ignorable. Which boils down to ignoring punctuation and whitespace.

Declaration

[DataMember(Name = "alternate")]
IcuCollationAlternate? Alternate { get; set; }

Property Value

Type	Description
IcuCollationAlternate?

CaseFirst

Useful to control which case is sorted first when case is not ignored for strength tertiary. The default depends on the collation.

Declaration

[DataMember(Name = "caseFirst")]
IcuCollationCaseFirst? CaseFirst { get; set; }

Property Value

Type	Description
IcuCollationCaseFirst?

CaseLevel

Whether case level sorting is required. When strength is set to primary this will ignore accent differences

Declaration

[DataMember(Name = "caseLevel")]
bool? CaseLevel { get; set; }

Property Value

Type	Description
bool?

Country

Declaration

[DataMember(Name = "country")]
string Country { get; set; }

Property Value

Type	Description
string

Decomposition

Setting this decomposition property to canonical allows the Collator to handle unnormalized text properly, producing the same results as if the text were normalized. If no is set, it is the user’s responsibility to insure that all text is already in the appropriate form before a comparison or before getting a CollationKey. Adjusting decomposition mode allows the user to select between faster and more complete collation behavior. Since a great many of the world’s languages do not require text normalization, most locales set no as the default decomposition mode.

Declaration

[DataMember(Name = "decomposition")]
IcuCollationDecomposition? Decomposition { get; set; }

Property Value

Type	Description
IcuCollationDecomposition?

HiraganaQuaternaryMode

Distinguishing between Katakana and Hiragana characters in quaternary strength.

Declaration

[DataMember(Name = "hiraganaQuaternaryMode")]
bool? HiraganaQuaternaryMode { get; set; }

Property Value

Type	Description
bool?

Language

Declaration

[DataMember(Name = "language")]
string Language { get; set; }

Property Value

Type	Description
string

Numeric

Whether digits are sorted according to their numeric representation. For example the value egg-9 is sorted before the value egg-21.

Declaration

[DataMember(Name = "numeric")]
bool? Numeric { get; set; }

Property Value

Type	Description
bool?

Strength

The strength property determines the minimum level of difference considered significant during comparison.

Declaration

[DataMember(Name = "strength")]
IcuCollationStrength? Strength { get; set; }

Property Value

Type	Description
IcuCollationStrength?

VariableTop

Single character or contraction. Controls what is variable for Alternate.

Declaration

[DataMember(Name = "variableTop")]
string VariableTop { get; set; }

Property Value

Type	Description
string

Variant

Declaration

[DataMember(Name = "variant")]
string Variant { get; set; }

Property Value

Type	Description
string

Extension Methods

SuffixExtensions.Suffix(object, string)