Package org.apache.lucene.analysis.util

Class TokenFilterFactory

java.lang.Object
org.apache.lucene.analysis.util.AbstractAnalysisFactory
org.apache.lucene.analysis.util.TokenFilterFactory
Direct Known Subclasses:
ArabicNormalizationFilterFactory, ArabicStemFilterFactory, ASCIIFoldingFilterFactory, BrazilianStemFilterFactory, BulgarianStemFilterFactory, CapitalizationFilterFactory, ChineseFilterFactory, CJKBigramFilterFactory, CJKWidthFilterFactory, ClassicFilterFactory, CodepointCountFilterFactory, CollationKeyFilterFactory, CommonGramsFilterFactory, CzechStemFilterFactory, DelimitedPayloadTokenFilterFactory, DictionaryCompoundWordTokenFilterFactory, EdgeNGramFilterFactory, ElisionFilterFactory, EnglishMinimalStemFilterFactory, EnglishPossessiveFilterFactory, FinnishLightStemFilterFactory, FrenchLightStemFilterFactory, FrenchMinimalStemFilterFactory, GalicianMinimalStemFilterFactory, GalicianStemFilterFactory, GermanLightStemFilterFactory, GermanMinimalStemFilterFactory, GermanNormalizationFilterFactory, GermanStemFilterFactory, GreekLowerCaseFilterFactory, GreekStemFilterFactory, HindiNormalizationFilterFactory, HindiStemFilterFactory, HungarianLightStemFilterFactory, HunspellStemFilterFactory, HyphenatedWordsFilterFactory, HyphenationCompoundWordTokenFilterFactory, IndicNormalizationFilterFactory, IndonesianStemFilterFactory, IrishLowerCaseFilterFactory, ItalianLightStemFilterFactory, KeepWordFilterFactory, KeywordMarkerFilterFactory, KeywordRepeatFilterFactory, KStemFilterFactory, LatvianStemFilterFactory, LengthFilterFactory, LimitTokenCountFilterFactory, LimitTokenPositionFilterFactory, LowerCaseFilterFactory, NGramFilterFactory, NorwegianLightStemFilterFactory, NorwegianMinimalStemFilterFactory, NumericPayloadTokenFilterFactory, PatternCaptureGroupFilterFactory, PatternReplaceFilterFactory, PersianNormalizationFilterFactory, PorterStemFilterFactory, PortugueseLightStemFilterFactory, PortugueseMinimalStemFilterFactory, PortugueseStemFilterFactory, PositionFilterFactory, RemoveDuplicatesTokenFilterFactory, ReverseStringFilterFactory, RussianLightStemFilterFactory, ScandinavianFoldingFilterFactory, ScandinavianNormalizationFilterFactory, ShingleFilterFactory, SnowballPorterFilterFactory, SoraniNormalizationFilterFactory, SoraniStemFilterFactory, SpanishLightStemFilterFactory, StandardFilterFactory, StemmerOverrideFilterFactory, StopFilterFactory, SwedishLightStemFilterFactory, SynonymFilterFactory, ThaiWordFilterFactory, TokenOffsetPayloadTokenFilterFactory, TrimFilterFactory, TurkishLowerCaseFilterFactory, TypeAsPayloadTokenFilterFactory, TypeTokenFilterFactory, UpperCaseFilterFactory, WordDelimiterFilterFactory
public abstract class TokenFilterFactory extends AbstractAnalysisFactory
Abstract parent class for analysis factories that create TokenFilter instances.

  • Method Details

    • forName

      public static TokenFilterFactory forName(String name, Map<String,String> args)
      looks up a tokenfilter by name from context classpath

    • lookupClass

      public static Class<? extends TokenFilterFactory> lookupClass(String name)
      looks up a tokenfilter class by name from context classpath

    • availableTokenFilters

      public static Set<String> availableTokenFilters()
      returns a list of all available tokenfilter names from context classpath

    • reloadTokenFilters

      public static void reloadTokenFilters(ClassLoader classloader)
      Reloads the factory list from the given ClassLoader. 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!

    • create

      public abstract TokenStream create(TokenStream input)
      Transform the specified input TokenStream