org.jahia.services.search.analyzer

Class JahiaFrenchAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.ReusableAnalyzerBase

org.apache.lucene.analysis.StopwordAnalyzerBase

org.jahia.services.search.analyzer.JahiaFrenchAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public final class JahiaFrenchAnalyzer
extends org.apache.lucene.analysis.StopwordAnalyzerBase

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:

• As of 2.9, StopFilter preserves position increments

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase

org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponents

Field Summary

Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase

matchVersion, stopwords

Constructor Summary

Constructors

Constructor and Description
JahiaFrenchAnalyzer(org.apache.lucene.util.Version matchVersion) Builds an analyzer with the given stop words
JahiaFrenchAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords) Builds an analyzer with the given stop words
JahiaFrenchAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords, Set<?> stemExclutionSet) Builds an analyzer with the given stop words

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponents	createComponents(String fieldName, Reader reader) Creates ReusableAnalyzerBase.TokenStreamComponents used to tokenize all the text in the provided Reader.

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

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

close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setPreviousTokenStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JahiaFrenchAnalyzer

public JahiaFrenchAnalyzer(org.apache.lucene.util.Version matchVersion)

Builds an analyzer with the given stop words

Parameters:

stopwords - a stopword set

JahiaFrenchAnalyzer

public JahiaFrenchAnalyzer(org.apache.lucene.util.Version matchVersion,
                           Set<?> stopwords)

Builds an analyzer with the given stop words

Parameters:

matchVersion - lucene compatibility version

stopwords - a stopword set

JahiaFrenchAnalyzer

public JahiaFrenchAnalyzer(org.apache.lucene.util.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

Method Detail

createComponents

protected org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName,
                                                                                                 Reader reader)

Creates ReusableAnalyzerBase.TokenStreamComponents used to tokenize all the text in the provided Reader.

Specified by:

createComponents in class org.apache.lucene.analysis.ReusableAnalyzerBase

Returns:

ReusableAnalyzerBase.TokenStreamComponents built from a StandardTokenizer filtered with StandardFilter, ElisionFilter, LowerCaseFilter, StopFilter, KeywordMarkerFilter if a stem exclusion set is provided, and FrenchLightStemFilter