BrazilianAnalyzer (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.analysis.Analyzer
- - org.apache.lucene.analysis.br.BrazilianAnalyzer

```
public final class BrazilianAnalyzer
extends Analyzer
```
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 as StandardAnalyzer.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String[] BRAZILIAN_STOP_WORDS
List of typical Brazilian Portuguese stopwords.
- Fields inherited from class org.apache.lucene.analysis.Analyzer
  overridesTokenStreamMethod

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`BRAZILIAN_STOP_WORDS` List of typical Brazilian Portuguese stopwords.

Constructor Summary

Constructors
Constructor and Description
`BrazilianAnalyzer()` Deprecated. Use `BrazilianAnalyzer(Version)` instead
`BrazilianAnalyzer(java.io.File stopwords)` Deprecated. Use `BrazilianAnalyzer(Version, File)` instead
`BrazilianAnalyzer(java.util.Map stopwords)` Deprecated. Use `BrazilianAnalyzer(Version, Map)` instead
`BrazilianAnalyzer(java.lang.String[] stopwords)` Deprecated. Use `BrazilianAnalyzer(Version, String[])` instead
`BrazilianAnalyzer(Version matchVersion)` Builds an analyzer with the default stop words (`BRAZILIAN_STOP_WORDS`).
`BrazilianAnalyzer(Version matchVersion, java.io.File stopwords)` Builds an analyzer with the given stop words.
`BrazilianAnalyzer(Version matchVersion, java.util.Map stopwords)` Builds an analyzer with the given stop words.
`BrazilianAnalyzer(Version matchVersion, java.lang.String[] stopwords)` Builds an analyzer with the given stop words.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TokenStream`	`reusableTokenStream(java.lang.String fieldName, java.io.Reader reader)` Returns a (possibly reused) `TokenStream` which tokenizes all the text in the provided `Reader`.
`void`	`setStemExclusionTable(java.io.File exclusionlist)` Builds an exclusionlist from the words contained in the given file.
`void`	`setStemExclusionTable(java.util.Map exclusionlist)` Builds an exclusionlist from a `Map`.
`void`	`setStemExclusionTable(java.lang.String[] exclusionlist)` Builds an exclusionlist from an array of Strings.
`TokenStream`	`tokenStream(java.lang.String fieldName, java.io.Reader reader)` Creates a `TokenStream` which tokenizes all the text in the provided `Reader`.

Methods inherited from class org.apache.lucene.analysis.Analyzer
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setOverridesTokenStreamMethod, setPreviousTokenStream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BRAZILIAN_STOP_WORDS
```
public static final java.lang.String[] BRAZILIAN_STOP_WORDS
```
    List of typical Brazilian Portuguese stopwords.
- Constructor Detail
  - BrazilianAnalyzer
```
public BrazilianAnalyzer()
```
    Deprecated. Use BrazilianAnalyzer(Version) instead
    
    Builds an analyzer with the default stop words (BRAZILIAN_STOP_WORDS).
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(Version matchVersion)
```
    Builds an analyzer with the default stop words (BRAZILIAN_STOP_WORDS).
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(java.lang.String[] stopwords)
```
    Deprecated. Use BrazilianAnalyzer(Version, String[]) instead
    
    Builds an analyzer with the given stop words.
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(Version matchVersion,
                         java.lang.String[] stopwords)
```
    Builds an analyzer with the given stop words.
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(java.util.Map stopwords)
```
    Deprecated. Use BrazilianAnalyzer(Version, Map) instead
    
    Builds an analyzer with the given stop words.
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(Version matchVersion,
                         java.util.Map stopwords)
```
    Builds an analyzer with the given stop words.
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(java.io.File stopwords)
                  throws java.io.IOException
```
    Deprecated. Use BrazilianAnalyzer(Version, File) instead
    
    Builds an analyzer with the given stop words.
    
    Throws:
    
    java.io.IOException
  - BrazilianAnalyzer
```
public BrazilianAnalyzer(Version matchVersion,
                         java.io.File stopwords)
                  throws java.io.IOException
```
    Builds an analyzer with the given stop words.
    
    Throws:
    
    java.io.IOException
- Method Detail
  - setStemExclusionTable
```
public void setStemExclusionTable(java.lang.String[] exclusionlist)
```
    Builds an exclusionlist from an array of Strings.
  - setStemExclusionTable
```
public void setStemExclusionTable(java.util.Map exclusionlist)
```
    Builds an exclusionlist from a Map.
  - setStemExclusionTable
```
public void setStemExclusionTable(java.io.File exclusionlist)
                           throws java.io.IOException
```
    Builds an exclusionlist from the words contained in the given file.
    
    Throws:
    
    java.io.IOException
  - tokenStream
```
public final TokenStream tokenStream(java.lang.String fieldName,
                                     java.io.Reader reader)
```
    Creates a TokenStream which tokenizes all the text in the provided Reader.
    
    Specified by:
    
    tokenStream in class Analyzer
    
    Returns:
    
    A TokenStream built from a StandardTokenizer filtered with LowerCaseFilter, StandardFilter, StopFilter, and BrazilianStemFilter.
  - reusableTokenStream
```
public TokenStream reusableTokenStream(java.lang.String fieldName,
                                       java.io.Reader reader)
                                throws java.io.IOException
```
    Returns a (possibly reused) TokenStream which tokenizes all the text in the provided Reader.
    
    Overrides:
    
    reusableTokenStream in class Analyzer
    
    Returns:
    
    A TokenStream built from a StandardTokenizer filtered with LowerCaseFilter, StandardFilter, StopFilter, and BrazilianStemFilter.
    
    Throws:
    
    java.io.IOException

Class BrazilianAnalyzer

Field Summary

Fields inherited from class org.apache.lucene.analysis.Analyzer

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.analysis.Analyzer

Methods inherited from class java.lang.Object

Field Detail

BRAZILIAN_STOP_WORDS

Constructor Detail

BrazilianAnalyzer

BrazilianAnalyzer

BrazilianAnalyzer

BrazilianAnalyzer

BrazilianAnalyzer

BrazilianAnalyzer

BrazilianAnalyzer

BrazilianAnalyzer

Method Detail

setStemExclusionTable

setStemExclusionTable

setStemExclusionTable

tokenStream

reusableTokenStream