Class ICUCollationKeyFilterFactory

Factory for ICUCollationKeyFilter.

Inheritance
System.Object
AbstractAnalysisFactory
TokenFilterFactory
ICUCollationKeyFilterFactory
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Collation
Assembly: Lucene.Net.ICU.dll
Syntax
[Obsolete("Use ICUCollationKeyAnalyzer instead.")]
public class ICUCollationKeyFilterFactory : TokenFilterFactory, IMultiTermAwareComponent, IResourceLoaderAware
Remarks

This factory can be created in two ways:

  • Based upon a system collator associated with a Locale.
  • Based upon a tailored ruleset.

Using a System collator:

  • locale: RFC 3066 locale ID (mandatory)
  • strength: 'primary','secondary','tertiary', 'quaternary', or 'identical' (optional)
  • decomposition: 'no', or 'canonical' (optional)

Using a Tailored ruleset:

  • custom: UTF-8 text file containing rules supported by RuleBasedCollator (mandatory)
  • strength: 'primary','secondary','tertiary', 'quaternary', or 'identical' (optional)
  • decomposition: 'no' or 'canonical' (optional)

Expert options:

  • alternate: 'shifted' or 'non-ignorable'. Can be used to ignore punctuation/whitespace.
  • caseLevel: 'true' or 'false'. Useful with strength=primary to ignore accents but not case.
  • caseFirst: 'lower' or 'upper'. Useful to control which is sorted first when case is not ignored.
  • numeric: 'true' or 'false'. Digits are sorted according to numeric value, e.g. foobar-9 sorts before foobar-10

Constructors

| Improve this Doc View Source

ICUCollationKeyFilterFactory(IDictionary<String, String>)

Declaration
public ICUCollationKeyFilterFactory(IDictionary<string, string> args)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> args

Methods

| Improve this Doc View Source

Create(TokenStream)

Declaration
public override TokenStream Create(TokenStream input)
Parameters
Type Name Description
TokenStream input
Returns
Type Description
TokenStream
Overrides
| Improve this Doc View Source

GetMultiTermComponent()

Declaration
public virtual AbstractAnalysisFactory GetMultiTermComponent()
Returns
Type Description
AbstractAnalysisFactory
| Improve this Doc View Source

Inform(IResourceLoader)

Declaration
public virtual void Inform(IResourceLoader loader)
Parameters
Type Name Description
IResourceLoader loader

Implements

See Also

ICU4N.Text.Collator
ICU4N.Text.RuleBasedCollator