Class PersianAnalyzer

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.

Inheritance
System.Object
Analyzer
StopwordAnalyzerBase
PersianAnalyzer
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Analysis.Fa
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class PersianAnalyzer : StopwordAnalyzerBase, IDisposable

Constructors

| Improve this Doc View Source

PersianAnalyzer(LuceneVersion)

Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.

Declaration
public PersianAnalyzer(LuceneVersion matchVersion)
Parameters
Type Name Description
LuceneVersion matchVersion
| Improve this Doc View Source

PersianAnalyzer(LuceneVersion, CharArraySet)

Builds an analyzer with the given stop words

Declaration
public PersianAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords)
Parameters
Type Name Description
LuceneVersion matchVersion

lucene compatibility version

CharArraySet stopwords

a stopword set

Fields

| Improve this Doc View Source

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.

Declaration
public const string DEFAULT_STOPWORD_FILE = "stopwords.txt"
Field Value
Type Description
System.String
| Improve this Doc View Source

STOPWORDS_COMMENT

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

Declaration
public const string STOPWORDS_COMMENT = "#"
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

DefaultStopSet

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

Declaration
public static CharArraySet DefaultStopSet { get; }
Property Value
Type Description
CharArraySet

an unmodifiable instance of the default stop-words set.

Methods

| Improve this Doc View Source

CreateComponents(String, TextReader)

Creates TokenStreamComponents used to tokenize all the text in the provided System.IO.TextReader.

Declaration
protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
Parameters
Type Name Description
System.String fieldName
System.IO.TextReader reader
Returns
Type Description
TokenStreamComponents

TokenStreamComponents built from a StandardTokenizer filtered with LowerCaseFilter, ArabicNormalizationFilter, PersianNormalizationFilter and Persian Stop words

Overrides
| Improve this Doc View Source

InitReader(String, TextReader)

Wraps the System.IO.TextReader with PersianCharFilter

Declaration
protected override TextReader InitReader(string fieldName, TextReader reader)
Parameters
Type Name Description
System.String fieldName
System.IO.TextReader reader
Returns
Type Description
System.IO.TextReader
Overrides

Implements

System.IDisposable