org.apache.lucene.analysis.bg
Class BulgarianAnalyzer

java.lang.Object
  extended by org.apache.lucene.analysis.Analyzer
      extended by org.apache.lucene.analysis.ReusableAnalyzerBase
          extended by org.apache.lucene.analysis.StopwordAnalyzerBase
              extended by org.apache.lucene.analysis.bg.BulgarianAnalyzer
All Implemented Interfaces:
Closeable

public final class BulgarianAnalyzer
extends StopwordAnalyzerBase

Analyzer for Bulgarian.

This analyzer implements light-stemming as specified by: Searching Strategies for the Bulgarian Language http://members.unine.ch/jacques.savoy/Papers/BUIR.pdf


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
ReusableAnalyzerBase.TokenStreamComponents
 
Field Summary
static String DEFAULT_STOPWORD_FILE
          File containing default Bulgarian stopwords.
static String STOPWORDS_COMMENT
          Deprecated. use WordlistLoader.getWordSet(Reader, String, Version) directly
 
Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
matchVersion, stopwords
 
Constructor Summary
BulgarianAnalyzer(Version matchVersion)
          Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.
BulgarianAnalyzer(Version matchVersion, Set<?> stopwords)
          Builds an analyzer with the given stop words.
BulgarianAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
          Builds an analyzer with the given stop words and a stem exclusion set.
 
Method Summary
 ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
          Creates a ReusableAnalyzerBase.TokenStreamComponents which tokenizes all the text in the provided Reader.
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
 
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 String DEFAULT_STOPWORD_FILE
File containing default Bulgarian 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

@Deprecated
public static final String STOPWORDS_COMMENT
Deprecated. use WordlistLoader.getWordSet(Reader, String, Version) directly
The comment character in the stopwords file. All lines prefixed with this will be ignored

See Also:
Constant Field Values
Constructor Detail

BulgarianAnalyzer

public BulgarianAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words: DEFAULT_STOPWORD_FILE.


BulgarianAnalyzer

public BulgarianAnalyzer(Version matchVersion,
                         Set<?> stopwords)
Builds an analyzer with the given stop words.


BulgarianAnalyzer

public BulgarianAnalyzer(Version matchVersion,
                         Set<?> stopwords,
                         Set<?> stemExclusionSet)
Builds an analyzer with the given stop words and a stem exclusion set. If a stem exclusion set is provided this analyzer will add a KeywordMarkerFilter before BulgarianStemFilter.

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

public ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName,
                                                                   Reader reader)
Creates a ReusableAnalyzerBase.TokenStreamComponents which tokenizes all the text in the provided Reader.

Specified by:
createComponents in class ReusableAnalyzerBase
Parameters:
fieldName - the name of the fields content passed to the ReusableAnalyzerBase.TokenStreamComponents sink as a reader
reader - the reader passed to the Tokenizer constructor
Returns:
A ReusableAnalyzerBase.TokenStreamComponents built from an StandardTokenizer filtered with StandardFilter, LowerCaseFilter, StopFilter , KeywordMarkerFilter if a stem exclusion set is provided and BulgarianStemFilter.