org.apache.lucene.analysis.uk

Class UkrainianMorfologikAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.StopwordAnalyzerBase

org.apache.lucene.analysis.uk.UkrainianMorfologikAnalyzer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class UkrainianMorfologikAnalyzer
extends StopwordAnalyzerBase

A dictionary-based Analyzer for Ukrainian.

Since:

6.2.0

Nested Class Summary

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

Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_STOPWORD_FILE File containing default Ukrainian stopwords.

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 and Description
UkrainianMorfologikAnalyzer() Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.
UkrainianMorfologikAnalyzer(CharArraySet stopwords) Builds an analyzer with the given stop words.
UkrainianMorfologikAnalyzer(CharArraySet stopwords, CharArraySet stemExclusionSet) Builds an analyzer with the given stop words.

Method Summary

Modifier and Type	Method and 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 java.io.Reader	initReader(java.lang.String fieldName, java.io.Reader reader) Override this if you want to add a CharFilter chain.

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

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 Ukrainian stopwords.

See Also:

Constant Field Values

Constructor Detail

UkrainianMorfologikAnalyzer

public UkrainianMorfologikAnalyzer()

Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.

UkrainianMorfologikAnalyzer

public UkrainianMorfologikAnalyzer(CharArraySet stopwords)

Builds an analyzer with the given stop words.

Parameters:

stopwords - a stopword set

UkrainianMorfologikAnalyzer

public UkrainianMorfologikAnalyzer(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.

initReader

protected java.io.Reader initReader(java.lang.String fieldName,
                                    java.io.Reader reader)

Description copied from class: Analyzer

Override this if you want to add a CharFilter chain.

The default implementation returns reader unchanged.

Overrides:

initReader in class Analyzer

Parameters:

fieldName - IndexableField name being indexed

reader - original Reader

Returns:

reader, optionally decorated with CharFilter(s)

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 LowerCaseFilter, StopFilter , SetKeywordMarkerFilter if a stem exclusion set is provided and MorfologikFilter on the Ukrainian dictionary.