Class IcuCollationTokenFilterDescriptor

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
DescriptorBase<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter>
TokenFilterDescriptorBase<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter>
IcuCollationTokenFilterDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class IcuCollationTokenFilterDescriptor : TokenFilterDescriptorBase<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter>, IDescriptor, IIcuCollationTokenFilter, ITokenFilter
Remarks

Requires analysis-icu plugin to be installed

Properties

| Edit this page View Source

Type

Declaration
protected override string Type { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

Alternate(IcuCollationAlternate?)

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

Declaration
public IcuCollationTokenFilterDescriptor Alternate(IcuCollationAlternate? alternate)
Parameters
Type Name Description
IcuCollationAlternate? alternate
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

CaseFirst(IcuCollationCaseFirst?)

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

Declaration
public IcuCollationTokenFilterDescriptor CaseFirst(IcuCollationCaseFirst? caseFirst)
Parameters
Type Name Description
IcuCollationCaseFirst? caseFirst
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

CaseLevel(bool?)

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

Declaration
public IcuCollationTokenFilterDescriptor CaseLevel(bool? caseLevel = true)
Parameters
Type Name Description
bool? caseLevel
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

Country(string)

Declaration
public IcuCollationTokenFilterDescriptor Country(string country)
Parameters
Type Name Description
string country
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

Decomposition(IcuCollationDecomposition?)

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 IcuCollationTokenFilterDescriptor Decomposition(IcuCollationDecomposition? decomposition)
Parameters
Type Name Description
IcuCollationDecomposition? decomposition
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

HiraganaQuaternaryMode(bool?)

Distinguishing between Katakana and Hiragana characters in quaternary strength.

Declaration
public IcuCollationTokenFilterDescriptor HiraganaQuaternaryMode(bool? mode = true)
Parameters
Type Name Description
bool? mode
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

Language(string)

Declaration
public IcuCollationTokenFilterDescriptor Language(string language)
Parameters
Type Name Description
string language
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

Numeric(bool?)

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

Declaration
public IcuCollationTokenFilterDescriptor Numeric(bool? numeric = true)
Parameters
Type Name Description
bool? numeric
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

Strength(IcuCollationStrength?)

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

Declaration
public IcuCollationTokenFilterDescriptor Strength(IcuCollationStrength? strength)
Parameters
Type Name Description
IcuCollationStrength? strength
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

VariableTop(string)

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

Declaration
public IcuCollationTokenFilterDescriptor VariableTop(string variableTop)
Parameters
Type Name Description
string variableTop
Returns
Type Description
IcuCollationTokenFilterDescriptor
| Edit this page View Source

Variant(string)

Declaration
public IcuCollationTokenFilterDescriptor Variant(string variant)
Parameters
Type Name Description
string variant
Returns
Type Description
IcuCollationTokenFilterDescriptor

Implements

Extension Methods