Package org.apache.lucene.analysis.en
Class AbstractWordsFileFilterFactory
java.lang.Object
org.apache.lucene.analysis.AbstractAnalysisFactory
org.apache.lucene.analysis.TokenFilterFactory
org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory
- All Implemented Interfaces:
ResourceLoaderAware
- Direct Known Subclasses:
CommonGramsFilterFactory
,KeepWordFilterFactory
,StopFilterFactory
public abstract class AbstractWordsFileFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware
Abstract parent class for analysis factories that accept a stopwords file as input.
Concrete implementations can leverage the following input attributes. All attributes are optional:
ignoreCase
defaults tofalse
words
should be the name of a stopwords file to parse, if not specified the factory will use the value provided bycreateDefaultWords()
implementation in concrete subclass.format
defines how thewords
file will be parsed, and defaults towordset
. Ifwords
is not specified, thenformat
must not be specified.
The valid values for the format
option are:
wordset
- This is the default format, which supports one word per line (including any intra-word whitespace) and allows whole line comments beginning with the "#" character. Blank lines are ignored. SeeWordlistLoader.getLines
for details.snowball
- This format allows for multiple words specified on each line, and trailing comments may be specified using the vertical line ("|"). Blank lines are ignored. SeeWordlistLoader.getSnowballWordSet
for details.
-
Field Summary
Fields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default ctor for compatibility with SPIInitialize this factory via a set of key-value pairs. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract CharArraySet
Default word set implementation.getWords()
void
inform
(ResourceLoader loader) Initialize the set of stopwords provided via ResourceLoader, or using defaults.boolean
Methods inherited from class org.apache.lucene.analysis.TokenFilterFactory
availableTokenFilters, create, findSPIName, forName, lookupClass, normalize, reloadTokenFilters
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 Details
-
FORMAT_WORDSET
- See Also:
-
FORMAT_SNOWBALL
- See Also:
-
-
Constructor Details
-
AbstractWordsFileFilterFactory
protected AbstractWordsFileFilterFactory()Default ctor for compatibility with SPI -
AbstractWordsFileFilterFactory
Initialize this factory via a set of key-value pairs.
-
-
Method Details
-
inform
Initialize the set of stopwords provided via ResourceLoader, or using defaults.- Specified by:
inform
in interfaceResourceLoaderAware
- Throws:
IOException
-
createDefaultWords
Default word set implementation. -
getWords
-
getWordFiles
-
getFormat
-
isIgnoreCase
public boolean isIgnoreCase()
-