org.apache.lucene.analysis.core

Class StopAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.util.StopwordAnalyzerBase

org.apache.lucene.analysis.core.StopAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public final class StopAnalyzer
extends StopwordAnalyzerBase

Filters LetterTokenizer with LowerCaseFilter and StopFilter.

You may specify the Version compatibility when creating StopAnalyzer:

• As of 3.1, StopFilter correctly handles Unicode 4.0 supplementary characters in stopwords

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

Analyzer.GlobalReuseStrategy, Analyzer.PerFieldReuseStrategy, Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field and Description
static CharArraySet	ENGLISH_STOP_WORDS_SET An unmodifiable set containing some common English words that are not usually useful for searching.

Fields inherited from class org.apache.lucene.analysis.util.StopwordAnalyzerBase

stopwords

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

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor and Description
StopAnalyzer() Builds an analyzer which removes words in ENGLISH_STOP_WORDS_SET.
StopAnalyzer(CharArraySet stopWords) Builds an analyzer with the stop words from the given set.
StopAnalyzer(File stopwordsFile) Builds an analyzer with the stop words from the given file.
StopAnalyzer(Reader stopwords) Builds an analyzer with the stop words from the given reader.
StopAnalyzer(Version matchVersion) Deprecated. Use StopAnalyzer()
StopAnalyzer(Version matchVersion, CharArraySet stopWords) Deprecated. Use StopAnalyzer(CharArraySet)
StopAnalyzer(Version matchVersion, File stopwordsFile) Deprecated. Use StopAnalyzer(File)
StopAnalyzer(Version matchVersion, Reader stopwords) Deprecated. Use StopAnalyzer(Reader)

Method Summary

Methods

Modifier and Type	Method and Description
protected Analyzer.TokenStreamComponents	createComponents(String fieldName, Reader reader) Creates Analyzer.TokenStreamComponents used to tokenize all the text in the provided Reader.

Methods inherited from class org.apache.lucene.analysis.util.StopwordAnalyzerBase

getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet

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

close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, getVersion, initReader, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENGLISH_STOP_WORDS_SET

public static final CharArraySet ENGLISH_STOP_WORDS_SET

An unmodifiable set containing some common English words that are not usually useful for searching.

Constructor Detail

StopAnalyzer

public StopAnalyzer()

Builds an analyzer which removes words in ENGLISH_STOP_WORDS_SET.

StopAnalyzer

@Deprecated
public StopAnalyzer(Version matchVersion)

Deprecated. Use StopAnalyzer()

StopAnalyzer

public StopAnalyzer(CharArraySet stopWords)

Builds an analyzer with the stop words from the given set.

Parameters:

stopWords - Set of stop words

StopAnalyzer

@Deprecated
public StopAnalyzer(Version matchVersion,
                       CharArraySet stopWords)

Deprecated. Use StopAnalyzer(CharArraySet)

StopAnalyzer

public StopAnalyzer(File stopwordsFile)
             throws IOException

Builds an analyzer with the stop words from the given file.

Parameters:

stopwordsFile - File to load stop words from

Throws:

IOException

See Also:

WordlistLoader.getWordSet(Reader)

StopAnalyzer

@Deprecated
public StopAnalyzer(Version matchVersion,
                       File stopwordsFile)
             throws IOException

Deprecated. Use StopAnalyzer(File)

Throws:

IOException

StopAnalyzer

public StopAnalyzer(Reader stopwords)
             throws IOException

Builds an analyzer with the stop words from the given reader.

Parameters:

stopwords - Reader to load stop words from

Throws:

IOException

See Also:

WordlistLoader.getWordSet(Reader)

StopAnalyzer

@Deprecated
public StopAnalyzer(Version matchVersion,
                       Reader stopwords)
             throws IOException

Deprecated. Use StopAnalyzer(Reader)

Throws:

IOException

Method Detail

createComponents

protected Analyzer.TokenStreamComponents createComponents(String fieldName,
                                              Reader reader)

Creates Analyzer.TokenStreamComponents used to tokenize all the text in the provided Reader.

Specified by:

createComponents in class Analyzer

Returns:

Analyzer.TokenStreamComponents built from a LowerCaseTokenizer filtered with StopFilter