Package org.apache.lucene.analysis.fa
Class PersianAnalyzer
java.lang.Object
org.apache.lucene.analysis.Analyzer
org.apache.lucene.analysis.StopwordAnalyzerBase
org.apache.lucene.analysis.fa.PersianAnalyzer
- All Implemented Interfaces:
Closeable
,AutoCloseable
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.
- Since:
- 3.1
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer
Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
File containing default Persian stopwords.static final String
The comment character in the stopwords file.Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
stopwords
Fields inherited from class org.apache.lucene.analysis.Analyzer
GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY
-
Constructor Summary
ConstructorDescriptionBuilds an analyzer with the default stop words:DEFAULT_STOPWORD_FILE
.PersianAnalyzer
(CharArraySet stopwords) Builds an analyzer with the given stop words -
Method Summary
Modifier and TypeMethodDescriptionprotected Analyzer.TokenStreamComponents
createComponents
(String fieldName) CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.static CharArraySet
Returns an unmodifiable instance of the default stop-words set.protected Reader
initReader
(String fieldName, Reader reader) Wraps the Reader withPersianCharFilter
protected TokenStream
normalize
(String fieldName, TokenStream in) Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
Methods inherited from class org.apache.lucene.analysis.Analyzer
attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, initReaderForNormalization, normalize, tokenStream, tokenStream
-
Field Details
-
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:
-
STOPWORDS_COMMENT
The comment character in the stopwords file. All lines prefixed with this will be ignored- See Also:
-
-
Constructor Details
-
PersianAnalyzer
public PersianAnalyzer()Builds an analyzer with the default stop words:DEFAULT_STOPWORD_FILE
. -
PersianAnalyzer
Builds an analyzer with the given stop words- Parameters:
stopwords
- a stopword set
-
-
Method Details
-
getDefaultStopSet
Returns an unmodifiable instance of the default stop-words set.- Returns:
- an unmodifiable instance of the default stop-words set.
-
createComponents
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classAnalyzer
- Returns:
Analyzer.TokenStreamComponents
built from aStandardTokenizer
filtered withLowerCaseFilter
,DecimalDigitFilter
,ArabicNormalizationFilter
,PersianNormalizationFilter
and Persian Stop words
-
normalize
-
initReader
Wraps the Reader withPersianCharFilter
- Overrides:
initReader
in classAnalyzer
-