Package org.apache.lucene.analysis.util

Class CharFilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.CharFilterFactory

Direct Known Subclasses:

HTMLStripCharFilterFactory, MappingCharFilterFactory, PatternReplaceCharFilterFactory, PersianCharFilterFactory

public abstract class CharFilterFactory
extends AbstractAnalysisFactory

Abstract parent class for analysis factories that create CharFilter instances.

Field Summary

Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

LUCENE_MATCH_VERSION_PARAM

Method Summary

Modifier and Type	Method	Description
static java.util.Set<java.lang.String>	availableCharFilters()	returns a list of all available charfilter names
abstract java.io.Reader	create(java.io.Reader input)	Wraps the given Reader with a CharFilter.
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
static java.lang.Class<? extends CharFilterFactory>	lookupClass(java.lang.String name)	looks up a charfilter class by name from context classpath
static void	reloadCharFilters(java.lang.ClassLoader classloader)	Reloads the factory list from the given ClassLoader.

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

reloadCharFilters

public static void reloadCharFilters(java.lang.ClassLoader classloader)

Reloads the factory list from the given ClassLoader. 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.