Package org.apache.lucene.analysis.de
Class GermanAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.ReusableAnalyzerBase
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.de.GermanAnalyzer
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public final class GermanAnalyzer extends org.apache.lucene.analysis.StopwordAnalyzerBaseAnalyzerfor 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.
You must specify the required
Versioncompatibility when creating GermanAnalyzer:- As of 3.6, GermanLightStemFilter is used for less aggressive stemming.
- As of 3.1, Snowball stemming is done with SnowballFilter, and Snowball stopwords are used by default.
- As of 2.9, StopFilter preserves position increments
NOTE: This class uses the same
Versiondependent settings asStandardAnalyzer.
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_STOPWORD_FILEFile containing default German stopwords.static String[]GERMAN_STOP_WORDSDeprecated.usegetDefaultStopSet()instead
-
Constructor Summary
Constructors Constructor Description GermanAnalyzer(org.apache.lucene.util.Version matchVersion)Builds an analyzer with the default stop words:getDefaultStopSet().GermanAnalyzer(org.apache.lucene.util.Version matchVersion, File stopwords)Deprecated.GermanAnalyzer(org.apache.lucene.util.Version matchVersion, String... stopwords)Deprecated.GermanAnalyzer(org.apache.lucene.util.Version matchVersion, Map<?,?> stopwords)Deprecated.GermanAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords)Builds an analyzer with the given stop wordsGermanAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)Builds an analyzer with the given stop words
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponentscreateComponents(String fieldName, Reader reader)CreatesReusableAnalyzerBase.TokenStreamComponentsused to tokenize all the text in the providedReader.static Set<?>getDefaultStopSet()Returns a set of default German-stopwordsvoidsetStemExclusionTable(File exclusionlist)Deprecated.useGermanAnalyzer(Version, Set, Set)insteadvoidsetStemExclusionTable(String[] exclusionlist)Deprecated.useGermanAnalyzer(Version, Set, Set)insteadvoidsetStemExclusionTable(Map<?,?> exclusionlist)Deprecated.useGermanAnalyzer(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
-
-
-
-
Field Detail
-
GERMAN_STOP_WORDS
@Deprecated public static final String[] GERMAN_STOP_WORDS
Deprecated.usegetDefaultStopSet()insteadList of typical german stopwords.
-
DEFAULT_STOPWORD_FILE
public static final String DEFAULT_STOPWORD_FILE
File containing default German stopwords.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GermanAnalyzer
public GermanAnalyzer(org.apache.lucene.util.Version matchVersion)
Builds an analyzer with the default stop words:getDefaultStopSet().
-
GermanAnalyzer
public GermanAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords)Builds an analyzer with the given stop words- Parameters:
matchVersion- lucene compatibility versionstopwords- a stopword set
-
GermanAnalyzer
public GermanAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)Builds an analyzer with the given stop words- Parameters:
matchVersion- lucene compatibility versionstopwords- a stopword setstemExclusionSet- a stemming exclusion set
-
GermanAnalyzer
@Deprecated public GermanAnalyzer(org.apache.lucene.util.Version matchVersion, String... stopwords)
Deprecated.Builds an analyzer with the given stop words.
-
GermanAnalyzer
@Deprecated public GermanAnalyzer(org.apache.lucene.util.Version matchVersion, Map<?,?> stopwords)
Deprecated.Builds an analyzer with the given stop words.
-
GermanAnalyzer
@Deprecated public GermanAnalyzer(org.apache.lucene.util.Version matchVersion, File stopwords) throws IOException
Deprecated.Builds an analyzer with the given stop words.- Throws:
IOException
-
-
Method Detail
-
getDefaultStopSet
public static final Set<?> getDefaultStopSet()
Returns a set of default German-stopwords- Returns:
- a set of default German-stopwords
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(String[] exclusionlist)
Deprecated.useGermanAnalyzer(Version, Set, Set)insteadBuilds an exclusionlist from an array of Strings.
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(Map<?,?> exclusionlist)
Deprecated.useGermanAnalyzer(Version, Set, Set)insteadBuilds an exclusionlist from aMap
-
setStemExclusionTable
@Deprecated public void setStemExclusionTable(File exclusionlist) throws IOException
Deprecated.useGermanAnalyzer(Version, Set, Set)insteadBuilds an exclusionlist from the words contained in the given file.- Throws:
IOException
-
createComponents
protected org.apache.lucene.analysis.ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
CreatesReusableAnalyzerBase.TokenStreamComponentsused to tokenize all the text in the providedReader.- Specified by:
createComponentsin classorg.apache.lucene.analysis.ReusableAnalyzerBase- Returns:
ReusableAnalyzerBase.TokenStreamComponentsbuilt from aStandardTokenizerfiltered withStandardFilter,LowerCaseFilter,StopFilter,KeywordMarkerFilterif a stem exclusion set is provided,GermanNormalizationFilterandGermanLightStemFilter
-
-