Class ICUCollationKeyFilterFactory

Factory for ICUCollationKeyFilter.

Inheritance
object
AbstractAnalysisFactory
TokenFilterFactory
ICUCollationKeyFilterFactory
Implements
IMultiTermAwareComponent
IResourceLoaderAware
Inherited Members
TokenFilterFactory.AvailableTokenFilters
TokenFilterFactory.ReloadTokenFilters()
AbstractAnalysisFactory.LUCENE_MATCH_VERSION_PARAM
AbstractAnalysisFactory.m_luceneMatchVersion
AbstractAnalysisFactory.OriginalArgs
AbstractAnalysisFactory.AssureMatchVersion()
AbstractAnalysisFactory.LuceneMatchVersion
AbstractAnalysisFactory.GetClassArg()
AbstractAnalysisFactory.IsExplicitLuceneMatchVersion
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

ICUCollationKeyFilterFactory(IDictionary<string, string>)

Factory for ICUCollationKeyFilter.

Declaration
public ICUCollationKeyFilterFactory(IDictionary<string, string> args)
Parameters
Type Name Description
IDictionary<string, string> args
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
See Also
Collator
RuleBasedCollator

Methods

Create(TokenStream)

Transform the specified input Lucene.Net.Analysis.TokenStream

Declaration
public override TokenStream Create(TokenStream input)
Parameters
Type Name Description
TokenStream input
Returns
Type Description
TokenStream
Overrides
Lucene.Net.Analysis.Util.TokenFilterFactory.Create(Lucene.Net.Analysis.TokenStream)
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
See Also
Collator
RuleBasedCollator

GetMultiTermComponent()

Returns an analysis component to handle analysis if multi-term queries. The returned component must be a Lucene.Net.Analysis.Util.TokenizerFactory, Lucene.Net.Analysis.Util.TokenFilterFactory or Lucene.Net.Analysis.Util.CharFilterFactory.

Declaration
public virtual AbstractAnalysisFactory GetMultiTermComponent()
Returns
Type Description
AbstractAnalysisFactory
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
See Also
Collator
RuleBasedCollator

Inform(IResourceLoader)

Initializes this component with the provided Lucene.Net.Analysis.Util.IResourceLoader (used for loading types, embedded resources, files, etc).

Declaration
public virtual void Inform(IResourceLoader loader)
Parameters
Type Name Description
IResourceLoader loader
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
See Also
Collator
RuleBasedCollator

Implements

Lucene.Net.Analysis.Util.IMultiTermAwareComponent
Lucene.Net.Analysis.Util.IResourceLoaderAware

See Also

Collator
RuleBasedCollator