Class TokenFilterFactory

java.lang.Object
org.apache.lucene.analysis.AbstractAnalysisFactory
org.apache.lucene.analysis.TokenFilterFactory
Direct Known Subclasses:
AbstractWordsFileFilterFactory, ApostropheFilterFactory, ArabicNormalizationFilterFactory, ArabicStemFilterFactory, ASCIIFoldingFilterFactory, BeiderMorseFilterFactory, BengaliNormalizationFilterFactory, BengaliStemFilterFactory, BrazilianStemFilterFactory, BulgarianStemFilterFactory, CapitalizationFilterFactory, CJKBigramFilterFactory, CJKWidthFilterFactory, ClassicFilterFactory, CodepointCountFilterFactory, ConcatenateGraphFilterFactory, ConditionalTokenFilterFactory, CzechStemFilterFactory, DaitchMokotoffSoundexFilterFactory, DateRecognizerFilterFactory, DecimalDigitFilterFactory, DelimitedBoostTokenFilterFactory, DelimitedPayloadTokenFilterFactory, DelimitedTermFrequencyTokenFilterFactory, DictionaryCompoundWordTokenFilterFactory, DoubleMetaphoneFilterFactory, DropIfFlaggedFilterFactory, EdgeNGramFilterFactory, ElisionFilterFactory, EnglishMinimalStemFilterFactory, EnglishPossessiveFilterFactory, FingerprintFilterFactory, FinnishLightStemFilterFactory, FixBrokenOffsetsFilterFactory, FixedShingleFilterFactory, FlattenGraphFilterFactory, FrenchLightStemFilterFactory, FrenchMinimalStemFilterFactory, GalicianMinimalStemFilterFactory, GalicianStemFilterFactory, GermanLightStemFilterFactory, GermanMinimalStemFilterFactory, GermanNormalizationFilterFactory, GermanStemFilterFactory, GreekLowerCaseFilterFactory, GreekStemFilterFactory, HindiNormalizationFilterFactory, HindiStemFilterFactory, HungarianLightStemFilterFactory, HunspellStemFilterFactory, HyphenatedWordsFilterFactory, HyphenationCompoundWordTokenFilterFactory, ICUFoldingFilterFactory, ICUNormalizer2FilterFactory, ICUTransformFilterFactory, IndicNormalizationFilterFactory, IndonesianStemFilterFactory, IrishLowerCaseFilterFactory, ItalianLightStemFilterFactory, JapaneseBaseFormFilterFactory, JapaneseCompletionFilterFactory, JapaneseKatakanaStemFilterFactory, JapaneseNumberFilterFactory, JapanesePartOfSpeechStopFilterFactory, JapaneseReadingFormFilterFactory, KeywordMarkerFilterFactory, KeywordRepeatFilterFactory, KoreanNumberFilterFactory, KoreanPartOfSpeechStopFilterFactory, KoreanReadingFormFilterFactory, KStemFilterFactory, LatvianStemFilterFactory, LengthFilterFactory, LimitTokenCountFilterFactory, LimitTokenOffsetFilterFactory, LimitTokenPositionFilterFactory, LowerCaseFilterFactory, MinHashFilterFactory, NGramFilterFactory, NorwegianLightStemFilterFactory, NorwegianMinimalStemFilterFactory, NorwegianNormalizationFilterFactory, NumericPayloadTokenFilterFactory, PatternCaptureGroupFilterFactory, PatternReplaceFilterFactory, PatternTypingFilterFactory, PersianNormalizationFilterFactory, PersianStemFilterFactory, PhoneticFilterFactory, PorterStemFilterFactory, PortugueseLightStemFilterFactory, PortugueseMinimalStemFilterFactory, PortugueseStemFilterFactory, RemoveDuplicatesTokenFilterFactory, ReverseStringFilterFactory, RussianLightStemFilterFactory, ScandinavianFoldingFilterFactory, ScandinavianNormalizationFilterFactory, SerbianNormalizationFilterFactory, ShingleFilterFactory, SnowballPorterFilterFactory, SoraniNormalizationFilterFactory, SoraniStemFilterFactory, SpanishLightStemFilterFactory, SpanishMinimalStemFilterFactory, SpanishPluralStemFilterFactory, StemmerOverrideFilterFactory, StempelPolishStemFilterFactory, SuggestStopFilterFactory, SwedishLightStemFilterFactory, SwedishMinimalStemFilterFactory, SynonymFilterFactory, SynonymGraphFilterFactory, TeluguNormalizationFilterFactory, TeluguStemFilterFactory, TokenOffsetPayloadTokenFilterFactory, TrimFilterFactory, TruncateTokenFilterFactory, TurkishLowerCaseFilterFactory, TypeAsPayloadTokenFilterFactory, TypeAsSynonymFilterFactory, TypeTokenFilterFactory, UpperCaseFilterFactory, WordDelimiterFilterFactory, WordDelimiterGraphFilterFactory

public abstract class TokenFilterFactory extends AbstractAnalysisFactory
Abstract parent class for analysis factories that create TokenFilter instances.
Since:
3.1
  • Constructor Details

    • TokenFilterFactory

      protected TokenFilterFactory()
      Default ctor for compatibility with SPI
    • TokenFilterFactory

      protected TokenFilterFactory(Map<String,String> args)
      Initialize this factory via a set of key-value pairs.
  • 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
    • findSPIName

      public static String findSPIName(Class<? extends TokenFilterFactory> serviceClass)
      looks up a SPI name for the specified token filter factory
    • 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
    • normalize

      public TokenStream normalize(TokenStream input)
      Normalize the specified input TokenStream While the default implementation returns input unchanged, filters that should be applied at normalization time can delegate to create method.