Package org.apache.lucene.analysis.fa

Class PersianAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.util.StopwordAnalyzerBase

org.apache.lucene.analysis.fa.PersianAnalyzer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class PersianAnalyzer
extends StopwordAnalyzerBase

Analyzer for Persian.

This Analyzer uses PersianCharFilter which implies tokenizing around zero-width non-joiner in addition to whitespace. Some persian-specific variant forms (such as farsi yeh and keheh) are standardized. "Stemming" is accomplished via stopwords.

Nested Class Summary

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

Analyzer.GlobalReuseStrategy, Analyzer.PerFieldReuseStrategy, Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_STOPWORD_FILE	File containing default Persian stopwords.
static java.lang.String	STOPWORDS_COMMENT	The comment character in the stopwords file.

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

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
PersianAnalyzer(Version matchVersion)	Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.
PersianAnalyzer(Version matchVersion, CharArraySet stopwords)	Builds an analyzer with the given stop words

Method Summary

Modifier and Type	Method	Description
static CharArraySet	getDefaultStopSet()	Returns an unmodifiable instance of the default stop-words set.

Methods inherited from class org.apache.lucene.analysis.util.StopwordAnalyzerBase

getStopwordSet

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

close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, tokenStream, tokenStream

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STOPWORD_FILE

public static final java.lang.String DEFAULT_STOPWORD_FILE

File containing default Persian stopwords. Default stopword list is from http://members.unine.ch/jacques.savoy/clef/index.html The stopword list is BSD-Licensed.

See Also:

Constant Field Values

STOPWORDS_COMMENT

public static final java.lang.String STOPWORDS_COMMENT

The comment character in the stopwords file. All lines prefixed with this will be ignored

See Also:

Constant Field Values

Constructor Detail

PersianAnalyzer

public PersianAnalyzer(Version matchVersion)

Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.

PersianAnalyzer

public PersianAnalyzer(Version matchVersion,
                       CharArraySet stopwords)

Builds an analyzer with the given stop words

Parameters:

matchVersion - lucene compatibility version

stopwords - a stopword set

Method Detail

getDefaultStopSet

public static CharArraySet getDefaultStopSet()

Returns an unmodifiable instance of the default stop-words set.

Returns:

an unmodifiable instance of the default stop-words set.