Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class TokenFilterFactory

    Abstract parent class for analysis factories that create Lucene.Net.Analysis.TokenFilter instances.

    Inheritance
    System.Object
    AbstractAnalysisFactory
    TokenFilterFactory
    ArabicNormalizationFilterFactory
    ArabicStemFilterFactory
    BulgarianStemFilterFactory
    BrazilianStemFilterFactory
    CJKBigramFilterFactory
    CJKWidthFilterFactory
    SoraniNormalizationFilterFactory
    SoraniStemFilterFactory
    ChineseFilterFactory
    CommonGramsFilterFactory
    DictionaryCompoundWordTokenFilterFactory
    HyphenationCompoundWordTokenFilterFactory
    LowerCaseFilterFactory
    StopFilterFactory
    TypeTokenFilterFactory
    UpperCaseFilterFactory
    CzechStemFilterFactory
    GermanLightStemFilterFactory
    GermanMinimalStemFilterFactory
    GermanNormalizationFilterFactory
    GermanStemFilterFactory
    GreekLowerCaseFilterFactory
    GreekStemFilterFactory
    EnglishMinimalStemFilterFactory
    EnglishPossessiveFilterFactory
    KStemFilterFactory
    PorterStemFilterFactory
    SpanishLightStemFilterFactory
    PersianNormalizationFilterFactory
    FinnishLightStemFilterFactory
    FrenchLightStemFilterFactory
    FrenchMinimalStemFilterFactory
    IrishLowerCaseFilterFactory
    GalicianMinimalStemFilterFactory
    GalicianStemFilterFactory
    HindiNormalizationFilterFactory
    HindiStemFilterFactory
    HungarianLightStemFilterFactory
    HunspellStemFilterFactory
    IndonesianStemFilterFactory
    IndicNormalizationFilterFactory
    ItalianLightStemFilterFactory
    LatvianStemFilterFactory
    ASCIIFoldingFilterFactory
    CapitalizationFilterFactory
    CodepointCountFilterFactory
    HyphenatedWordsFilterFactory
    KeepWordFilterFactory
    KeywordMarkerFilterFactory
    KeywordRepeatFilterFactory
    LengthFilterFactory
    LimitTokenCountFilterFactory
    LimitTokenPositionFilterFactory
    RemoveDuplicatesTokenFilterFactory
    ScandinavianFoldingFilterFactory
    ScandinavianNormalizationFilterFactory
    StemmerOverrideFilterFactory
    TrimFilterFactory
    TruncateTokenFilterFactory
    WordDelimiterFilterFactory
    EdgeNGramFilterFactory
    NGramFilterFactory
    NorwegianLightStemFilterFactory
    NorwegianMinimalStemFilterFactory
    PatternCaptureGroupFilterFactory
    PatternReplaceFilterFactory
    DelimitedPayloadTokenFilterFactory
    NumericPayloadTokenFilterFactory
    TokenOffsetPayloadTokenFilterFactory
    TypeAsPayloadTokenFilterFactory
    PositionFilterFactory
    PortugueseLightStemFilterFactory
    PortugueseMinimalStemFilterFactory
    PortugueseStemFilterFactory
    ReverseStringFilterFactory
    RussianLightStemFilterFactory
    ShingleFilterFactory
    SnowballPorterFilterFactory
    ClassicFilterFactory
    StandardFilterFactory
    SwedishLightStemFilterFactory
    SynonymFilterFactory
    ApostropheFilterFactory
    TurkishLowerCaseFilterFactory
    ElisionFilterFactory
    Inherited Members
    AbstractAnalysisFactory.LUCENE_MATCH_VERSION_PARAM
    AbstractAnalysisFactory.m_luceneMatchVersion
    AbstractAnalysisFactory.OriginalArgs
    AbstractAnalysisFactory.AssureMatchVersion()
    AbstractAnalysisFactory.LuceneMatchVersion
    AbstractAnalysisFactory.Require(IDictionary<String, String>, String)
    AbstractAnalysisFactory.Require(IDictionary<String, String>, String, ICollection<String>)
    AbstractAnalysisFactory.Require(IDictionary<String, String>, String, ICollection<String>, Boolean)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, String)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, ICollection<String>)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, ICollection<String>, String)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, ICollection<String>, String, Boolean)
    AbstractAnalysisFactory.RequireInt32(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetInt32(IDictionary<String, String>, String, Int32)
    AbstractAnalysisFactory.RequireBoolean(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetBoolean(IDictionary<String, String>, String, Boolean)
    AbstractAnalysisFactory.RequireSingle(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetSingle(IDictionary<String, String>, String, Single)
    AbstractAnalysisFactory.RequireChar(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetChar(IDictionary<String, String>, String, Char)
    AbstractAnalysisFactory.GetSet(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetPattern(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetCulture(IDictionary<String, String>, String, CultureInfo)
    AbstractAnalysisFactory.GetWordSet(IResourceLoader, String, Boolean)
    AbstractAnalysisFactory.GetLines(IResourceLoader, String)
    AbstractAnalysisFactory.GetSnowballWordSet(IResourceLoader, String, Boolean)
    AbstractAnalysisFactory.SplitFileNames(String)
    AbstractAnalysisFactory.GetClassArg()
    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.Analysis.Util
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    public abstract class TokenFilterFactory : AbstractAnalysisFactory

    Constructors

    | Improve this Doc View Source

    TokenFilterFactory(IDictionary<String, String>)

    Initialize this factory via a set of key-value pairs.

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

    Properties

    | Improve this Doc View Source

    AvailableTokenFilters

    returns a list of all available tokenfilter names from the host project's referenced assemblies

    Declaration
    public static ICollection<string> AvailableTokenFilters { get; }
    Property Value
    Type Description
    System.Collections.Generic.ICollection<System.String>

    Methods

    | Improve this Doc View Source

    Create(TokenStream)

    Transform the specified input Lucene.Net.Analysis.TokenStream

    Declaration
    public abstract TokenStream Create(TokenStream input)
    Parameters
    Type Name Description
    Lucene.Net.Analysis.TokenStream input
    Returns
    Type Description
    Lucene.Net.Analysis.TokenStream
    | Improve this Doc View Source

    ForName(String, IDictionary<String, String>)

    looks up a tokenfilter by name from the host project's referenced assemblies

    Declaration
    public static TokenFilterFactory ForName(string name, IDictionary<string, string> args)
    Parameters
    Type Name Description
    System.String name
    System.Collections.Generic.IDictionary<System.String, System.String> args
    Returns
    Type Description
    TokenFilterFactory
    | Improve this Doc View Source

    LookupClass(String)

    looks up a tokenfilter class by name from the host project's referenced assemblies

    Declaration
    public static Type LookupClass(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    System.Type
    | Improve this Doc View Source

    ReloadTokenFilters()

    Reloads the factory list. Changes to the factories are visible after the method ends, all iterators (AvailableTokenFilters,...) stay consistent.

    NOTE: Only new factories are added, existing ones are never removed or replaced.

    This method is expensive and should only be called for discovery of new factories on the given classpath/classloader!

    Declaration
    public static void ReloadTokenFilters()
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 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.