Package org.apache.lucene.analysis.br
Class BrazilianAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.br.BrazilianAnalyzer
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public final class BrazilianAnalyzer extends StopwordAnalyzerBase
Analyzer
for Brazilian Portuguese language.Supports an external list of stopwords (words that will not be indexed at all) and an external list of exclusions (words that will not be stemmed, but indexed).
NOTE: This class uses the same
Version
dependent settings asStandardAnalyzer
.- Since:
- 3.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
BrazilianAnalyzer.DefaultSetHolder
-
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 Brazilian Portuguese stopwords.private CharArraySet
excltable
Contains words that should be indexed but not stemmed.-
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 BrazilianAnalyzer()
Builds an analyzer with the default stop words (getDefaultStopSet()
).BrazilianAnalyzer(CharArraySet stopwords)
Builds an analyzer with the given stop wordsBrazilianAnalyzer(CharArraySet stopwords, CharArraySet stemExclusionSet)
Builds an analyzer with the given stop words and stemming exclusion words
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Analyzer.TokenStreamComponents
createComponents(java.lang.String fieldName)
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.static CharArraySet
getDefaultStopSet()
Returns an unmodifiable instance of the default stop-words set.protected TokenStream
normalize(java.lang.String fieldName, TokenStream in)
Wrap the givenTokenStream
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, initReader, initReaderForNormalization, normalize, tokenStream, tokenStream
-
-
-
-
Field Detail
-
DEFAULT_STOPWORD_FILE
public static final java.lang.String DEFAULT_STOPWORD_FILE
File containing default Brazilian Portuguese stopwords.- See Also:
- Constant Field Values
-
excltable
private CharArraySet excltable
Contains words that should be indexed but not stemmed.
-
-
Constructor Detail
-
BrazilianAnalyzer
public BrazilianAnalyzer()
Builds an analyzer with the default stop words (getDefaultStopSet()
).
-
BrazilianAnalyzer
public BrazilianAnalyzer(CharArraySet stopwords)
Builds an analyzer with the given stop words- Parameters:
stopwords
- a stopword set
-
BrazilianAnalyzer
public BrazilianAnalyzer(CharArraySet stopwords, CharArraySet stemExclusionSet)
Builds an analyzer with the given stop words and stemming exclusion words- Parameters:
stopwords
- a stopword set
-
-
Method Detail
-
getDefaultStopSet
public static CharArraySet getDefaultStopSet()
Returns an unmodifiable instance of the default stop-words set.- Returns:
- an unmodifiable instance of the default stop-words set.
-
createComponents
protected Analyzer.TokenStreamComponents createComponents(java.lang.String fieldName)
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classAnalyzer
- Parameters:
fieldName
- the name of the fields content passed to theAnalyzer.TokenStreamComponents
sink as a reader- Returns:
Analyzer.TokenStreamComponents
built from aStandardTokenizer
filtered withLowerCaseFilter
,StopFilter
, andBrazilianStemFilter
.
-
normalize
protected TokenStream normalize(java.lang.String fieldName, TokenStream in)
Description copied from class:Analyzer
Wrap the givenTokenStream
in order to apply normalization filters. The default implementation returns theTokenStream
as-is. This is used byAnalyzer.normalize(String, String)
.
-
-