Package org.apache.lucene.analysis.fr
Class FrenchAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.ReusableAnalyzerBase
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.fr.FrenchAnalyzer
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public final class FrenchAnalyzer extends org.apache.lucene.analysis.StopwordAnalyzerBaseAnalyzerfor 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.
You must specify the required
Versioncompatibility when creating FrenchAnalyzer:- As of 3.6, FrenchLightStemFilter is used for less aggressive stemming.
- As of 3.1, Snowball stemming is done with SnowballFilter, LowerCaseFilter is used prior to StopFilter, and ElisionFilter and Snowball stopwords are used by default.
- As of 2.9, StopFilter preserves position increments
NOTE: This class uses the same
Versiondependent settings asStandardAnalyzer.
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_STOPWORD_FILEFile containing default French stopwords.static String[]FRENCH_STOP_WORDSDeprecated.usegetDefaultStopSet()instead
-
Constructor Summary
Constructors Constructor Description FrenchAnalyzer(org.apache.lucene.util.Version matchVersion)Builds an analyzer with the default stop words (getDefaultStopSet()).FrenchAnalyzer(org.apache.lucene.util.Version matchVersion, File stopwords)Deprecated.useFrenchAnalyzer(Version, Set)insteadFrenchAnalyzer(org.apache.lucene.util.Version matchVersion, String... stopwords)Deprecated.useFrenchAnalyzer(Version, Set)insteadFrenchAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords)Builds an analyzer with the given stop wordsFrenchAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords, Set<?> stemExclutionSet)Builds an analyzer with the given stop words
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponentscreateComponents(String fieldName, Reader reader)CreatesReusableAnalyzerBase.TokenStreamComponentsused to tokenize all the text in the providedReader.static Set<?>getDefaultStopSet()Returns an unmodifiable instance of the default stop-words set.voidsetStemExclusionTable(File exclusionlist)Deprecated.useFrenchAnalyzer(Version, Set, Set)insteadvoidsetStemExclusionTable(String... exclusionlist)Deprecated.useFrenchAnalyzer(Version, Set, Set)insteadvoidsetStemExclusionTable(Map<?,?> exclusionlist)Deprecated.useFrenchAnalyzer(Version, Set, Set)instead-
Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
-
Methods inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
initReader, reusableTokenStream, tokenStream
-
-
-
-
Field Detail
-
FRENCH_STOP_WORDS
@Deprecated public static final String[] FRENCH_STOP_WORDS
Deprecated.usegetDefaultStopSet()insteadExtended list of typical French stopwords.
-
DEFAULT_STOPWORD_FILE
public static final String DEFAULT_STOPWORD_FILE
File containing default French stopwords.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FrenchAnalyzer
public FrenchAnalyzer(org.apache.lucene.util.Version matchVersion)
Builds an analyzer with the default stop words (getDefaultStopSet()).
-
FrenchAnalyzer
public FrenchAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords)Builds an analyzer with the given stop words- Parameters:
matchVersion- lucene compatibility versionstopwords- a stopword set
-
FrenchAnalyzer
public FrenchAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords, Set<?> stemExclutionSet)Builds an analyzer with the given stop words- Parameters:
matchVersion- lucene compatibility versionstopwords- a stopword setstemExclutionSet- a stemming exclusion set
-
FrenchAnalyzer
@Deprecated public FrenchAnalyzer(org.apache.lucene.util.Version matchVersion, String... stopwords)
Deprecated.useFrenchAnalyzer(Version, Set)insteadBuilds an analyzer with the given stop words.
-
FrenchAnalyzer
@Deprecated public FrenchAnalyzer(org.apache.lucene.util.Version matchVersion, File stopwords) throws IOException
Deprecated.useFrenchAnalyzer(Version, Set)insteadBuilds an analyzer with the given stop words.- Throws:
IOException
-
-
Method Detail
-
getDefaultStopSet
public static Set<?> getDefaultStopSet()
Returns an unmodifiable instance of the default stop-words set.- Returns:
- an unmodifiable instance of the default stop-words set.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(String... exclusionlist)
Deprecated.useFrenchAnalyzer(Version, Set, Set)insteadBuilds an exclusionlist from an array of Strings.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(Map<?,?> exclusionlist)
Deprecated.useFrenchAnalyzer(Version, Set, Set)insteadBuilds an exclusionlist from a Map.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(File exclusionlist) throws IOException
Deprecated.useFrenchAnalyzer(Version, Set, Set)insteadBuilds an exclusionlist from the words contained in the given file.- Throws:
IOException
-
createComponents
protected org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
CreatesReusableAnalyzerBase.TokenStreamComponentsused to tokenize all the text in the providedReader.- Specified by:
createComponentsin classorg.apache.lucene.analysis.ReusableAnalyzerBase- Returns:
ReusableAnalyzerBase.TokenStreamComponentsbuilt from aStandardTokenizerfiltered withStandardFilter,ElisionFilter,LowerCaseFilter,StopFilter,KeywordMarkerFilterif a stem exclusion set is provided, andFrenchLightStemFilter
-
-