Package org.apache.lucene.analysis.standard

Class UAX29URLEmailAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.util.StopwordAnalyzerBase

org.apache.lucene.analysis.standard.UAX29URLEmailAnalyzer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class UAX29URLEmailAnalyzer
extends StopwordAnalyzerBase

Filters UAX29URLEmailTokenizer with StandardFilter, LowerCaseFilter and StopFilter, using a list of English stop words.

You must specify the required Version compatibility when creating UAX29URLEmailAnalyzer

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	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.Analyzer

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
UAX29URLEmailAnalyzer(Version matchVersion)	Builds an analyzer with the default stop words (STOP_WORDS_SET).
UAX29URLEmailAnalyzer(Version matchVersion, java.io.Reader stopwords)	Builds an analyzer with the stop words from the given reader.
UAX29URLEmailAnalyzer(Version matchVersion, CharArraySet stopWords)	Builds an analyzer with the given stop words.

Method Summary

Modifier and Type	Method	Description
int	getMaxTokenLength()
void	setMaxTokenLength(int length)	Set maximum allowed token length.

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

getStopwordSet

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

close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, tokenStream, tokenStream

Methods inherited from class java.lang.Object

equals, 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

UAX29URLEmailAnalyzer

public UAX29URLEmailAnalyzer(Version matchVersion,
                             CharArraySet stopWords)

Builds an analyzer with the given stop words.

Parameters:

matchVersion - Lucene version to match See {@link above}

stopWords - stop words

UAX29URLEmailAnalyzer

public UAX29URLEmailAnalyzer(Version matchVersion)

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

Parameters:

matchVersion - Lucene version to match See {@link above}

UAX29URLEmailAnalyzer

public UAX29URLEmailAnalyzer(Version matchVersion,
                             java.io.Reader stopwords)
                      throws java.io.IOException

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

Parameters:

matchVersion - Lucene version to match See {@link above}

stopwords - Reader to read stop words from

Throws:

java.io.IOException

See Also:

WordlistLoader.getWordSet(java.io.Reader, org.apache.lucene.util.Version)

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)