Package org.apache.lucene.analysis.ckb

Class SoraniAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.StopwordAnalyzerBase

org.apache.lucene.analysis.ckb.SoraniAnalyzer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class SoraniAnalyzer
extends StopwordAnalyzerBase

Analyzer for Sorani Kurdish.

Since:

4.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SoraniAnalyzer.DefaultSetHolder	Atomically loads the DEFAULT_STOP_SET in a lazy fashion once the outer class accesses the static final set the first time.;

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_STOPWORD_FILE	File containing default Kurdish stopwords.
private CharArraySet	stemExclusionSet

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

Constructors

Constructor	Description
SoraniAnalyzer()	Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.
SoraniAnalyzer(CharArraySet stopwords)	Builds an analyzer with the given stop words.
SoraniAnalyzer(CharArraySet stopwords, CharArraySet stemExclusionSet)	Builds an analyzer with the given stop words.

Method Summary

Modifier and Type	Method	Description
protected Analyzer.TokenStreamComponents	createComponents(java.lang.String fieldName)	Creates a Analyzer.TokenStreamComponents which tokenizes all the text in the provided Reader.
static CharArraySet	getDefaultStopSet()	Returns an unmodifiable instance of the default stop words set.
protected TokenStream	normalize(java.lang.String fieldName, TokenStream in)	Wrap the given TokenStream in order to apply normalization filters.

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, getVersion, initReader, initReaderForNormalization, normalize, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stemExclusionSet

private final CharArraySet stemExclusionSet

DEFAULT_STOPWORD_FILE

public static final java.lang.String DEFAULT_STOPWORD_FILE

File containing default Kurdish stopwords.

See Also:

Constant Field Values

Constructor Detail

SoraniAnalyzer

public SoraniAnalyzer()

Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.

SoraniAnalyzer

public SoraniAnalyzer(CharArraySet stopwords)

Builds an analyzer with the given stop words.

Parameters:

stopwords - a stopword set

SoraniAnalyzer

public SoraniAnalyzer(CharArraySet stopwords,
                      CharArraySet stemExclusionSet)

Builds an analyzer with the given stop words. If a non-empty stem exclusion set is provided this analyzer will add a SetKeywordMarkerFilter before stemming.

Parameters:

stopwords - a stopword set

stemExclusionSet - a set of terms not to be stemmed

Method Detail

getDefaultStopSet

public static CharArraySet getDefaultStopSet()

Returns an unmodifiable instance of the default stop words set.

Returns:

default stop words set.

createComponents

protected Analyzer.TokenStreamComponents createComponents(java.lang.String fieldName)

Creates a Analyzer.TokenStreamComponents which tokenizes all the text in the provided Reader.

Specified by:

createComponents in class Analyzer

Parameters:

fieldName - the name of the fields content passed to the Analyzer.TokenStreamComponents sink as a reader

Returns:

A Analyzer.TokenStreamComponents built from an StandardTokenizer filtered with SoraniNormalizationFilter, LowerCaseFilter, DecimalDigitFilter, StopFilter , SetKeywordMarkerFilter if a stem exclusion set is provided and SoraniStemFilter.

normalize

protected TokenStream normalize(java.lang.String fieldName,
                                TokenStream in)

Description copied from class: Analyzer

Wrap the given TokenStream in order to apply normalization filters. The default implementation returns the TokenStream as-is. This is used by Analyzer.normalize(String, String).

Overrides:

normalize in class Analyzer