Package org.apache.lucene.analysis
Class CharFilterFactory
- java.lang.Object
-
- org.apache.lucene.analysis.AbstractAnalysisFactory
-
- org.apache.lucene.analysis.CharFilterFactory
-
- Direct Known Subclasses:
CJKWidthCharFilterFactory
,HTMLStripCharFilterFactory
,ICUNormalizer2CharFilterFactory
,JapaneseIterationMarkCharFilterFactory
,MappingCharFilterFactory
,PatternReplaceCharFilterFactory
,PersianCharFilterFactory
public abstract class CharFilterFactory extends AbstractAnalysisFactory
Abstract parent class for analysis factories that createCharFilter
instances.- Since:
- 3.1
-
-
Field Summary
Fields Modifier and Type Field Description private static AnalysisSPILoader<CharFilterFactory>
loader
-
Fields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CharFilterFactory()
Default ctor for compatibility with SPIprotected
CharFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)
Initialize this factory via a set of key-value pairs.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static java.util.Set<java.lang.String>
availableCharFilters()
returns a list of all available charfilter namesabstract java.io.Reader
create(java.io.Reader input)
Wraps the given Reader with a CharFilter.static java.lang.String
findSPIName(java.lang.Class<? extends CharFilterFactory> serviceClass)
looks up a SPI name for the specified char filter factorystatic CharFilterFactory
forName(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> args)
looks up a charfilter by name from context classpathstatic java.lang.Class<? extends CharFilterFactory>
lookupClass(java.lang.String name)
looks up a charfilter class by name from context classpathjava.io.Reader
normalize(java.io.Reader input)
Normalize the specified input Reader While the default implementation returns input unchanged, char filters that should be applied at normalization time can delegate tocreate
method.static void
reloadCharFilters(java.lang.ClassLoader classloader)
Reloads the factory list from the givenClassLoader
.-
Methods inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
defaultCtorException, get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames
-
-
-
-
Field Detail
-
loader
private static final AnalysisSPILoader<CharFilterFactory> loader
-
-
Method Detail
-
forName
public static CharFilterFactory forName(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> args)
looks up a charfilter by name from context classpath
-
lookupClass
public static java.lang.Class<? extends CharFilterFactory> lookupClass(java.lang.String name)
looks up a charfilter class by name from context classpath
-
availableCharFilters
public static java.util.Set<java.lang.String> availableCharFilters()
returns a list of all available charfilter names
-
findSPIName
public static java.lang.String findSPIName(java.lang.Class<? extends CharFilterFactory> serviceClass)
looks up a SPI name for the specified char filter factory
-
reloadCharFilters
public static void reloadCharFilters(java.lang.ClassLoader classloader)
Reloads the factory list from the givenClassLoader
. Changes to the factories are visible after the method ends, all iterators (availableCharFilters()
,...) 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 java.io.Reader create(java.io.Reader input)
Wraps the given Reader with a CharFilter.
-
normalize
public java.io.Reader normalize(java.io.Reader input)
Normalize the specified input Reader While the default implementation returns input unchanged, char filters that should be applied at normalization time can delegate tocreate
method.
-
-