Package org.apache.lucene.analysis.util
Class AbstractAnalysisFactory
- java.lang.Object
-
- org.apache.lucene.analysis.util.AbstractAnalysisFactory
-
- Direct Known Subclasses:
CharFilterFactory
,TokenFilterFactory
,TokenizerFactory
public abstract class AbstractAnalysisFactory extends Object
Abstract parent class for analysis factoriesTokenizerFactory
,TokenFilterFactory
andCharFilterFactory
.The typical lifecycle for a factory consumer is:
- Create factory via its constructor (or via XXXFactory.forName)
- (Optional) If the factory uses resources such as files,
ResourceLoaderAware.inform(ResourceLoader)
is called to initialize those resources. - Consumer calls create() to obtain instances.
-
-
Field Summary
Fields Modifier and Type Field Description static String
LUCENE_MATCH_VERSION_PARAM
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
get(Map<String,String> args, String name)
String
get(Map<String,String> args, String name, String defaultVal)
String
get(Map<String,String> args, String name, Collection<String> allowedValues)
String
get(Map<String,String> args, String name, Collection<String> allowedValues, String defaultVal)
String
get(Map<String,String> args, String name, Collection<String> allowedValues, String defaultVal, boolean caseSensitive)
char
getChar(Map<String,String> args, String name, char defaultValue)
String
getClassArg()
Version
getLuceneMatchVersion()
Map<String,String>
getOriginalArgs()
Set<String>
getSet(Map<String,String> args, String name)
Returns whitespace- and/or comma-separated set of values, or null if none are foundboolean
isExplicitLuceneMatchVersion()
String
require(Map<String,String> args, String name)
String
require(Map<String,String> args, String name, Collection<String> allowedValues)
String
require(Map<String,String> args, String name, Collection<String> allowedValues, boolean caseSensitive)
char
requireChar(Map<String,String> args, String name)
void
setExplicitLuceneMatchVersion(boolean isExplicitLuceneMatchVersion)
-
-
-
Field Detail
-
LUCENE_MATCH_VERSION_PARAM
public static final String LUCENE_MATCH_VERSION_PARAM
- See Also:
- Constant Field Values
-
-
Method Detail
-
getLuceneMatchVersion
public final Version getLuceneMatchVersion()
-
require
public String require(Map<String,String> args, String name, Collection<String> allowedValues)
-
require
public String require(Map<String,String> args, String name, Collection<String> allowedValues, boolean caseSensitive)
-
get
public String get(Map<String,String> args, String name, Collection<String> allowedValues, String defaultVal)
-
get
public String get(Map<String,String> args, String name, Collection<String> allowedValues, String defaultVal, boolean caseSensitive)
-
getSet
public Set<String> getSet(Map<String,String> args, String name)
Returns whitespace- and/or comma-separated set of values, or null if none are found
-
getClassArg
public String getClassArg()
- Returns:
- the string used to specify the concrete class name in a serialized representation: the class arg.
If the concrete class name was not specified via a class arg, returns
getClass().getName()
.
-
isExplicitLuceneMatchVersion
public boolean isExplicitLuceneMatchVersion()
-
setExplicitLuceneMatchVersion
public void setExplicitLuceneMatchVersion(boolean isExplicitLuceneMatchVersion)
-
-