PersianAnalyzer (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.analysis.Analyzer
- - org.apache.lucene.analysis.fa.PersianAnalyzer

```
public final class PersianAnalyzer
extends org.apache.lucene.analysis.Analyzer
```
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 and 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
overridesTokenStreamMethod

Constructor Summary

Constructors
Constructor and Description
`PersianAnalyzer()` Deprecated. Use `PersianAnalyzer(Version)` instead
`PersianAnalyzer(java.io.File stopwords)` Deprecated. Use `PersianAnalyzer(Version, File)` instead
`PersianAnalyzer(java.util.Hashtable stopwords)` Deprecated. Use `PersianAnalyzer(Version, Hashtable)` instead
`PersianAnalyzer(java.lang.String[] stopwords)` Deprecated. Use `PersianAnalyzer(Version, String[])` instead
`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, java.io.File stopwords)` Builds an analyzer with the given stop words.
`PersianAnalyzer(org.apache.lucene.util.Version matchVersion, java.util.Hashtable stopwords)` Builds an analyzer with the given stop words.
`PersianAnalyzer(org.apache.lucene.util.Version matchVersion, java.lang.String[] stopwords)` Builds an analyzer with the given stop words.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.lucene.analysis.TokenStream`	`reusableTokenStream(java.lang.String fieldName, java.io.Reader reader)` Returns a (possibly reused) `TokenStream` which tokenizes all the text in the provided `Reader`.
`org.apache.lucene.analysis.TokenStream`	`tokenStream(java.lang.String fieldName, java.io.Reader reader)` Creates a `TokenStream` which tokenizes all the text in the provided `Reader`.

Methods inherited from class org.apache.lucene.analysis.Analyzer
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setOverridesTokenStreamMethod, setPreviousTokenStream

Methods inherited from class java.lang.Object
clone, equals, finalize, 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()
```
    Deprecated. Use PersianAnalyzer(Version) instead
    
    Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.
  - PersianAnalyzer
```
public PersianAnalyzer(org.apache.lucene.util.Version matchVersion)
```
    Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.
  - PersianAnalyzer
```
public PersianAnalyzer(java.lang.String[] stopwords)
```
    Deprecated. Use PersianAnalyzer(Version, String[]) instead
    
    Builds an analyzer with the given stop words.
  - PersianAnalyzer
```
public PersianAnalyzer(org.apache.lucene.util.Version matchVersion,
                       java.lang.String[] stopwords)
```
    Builds an analyzer with the given stop words.
  - PersianAnalyzer
```
public PersianAnalyzer(java.util.Hashtable stopwords)
```
    Deprecated. Use PersianAnalyzer(Version, Hashtable) instead
    
    Builds an analyzer with the given stop words.
  - PersianAnalyzer
```
public PersianAnalyzer(org.apache.lucene.util.Version matchVersion,
                       java.util.Hashtable stopwords)
```
    Builds an analyzer with the given stop words.
  - PersianAnalyzer
```
public PersianAnalyzer(java.io.File stopwords)
                throws java.io.IOException
```
    Deprecated. Use PersianAnalyzer(Version, File) instead
    
    Builds an analyzer with the given stop words. Lines can be commented out using STOPWORDS_COMMENT
    
    Throws:
    
    java.io.IOException
  - PersianAnalyzer
```
public PersianAnalyzer(org.apache.lucene.util.Version matchVersion,
                       java.io.File stopwords)
                throws java.io.IOException
```
    Builds an analyzer with the given stop words. Lines can be commented out using STOPWORDS_COMMENT
    
    Throws:
    
    java.io.IOException
- Method Detail
  - tokenStream
```
public org.apache.lucene.analysis.TokenStream tokenStream(java.lang.String fieldName,
                                                          java.io.Reader reader)
```
    Creates a TokenStream which tokenizes all the text in the provided Reader.
    
    Specified by:
    
    tokenStream in class org.apache.lucene.analysis.Analyzer
    
    Returns:
    
    A TokenStream built from a ArabicLetterTokenizer filtered with LowerCaseFilter, ArabicNormalizationFilter, PersianNormalizationFilter and Persian Stop words
  - reusableTokenStream
```
public org.apache.lucene.analysis.TokenStream reusableTokenStream(java.lang.String fieldName,
                                                                  java.io.Reader reader)
                                                           throws java.io.IOException
```
    Returns a (possibly reused) TokenStream which tokenizes all the text in the provided Reader.
    
    Overrides:
    
    reusableTokenStream in class org.apache.lucene.analysis.Analyzer
    
    Returns:
    
    A TokenStream built from a ArabicLetterTokenizer filtered with LowerCaseFilter, ArabicNormalizationFilter, PersianNormalizationFilter and Persian Stop words
    
    Throws:
    
    java.io.IOException

Class PersianAnalyzer

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_STOPWORD_FILE

STOPWORDS_COMMENT

Constructor Detail

PersianAnalyzer

PersianAnalyzer

PersianAnalyzer

PersianAnalyzer

PersianAnalyzer

PersianAnalyzer

PersianAnalyzer

PersianAnalyzer

Method Detail

tokenStream

reusableTokenStream