Package org.apache.lucene.analysis.fr
Class FrenchAnalyzer
java.lang.Object
org.apache.lucene.analysis.Analyzer
org.apache.lucene.analysis.StopwordAnalyzerBase
org.apache.lucene.analysis.fr.FrenchAnalyzer
- All Implemented Interfaces:
Closeable
,AutoCloseable
Analyzer
for French language.
Supports an external list of stopwords (words that will not be indexed at all) and an external list of exclusions (word that will not be stemmed, but indexed). A default set of stopwords is used unless an alternative list is specified, but the exclusion list is empty by default.
NOTE: This class uses the same Version
dependent
settings as StandardAnalyzer
.
- Since:
- 3.1
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer
Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents
-
Field Summary
Modifier and TypeFieldDescriptionstatic final CharArraySet
Default set of articles for ElisionFilterstatic final String
File containing default French stopwords.Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
stopwords
Fields inherited from class org.apache.lucene.analysis.Analyzer
GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY
-
Constructor Summary
ConstructorDescriptionBuilds an analyzer with the default stop words (getDefaultStopSet()
).FrenchAnalyzer
(CharArraySet stopwords) Builds an analyzer with the given stop wordsFrenchAnalyzer
(CharArraySet stopwords, CharArraySet stemExclutionSet) Builds an analyzer with the given stop words -
Method Summary
Modifier and TypeMethodDescriptionprotected Analyzer.TokenStreamComponents
createComponents
(String fieldName) CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.static CharArraySet
Returns an unmodifiable instance of the default stop-words set.protected TokenStream
normalize
(String fieldName, TokenStream in) Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
Methods inherited from class org.apache.lucene.analysis.Analyzer
attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, initReader, initReaderForNormalization, normalize, tokenStream, tokenStream
-
Field Details
-
DEFAULT_STOPWORD_FILE
File containing default French stopwords.- See Also:
-
DEFAULT_ARTICLES
Default set of articles for ElisionFilter
-
-
Constructor Details
-
FrenchAnalyzer
public FrenchAnalyzer()Builds an analyzer with the default stop words (getDefaultStopSet()
). -
FrenchAnalyzer
Builds an analyzer with the given stop words- Parameters:
stopwords
- a stopword set
-
FrenchAnalyzer
Builds an analyzer with the given stop words- Parameters:
stopwords
- a stopword setstemExclutionSet
- a stemming exclusion set
-
-
Method Details
-
getDefaultStopSet
Returns an unmodifiable instance of the default stop-words set.- Returns:
- an unmodifiable instance of the default stop-words set.
-
createComponents
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classAnalyzer
- Returns:
Analyzer.TokenStreamComponents
built from aStandardTokenizer
filtered withElisionFilter
,LowerCaseFilter
,StopFilter
,SetKeywordMarkerFilter
if a stem exclusion set is provided, andFrenchLightStemFilter
-
normalize
-