Class IcuCollationTokenFilter

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:

Inheritance
object
TokenFilterBase
IcuCollationTokenFilter
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class IcuCollationTokenFilter : TokenFilterBase, IIcuCollationTokenFilter, ITokenFilter
Remarks

Requires analysis-icu plugin to be installed

Constructors

| Edit this page View Source

IcuCollationTokenFilter()

Declaration
public IcuCollationTokenFilter()

Properties

| Edit this page View Source

Alternate

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

Declaration
public IcuCollationAlternate? Alternate { get; set; }
Property Value
Type Description
IcuCollationAlternate?
| Edit this page View Source

CaseFirst

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

Declaration
public IcuCollationCaseFirst? CaseFirst { get; set; }
Property Value
Type Description
IcuCollationCaseFirst?
| Edit this page View Source

CaseLevel

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

Declaration
public bool? CaseLevel { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Country

Declaration
public string Country { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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
public IcuCollationDecomposition? Decomposition { get; set; }
Property Value
Type Description
IcuCollationDecomposition?
| Edit this page View Source

HiraganaQuaternaryMode

Distinguishing between Katakana and Hiragana characters in quaternary strength.

Declaration
public bool? HiraganaQuaternaryMode { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Language

Declaration
public string Language { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Numeric

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

Declaration
public bool? Numeric { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Strength

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

Declaration
public IcuCollationStrength? Strength { get; set; }
Property Value
Type Description
IcuCollationStrength?
| Edit this page View Source

VariableTop

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

Declaration
public string VariableTop { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Variant

Declaration
public string Variant { get; set; }
Property Value
Type Description
string

Implements

Extension Methods