org.apache.lucene.analysis.standard

Class ClassicAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.util.StopwordAnalyzerBase

org.apache.lucene.analysis.standard.ClassicAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public final class ClassicAnalyzer
extends StopwordAnalyzerBase

Filters ClassicTokenizer with ClassicFilter, LowerCaseFilter and StopFilter, using a list of English stop words.

You may specify the Version compatibility when creating ClassicAnalyzer:

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

ClassicAnalyzer was named StandardAnalyzer in Lucene versions prior to 3.1. As of 3.1, StandardAnalyzer implements Unicode text segmentation, as specified by UAX#29.

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 int	DEFAULT_MAX_TOKEN_LENGTH Default maximum allowed token length
static CharArraySet	STOP_WORDS_SET An unmodifiable set containing some common English words that are usually not 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
ClassicAnalyzer() Builds an analyzer with the default stop words (STOP_WORDS_SET).
ClassicAnalyzer(CharArraySet stopWords) Builds an analyzer with the given stop words.
ClassicAnalyzer(Reader stopwords) Builds an analyzer with the stop words from the given reader.
ClassicAnalyzer(Version matchVersion) Deprecated. Use ClassicAnalyzer()
ClassicAnalyzer(Version matchVersion, CharArraySet stopWords) Deprecated. Use ClassicAnalyzer(CharArraySet)
ClassicAnalyzer(Version matchVersion, Reader stopwords) Deprecated. Use ClassicAnalyzer(CharArraySet)

Method Summary

Methods

Modifier and Type	Method and Description
protected Analyzer.TokenStreamComponents	createComponents(String fieldName, Reader reader)
int	getMaxTokenLength()
void	setMaxTokenLength(int length) Set maximum allowed token length.

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

DEFAULT_MAX_TOKEN_LENGTH

public static final int DEFAULT_MAX_TOKEN_LENGTH

Default maximum allowed token length

See Also:

Constant Field Values

STOP_WORDS_SET

public static final CharArraySet STOP_WORDS_SET

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

Constructor Detail

ClassicAnalyzer

public ClassicAnalyzer(CharArraySet stopWords)

Builds an analyzer with the given stop words.

Parameters:

stopWords - stop words

ClassicAnalyzer

@Deprecated
public ClassicAnalyzer(Version matchVersion,
                          CharArraySet stopWords)

Deprecated. Use ClassicAnalyzer(CharArraySet)

ClassicAnalyzer

public ClassicAnalyzer()

Builds an analyzer with the default stop words (STOP_WORDS_SET).

ClassicAnalyzer

@Deprecated
public ClassicAnalyzer(Version matchVersion)

Deprecated. Use ClassicAnalyzer()

ClassicAnalyzer

public ClassicAnalyzer(Reader stopwords)
                throws IOException

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

Parameters:

stopwords - Reader to read stop words from

Throws:

IOException

See Also:

WordlistLoader.getWordSet(Reader)

ClassicAnalyzer

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

Deprecated. Use ClassicAnalyzer(CharArraySet)

Throws:

IOException

Method Detail

setMaxTokenLength

public void setMaxTokenLength(int length)

Set maximum allowed token length. If a token is seen that exceeds this length then it is discarded. This setting only takes effect the next time tokenStream or tokenStream is called.

getMaxTokenLength

public int getMaxTokenLength()

See Also:

setMaxTokenLength(int)

createComponents

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

Specified by:

createComponents in class Analyzer