GermanAnalyzer (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.analysis.Analyzer
- - org.apache.lucene.analysis.de.GermanAnalyzer

```
public class GermanAnalyzer
extends org.apache.lucene.analysis.Analyzer
```
Analyzer for German language.
Supports an external list of stopwords (words that will not be indexed at all) and an external list of exclusions (word that will not be stemmed, but indexed). A default set of stopwords is used unless an alternative list is specified, but the exclusion list is empty by default.

NOTE: This class uses the same Version dependent settings as StandardAnalyzer.

Version:

$Id: GermanAnalyzer.java 829816 2009-10-26 14:49:39Z mikemccand $

Field Summary

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`GERMAN_STOP_WORDS` List of typical german stopwords.

Constructor Summary

Constructors
Constructor and Description
`GermanAnalyzer()` Deprecated. Use `GermanAnalyzer(Version)` instead
`GermanAnalyzer(java.io.File stopwords)` Deprecated. Use `GermanAnalyzer(Version, File)` instead
`GermanAnalyzer(java.util.Map stopwords)` Deprecated. Use `GermanAnalyzer(Version, Map)` instead
`GermanAnalyzer(java.lang.String[] stopwords)` Deprecated. Use `GermanAnalyzer(Version, String[])` instead
`GermanAnalyzer(org.apache.lucene.util.Version matchVersion)` Builds an analyzer with the default stop words: `GERMAN_STOP_WORDS`.
`GermanAnalyzer(org.apache.lucene.util.Version matchVersion, java.io.File stopwords)` Builds an analyzer with the given stop words.
`GermanAnalyzer(org.apache.lucene.util.Version matchVersion, java.util.Map stopwords)` Builds an analyzer with the given stop words.
`GermanAnalyzer(org.apache.lucene.util.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
`org.apache.lucene.analysis.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.
`org.apache.lucene.analysis.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
  - GERMAN_STOP_WORDS
```
public static final java.lang.String[] GERMAN_STOP_WORDS
```
    List of typical german stopwords.
- Constructor Detail
  - GermanAnalyzer
```
public GermanAnalyzer()
```
    Deprecated. Use GermanAnalyzer(Version) instead
    
    Builds an analyzer with the default stop words: GERMAN_STOP_WORDS.
  - GermanAnalyzer
```
public GermanAnalyzer(org.apache.lucene.util.Version matchVersion)
```
    Builds an analyzer with the default stop words: GERMAN_STOP_WORDS.
  - GermanAnalyzer
```
public GermanAnalyzer(java.lang.String[] stopwords)
```
    Deprecated. Use GermanAnalyzer(Version, String[]) instead
    
    Builds an analyzer with the given stop words.
  - GermanAnalyzer
```
public GermanAnalyzer(org.apache.lucene.util.Version matchVersion,
                      java.lang.String[] stopwords)
```
    Builds an analyzer with the given stop words.
  - GermanAnalyzer
```
public GermanAnalyzer(java.util.Map stopwords)
```
    Deprecated. Use GermanAnalyzer(Version, Map) instead
    
    Builds an analyzer with the given stop words.
  - GermanAnalyzer
```
public GermanAnalyzer(org.apache.lucene.util.Version matchVersion,
                      java.util.Map stopwords)
```
    Builds an analyzer with the given stop words.
  - GermanAnalyzer
```
public GermanAnalyzer(java.io.File stopwords)
               throws java.io.IOException
```
    Deprecated. Use GermanAnalyzer(Version, File) instead
    
    Builds an analyzer with the given stop words.
    
    Throws:
    
    java.io.IOException
  - GermanAnalyzer
```
public GermanAnalyzer(org.apache.lucene.util.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 org.apache.lucene.analysis.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 org.apache.lucene.analysis.Analyzer
    
    Returns:
    
    A TokenStream built from a StandardTokenizer filtered with StandardFilter, LowerCaseFilter, StopFilter, and GermanStemFilter
  - reusableTokenStream
```
public org.apache.lucene.analysis.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 org.apache.lucene.analysis.Analyzer
    
    Returns:
    
    A TokenStream built from a StandardTokenizer filtered with StandardFilter, LowerCaseFilter, StopFilter, and GermanStemFilter
    
    Throws:
    
    java.io.IOException

Class GermanAnalyzer

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

GERMAN_STOP_WORDS

Constructor Detail

GermanAnalyzer

GermanAnalyzer

GermanAnalyzer

GermanAnalyzer

GermanAnalyzer

GermanAnalyzer

GermanAnalyzer

GermanAnalyzer

Method Detail

setStemExclusionTable

setStemExclusionTable

setStemExclusionTable

tokenStream

reusableTokenStream