Package org.apache.lucene.analysis.ru
Class RussianAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.ReusableAnalyzerBase
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.ru.RussianAnalyzer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class RussianAnalyzer extends StopwordAnalyzerBase
Analyzer
for Russian language.Supports an external list of stopwords (words that will not be indexed at all). A default set of stopwords is used unless an alternative list is specified.
You must specify the required
Version
compatibility when creating RussianAnalyzer:- As of 3.1, StandardTokenizer is used, Snowball stemming is done with SnowballFilter, and Snowball stopwords are used by default.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
ReusableAnalyzerBase.TokenStreamComponents
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_STOPWORD_FILE
File containing default Russian stopwords.-
Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
matchVersion, stopwords
-
-
Constructor Summary
Constructors Constructor Description RussianAnalyzer(Version matchVersion)
RussianAnalyzer(Version matchVersion, String... stopwords)
Deprecated.useRussianAnalyzer(Version, Set)
insteadRussianAnalyzer(Version matchVersion, Map<?,?> stopwords)
Deprecated.useRussianAnalyzer(Version, Set)
insteadRussianAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop wordsRussianAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
Builds an analyzer with the given stop words
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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.-
Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
-
Methods inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
initReader, reusableTokenStream, tokenStream
-
Methods inherited from class org.apache.lucene.analysis.Analyzer
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setPreviousTokenStream
-
-
-
-
Field Detail
-
DEFAULT_STOPWORD_FILE
public static final String DEFAULT_STOPWORD_FILE
File containing default Russian stopwords.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RussianAnalyzer
public RussianAnalyzer(Version matchVersion)
-
RussianAnalyzer
@Deprecated public RussianAnalyzer(Version matchVersion, String... stopwords)
Deprecated.useRussianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
RussianAnalyzer
public RussianAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop words- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword set
-
RussianAnalyzer
public RussianAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
Builds an analyzer with the given stop words- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword setstemExclusionSet
- a set of words not to be stemmed
-
RussianAnalyzer
@Deprecated public RussianAnalyzer(Version matchVersion, Map<?,?> stopwords)
Deprecated.useRussianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words. TODO: create a Set version of this ctor
-
-
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 ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
CreatesReusableAnalyzerBase.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classReusableAnalyzerBase
- Parameters:
fieldName
- the name of the fields content passed to theReusableAnalyzerBase.TokenStreamComponents
sink as a readerreader
- the reader passed to theTokenizer
constructor- Returns:
ReusableAnalyzerBase.TokenStreamComponents
built from aStandardTokenizer
filtered withStandardFilter
,LowerCaseFilter
,StopFilter
,KeywordMarkerFilter
if a stem exclusion set is provided, andSnowballFilter
-
-