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 org.apache.lucene.analysis.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.
-
-
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.
-
Constructor Summary
Constructors Constructor Description PersianAnalyzer(org.apache.lucene.util.Version matchVersion)
Builds an analyzer with the default stop words:DEFAULT_STOPWORD_FILE
.PersianAnalyzer(org.apache.lucene.util.Version matchVersion, File stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadPersianAnalyzer(org.apache.lucene.util.Version matchVersion, String... stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadPersianAnalyzer(org.apache.lucene.util.Version matchVersion, Hashtable<?,?> stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadPersianAnalyzer(org.apache.lucene.util.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 org.apache.lucene.analysis.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
-
-
-
-
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(org.apache.lucene.util.Version matchVersion)
Builds an analyzer with the default stop words:DEFAULT_STOPWORD_FILE
.
-
PersianAnalyzer
public PersianAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop words- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword set
-
PersianAnalyzer
@Deprecated public PersianAnalyzer(org.apache.lucene.util.Version matchVersion, String... stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
PersianAnalyzer
@Deprecated public PersianAnalyzer(org.apache.lucene.util.Version matchVersion, Hashtable<?,?> stopwords)
Deprecated.usePersianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
PersianAnalyzer
@Deprecated public PersianAnalyzer(org.apache.lucene.util.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 org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
CreatesReusableAnalyzerBase.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classorg.apache.lucene.analysis.ReusableAnalyzerBase
- 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 classorg.apache.lucene.analysis.ReusableAnalyzerBase
-
-