Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ICUCollationKeyFilterFactory

    Factory for ICUCollationKeyFilter.

    Inheritance
    System.Object
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory
    Lucene.Net.Analysis.Util.TokenFilterFactory
    ICUCollationKeyFilterFactory
    Implements
    Lucene.Net.Analysis.Util.IMultiTermAwareComponent
    Lucene.Net.Analysis.Util.IResourceLoaderAware
    Inherited Members
    Lucene.Net.Analysis.Util.TokenFilterFactory.ForName(System.String, System.Collections.Generic.IDictionary<System.String, System.String>)
    Lucene.Net.Analysis.Util.TokenFilterFactory.LookupClass(System.String)
    Lucene.Net.Analysis.Util.TokenFilterFactory.AvailableTokenFilters
    Lucene.Net.Analysis.Util.TokenFilterFactory.ReloadTokenFilters()
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.LUCENE_MATCH_VERSION_PARAM
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.m_luceneMatchVersion
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.OriginalArgs
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.AssureMatchVersion()
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.LuceneMatchVersion
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Require(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Require(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Require(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>, System.Boolean)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>, System.String, System.Boolean)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireInt32(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetInt32(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Int32)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireBoolean(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetBoolean(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Boolean)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireSingle(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetSingle(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Single)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireChar(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetChar(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Char)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetSet(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetPattern(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetCulture(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Globalization.CultureInfo)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetWordSet(Lucene.Net.Analysis.Util.IResourceLoader, System.String, System.Boolean)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetLines(Lucene.Net.Analysis.Util.IResourceLoader, System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetSnowballWordSet(Lucene.Net.Analysis.Util.IResourceLoader, System.String, System.Boolean)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.SplitFileNames(System.String)
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetClassArg()
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory.IsExplicitLuceneMatchVersion
    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
    Lucene.Net.Analysis.TokenStream input
    Returns
    Type Description
    Lucene.Net.Analysis.TokenStream
    Overrides
    Lucene.Net.Analysis.Util.TokenFilterFactory.Create(Lucene.Net.Analysis.TokenStream)
    | Improve this Doc View Source

    GetMultiTermComponent()

    Declaration
    public virtual AbstractAnalysisFactory GetMultiTermComponent()
    Returns
    Type Description
    Lucene.Net.Analysis.Util.AbstractAnalysisFactory
    | Improve this Doc View Source

    Inform(IResourceLoader)

    Declaration
    public virtual void Inform(IResourceLoader loader)
    Parameters
    Type Name Description
    Lucene.Net.Analysis.Util.IResourceLoader loader

    Implements

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

    See Also

    ICU4N.Text.Collator
    ICU4N.Text.RuleBasedCollator
    • Improve this Doc
    • View Source
    Back to top Copyright © 2021 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.