Package org.apache.lucene.analysis.fa
Class PersianAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.ReusableAnalyzerBase
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.fa.PersianAnalyzer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class PersianAnalyzer extends StopwordAnalyzerBase
Analyzer
for Persian.This Analyzer uses
ArabicLetterTokenizer
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.ReusableAnalyzerBase
ReusableAnalyzerBase.TokenStreamComponents
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_STOPWORD_FILE
File containing default Persian stopwords.static String
STOPWORDS_COMMENT
The comment character in the stopwords file.-
Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
matchVersion, stopwords
-
-
Constructor Summary
Constructors Constructor Description PersianAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words:DEFAULT_STOPWORD_FILE
.PersianAnalyzer(Version matchVersion, File stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadPersianAnalyzer(Version matchVersion, String... stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadPersianAnalyzer(Version matchVersion, Hashtable<?,?> stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadPersianAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop words
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ReusableAnalyzerBase.TokenStreamComponents
createComponents(String fieldName, Reader reader)
CreatesReusableAnalyzerBase.TokenStreamComponents
used to tokenize all the text in the providedReader
.static Set<?>
getDefaultStopSet()
Returns an unmodifiable instance of the default stop-words set.protected Reader
initReader(Reader reader)
Wraps the Reader withPersianCharFilter
-
Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
-
Methods inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
reusableTokenStream, tokenStream
-
Methods inherited from class org.apache.lucene.analysis.Analyzer
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setPreviousTokenStream
-
-
-
-
Field Detail
-
DEFAULT_STOPWORD_FILE
public static final 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 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, Set<?> stopwords)
Builds an analyzer with the given stop words- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword set
-
PersianAnalyzer
@Deprecated public PersianAnalyzer(Version matchVersion, String... stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
PersianAnalyzer
@Deprecated public PersianAnalyzer(Version matchVersion, Hashtable<?,?> stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
PersianAnalyzer
@Deprecated public PersianAnalyzer(Version matchVersion, File stopwords) throws IOException
Deprecated.usePersianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words. Lines can be commented out usingSTOPWORDS_COMMENT
- 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.
-
createComponents
protected ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
CreatesReusableAnalyzerBase.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classReusableAnalyzerBase
- Parameters:
fieldName
- the name of the fields content passed to theReusableAnalyzerBase.TokenStreamComponents
sink as a readerreader
- the reader passed to theTokenizer
constructor- Returns:
ReusableAnalyzerBase.TokenStreamComponents
built from aStandardTokenizer
filtered withLowerCaseFilter
,ArabicNormalizationFilter
,PersianNormalizationFilter
and Persian Stop words
-
initReader
protected Reader initReader(Reader reader)
Wraps the Reader withPersianCharFilter
- Overrides:
initReader
in classReusableAnalyzerBase
-
-