Package org.apache.lucene.analysis.br
Class BrazilianAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.ReusableAnalyzerBase
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.br.BrazilianAnalyzer
-
- All Implemented Interfaces:
Closeable
,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
.
-
-
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[]
BRAZILIAN_STOP_WORDS
Deprecated.usegetDefaultStopSet()
insteadstatic String
DEFAULT_STOPWORD_FILE
File containing default Brazilian Portuguese stopwords.-
Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
matchVersion, stopwords
-
-
Constructor Summary
Constructors Constructor Description BrazilianAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words (getDefaultStopSet()
).BrazilianAnalyzer(Version matchVersion, File stopwords)
Deprecated.useBrazilianAnalyzer(Version, Set)
insteadBrazilianAnalyzer(Version matchVersion, String... stopwords)
Deprecated.useBrazilianAnalyzer(Version, Set)
insteadBrazilianAnalyzer(Version matchVersion, Map<?,?> stopwords)
Deprecated.useBrazilianAnalyzer(Version, Set)
insteadBrazilianAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop wordsBrazilianAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
Builds an analyzer with the given stop words and stemming exclusion words
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated 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.void
setStemExclusionTable(File exclusionlist)
Deprecated.useBrazilianAnalyzer(Version, Set, Set)
insteadvoid
setStemExclusionTable(String... exclusionlist)
Deprecated.useBrazilianAnalyzer(Version, Set, Set)
insteadvoid
setStemExclusionTable(Map<?,?> exclusionlist)
Deprecated.useBrazilianAnalyzer(Version, Set, Set)
instead-
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
-
BRAZILIAN_STOP_WORDS
@Deprecated public static final String[] BRAZILIAN_STOP_WORDS
Deprecated.usegetDefaultStopSet()
insteadList of typical Brazilian Portuguese stopwords.
-
DEFAULT_STOPWORD_FILE
public static final String DEFAULT_STOPWORD_FILE
File containing default Brazilian Portuguese stopwords.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrazilianAnalyzer
public BrazilianAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words (getDefaultStopSet()
).
-
BrazilianAnalyzer
public BrazilianAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop words- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword set
-
BrazilianAnalyzer
public BrazilianAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
Builds an analyzer with the given stop words and stemming exclusion words- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword set
-
BrazilianAnalyzer
@Deprecated public BrazilianAnalyzer(Version matchVersion, String... stopwords)
Deprecated.useBrazilianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
BrazilianAnalyzer
@Deprecated public BrazilianAnalyzer(Version matchVersion, Map<?,?> stopwords)
Deprecated.useBrazilianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.
-
BrazilianAnalyzer
@Deprecated public BrazilianAnalyzer(Version matchVersion, File stopwords) throws IOException
Deprecated.useBrazilianAnalyzer(Version, Set)
insteadBuilds an analyzer with the given stop words.- Throws:
IOException
-
-
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.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(String... exclusionlist)
Deprecated.useBrazilianAnalyzer(Version, Set, Set)
insteadBuilds an exclusionlist from an array of Strings.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(Map<?,?> exclusionlist)
Deprecated.useBrazilianAnalyzer(Version, Set, Set)
insteadBuilds an exclusionlist from aMap
.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(File exclusionlist) throws IOException
Deprecated.useBrazilianAnalyzer(Version, Set, Set)
insteadBuilds an exclusionlist from the words contained in the given file.- Throws:
IOException
-
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 withLowerCaseFilter
,StandardFilter
,StopFilter
, andBrazilianStemFilter
.
-
-