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 createTokenFilter
instances.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
LUCENE_MATCH_VERSION_PARAM
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static java.util.Set<java.lang.String>
availableTokenFilters()
returns a list of all available tokenfilter names from context classpathabstract TokenStream
create(TokenStream input)
Transform the specified input TokenStreamstatic TokenFilterFactory
forName(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> args)
looks up a tokenfilter by name from context classpathstatic java.lang.Class<? extends TokenFilterFactory>
lookupClass(java.lang.String name)
looks up a tokenfilter class by name from context classpathstatic void
reloadTokenFilters(java.lang.ClassLoader classloader)
Reloads the factory list from the givenClassLoader
.-
Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
get, get, get, get, get, getChar, getClassArg, getLuceneMatchVersion, getOriginalArgs, getSet, isExplicitLuceneMatchVersion, require, require, require, requireChar, setExplicitLuceneMatchVersion
-
-
-
-
Method Detail
-
forName
public static TokenFilterFactory forName(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> args)
looks up a tokenfilter by name from context classpath
-
lookupClass
public static java.lang.Class<? extends TokenFilterFactory> lookupClass(java.lang.String name)
looks up a tokenfilter class by name from context classpath
-
availableTokenFilters
public static java.util.Set<java.lang.String> availableTokenFilters()
returns a list of all available tokenfilter names from context classpath
-
reloadTokenFilters
public static void reloadTokenFilters(java.lang.ClassLoader classloader)
Reloads the factory list from the givenClassLoader
. 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
-
-