org.apache.lucene.analysis.fr

Class FrenchAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.fr.FrenchAnalyzer

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, the exclusion list is empty by default.

Version:

$Id: FrenchAnalyzer.java 692921 2008-09-07 19:22:40Z mikemccand $

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	FRENCH_STOP_WORDS Extended list of typical French stopwords.

Constructor Summary

Constructors

Constructor and Description
FrenchAnalyzer() Builds an analyzer with the default stop words (FRENCH_STOP_WORDS).
FrenchAnalyzer(java.io.File stopwords) Builds an analyzer with the given stop words.
FrenchAnalyzer(java.lang.String[] stopwords) Builds an analyzer with the given stop words.

Method Summary

Methods

Modifier and Type	Method and Description
void	setStemExclusionTable(java.io.File exclusionlist) Builds an exclusionlist from the words contained in the given file.
void	setStemExclusionTable(java.util.Map exclusionlist) Builds an exclusionlist from a Map.
void	setStemExclusionTable(java.lang.String[] exclusionlist) Builds an exclusionlist from an array of Strings.
TokenStream	tokenStream(java.lang.String fieldName, java.io.Reader reader) Creates a TokenStream which tokenizes all the text in the provided Reader.

Methods inherited from class org.apache.lucene.analysis.Analyzer

close, getPositionIncrementGap, getPreviousTokenStream, reusableTokenStream, 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 java.lang.String[] FRENCH_STOP_WORDS

Extended list of typical French stopwords.

Constructor Detail

FrenchAnalyzer

public FrenchAnalyzer()

Builds an analyzer with the default stop words (FRENCH_STOP_WORDS).

FrenchAnalyzer

public FrenchAnalyzer(java.lang.String[] stopwords)

Builds an analyzer with the given stop words.

FrenchAnalyzer

public FrenchAnalyzer(java.io.File stopwords)
               throws java.io.IOException

Builds an analyzer with the given stop words.

Throws:

java.io.IOException

Method Detail

setStemExclusionTable

public void setStemExclusionTable(java.lang.String[] exclusionlist)

Builds an exclusionlist from an array of Strings.

setStemExclusionTable

public void setStemExclusionTable(java.util.Map exclusionlist)

Builds an exclusionlist from a Map.

setStemExclusionTable

public void setStemExclusionTable(java.io.File exclusionlist)
                           throws java.io.IOException

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

Throws:

java.io.IOException

tokenStream

public final TokenStream tokenStream(java.lang.String fieldName,
                      java.io.Reader reader)

Creates a TokenStream which tokenizes all the text in the provided Reader.

Specified by:

tokenStream in class Analyzer

Returns:

A TokenStream build from a StandardTokenizer filtered with StandardFilter, StopFilter, FrenchStemFilter and LowerCaseFilter