org.apache.lucene.analysis.fr
Class FrenchAnalyzer

java.lang.Object
  extended by org.apache.lucene.analysis.Analyzer
      extended by org.apache.lucene.analysis.fr.FrenchAnalyzer
All Implemented Interfaces:
Closeable

public final class FrenchAnalyzer
extends Analyzer

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.

You must specify the required Version compatibility when creating FrenchAnalyzer:

NOTE: This class uses the same Version dependent settings as StandardAnalyzer.


Field Summary
static String[] FRENCH_STOP_WORDS
          Deprecated. use getDefaultStopSet() instead
 
Fields inherited from class org.apache.lucene.analysis.Analyzer
overridesTokenStreamMethod
 
Constructor Summary
FrenchAnalyzer(Version matchVersion)
          Builds an analyzer with the default stop words (FRENCH_STOP_WORDS).
FrenchAnalyzer(Version matchVersion, File stopwords)
          Deprecated. use FrenchAnalyzer(Version, Set) instead
FrenchAnalyzer(Version matchVersion, Set<?> stopwords)
          Builds an analyzer with the given stop words
FrenchAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclutionSet)
          Builds an analyzer with the given stop words
FrenchAnalyzer(Version matchVersion, String... stopwords)
          Deprecated. use FrenchAnalyzer(Version, Set) instead
 
Method Summary
static Set<?> getDefaultStopSet()
          Returns an unmodifiable instance of the default stop-words set.
 TokenStream reusableTokenStream(String fieldName, Reader reader)
          Returns a (possibly reused) TokenStream which tokenizes all the text in the provided Reader.
 void setStemExclusionTable(File exclusionlist)
          Deprecated. use FrenchAnalyzer(Version, Set, Set) instead
 void setStemExclusionTable(Map exclusionlist)
          Deprecated. use FrenchAnalyzer(Version, Set, Set) instead
 void setStemExclusionTable(String... exclusionlist)
          Deprecated. use FrenchAnalyzer(Version, Set, Set) instead
 TokenStream tokenStream(String fieldName, Reader reader)
          Creates a TokenStream which tokenizes all the text in the provided Reader.
 
Methods inherited from class org.apache.lucene.analysis.Analyzer
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setOverridesTokenStreamMethod, setPreviousTokenStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FRENCH_STOP_WORDS

public static final String[] FRENCH_STOP_WORDS
Deprecated. use getDefaultStopSet() instead
Extended list of typical French stopwords.

Constructor Detail

FrenchAnalyzer

public FrenchAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words (FRENCH_STOP_WORDS).


FrenchAnalyzer

public FrenchAnalyzer(Version matchVersion,
                      Set<?> stopwords)
Builds an analyzer with the given stop words

Parameters:
matchVersion - lucene compatibility version
stopwords - a stopword set

FrenchAnalyzer

public FrenchAnalyzer(Version matchVersion,
                      Set<?> stopwords,
                      Set<?> stemExclutionSet)
Builds an analyzer with the given stop words

Parameters:
matchVersion - lucene compatibility version
stopwords - a stopword set
stemExclutionSet - a stemming exclusion set

FrenchAnalyzer

public FrenchAnalyzer(Version matchVersion,
                      String... stopwords)
Deprecated. use FrenchAnalyzer(Version, Set) instead

Builds an analyzer with the given stop words.


FrenchAnalyzer

public FrenchAnalyzer(Version matchVersion,
                      File stopwords)
               throws IOException
Deprecated. use FrenchAnalyzer(Version, Set) instead

Builds 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

public void setStemExclusionTable(String... exclusionlist)
Deprecated. use FrenchAnalyzer(Version, Set, Set) instead

Builds an exclusionlist from an array of Strings.


setStemExclusionTable

public void setStemExclusionTable(Map exclusionlist)
Deprecated. use FrenchAnalyzer(Version, Set, Set) instead

Builds an exclusionlist from a Map.


setStemExclusionTable

public void setStemExclusionTable(File exclusionlist)
                           throws IOException
Deprecated. use FrenchAnalyzer(Version, Set, Set) instead

Builds an exclusionlist from the words contained in the given file.

Throws:
IOException

tokenStream

public final TokenStream tokenStream(String fieldName,
                                     Reader reader)
Creates a TokenStream which tokenizes all the text in the provided Reader.

Specified by:
tokenStream in class Analyzer
Returns:
A TokenStream built from a StandardTokenizer filtered with StandardFilter, StopFilter, FrenchStemFilter and LowerCaseFilter

reusableTokenStream

public TokenStream reusableTokenStream(String fieldName,
                                       Reader reader)
                                throws IOException
Returns a (possibly reused) TokenStream which tokenizes all the text in the provided Reader.

Overrides:
reusableTokenStream in class Analyzer
Returns:
A TokenStream built from a StandardTokenizer filtered with StandardFilter, StopFilter, FrenchStemFilter and LowerCaseFilter
Throws:
IOException


Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.