ddf.catalog.pubsub.criteria.contextual

Class CaseSensitiveContextualAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

ddf.catalog.pubsub.criteria.contextual.CaseSensitiveContextualAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public class CaseSensitiveContextualAnalyzer
extends org.apache.lucene.analysis.Analyzer

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

You must specify the required Version compatibility when creating StandardAnalyzer:

• As of 2.9, StopFilter preserves position increments
• As of 2.4, Tokens incorrectly identified as acronyms are corrected (see LUCENE-1608

Nested Class Summary

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

org.apache.lucene.analysis.Analyzer.ReuseStrategy, org.apache.lucene.analysis.Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_TOKEN_LENGTH Default maximum allowed token length
protected static Set<?>	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 and Description
CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion) Builds an analyzer with the default stop words (STOP_WORDS_SET).
CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion, File stopwords) Builds an analyzer with the stop words from the given file.
CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion, Reader stopwords) Builds an analyzer with the stop words from the given reader.
CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion, Set<?> stopWords) Builds an analyzer with the given stop words.

Method Summary

Modifier and Type	Method and Description
int	getMaxTokenLength()
org.apache.lucene.analysis.TokenStream	reusableTokenStream(String fieldName, Reader reader)
void	setMaxTokenLength(int length) Set maximum allowed token length.
org.apache.lucene.analysis.TokenStream	tokenStream(String fieldName, Reader reader) Constructs a StandardTokenizer filtered by a StandardFilter, a LowerCaseFilter and a StopFilter.

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

attributeFactory, close, createComponents, getOffsetGap, getPositionIncrementGap, getReuseStrategy, getVersion, initReader, initReaderForNormalization, normalize, normalize, setVersion, tokenStream

Methods inherited from class java.lang.Object

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

Field Detail

STOP_WORDS_SET

protected static final Set<?> STOP_WORDS_SET

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

DEFAULT_MAX_TOKEN_LENGTH

public static final int DEFAULT_MAX_TOKEN_LENGTH

Default maximum allowed token length

See Also:

Constant Field Values

Constructor Detail

CaseSensitiveContextualAnalyzer

public CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion)

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

Parameters:

matchVersion - Lucene version to match See above

CaseSensitiveContextualAnalyzer

public CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion,
                                       Set<?> stopWords)

Builds an analyzer with the given stop words.

Parameters:

matchVersion - Lucene version to match See above

stopWords - stop words

CaseSensitiveContextualAnalyzer

public CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion,
                                       File stopwords)
                                throws IOException

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

Parameters:

matchVersion - Lucene version to match See above

stopwords - File to read stop words from

Throws:

IOException

See Also:

WordlistLoader#getWordSet(File)

CaseSensitiveContextualAnalyzer

public CaseSensitiveContextualAnalyzer(org.apache.lucene.util.Version matchVersion,
                                       Reader stopwords)
                                throws IOException

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

Parameters:

matchVersion - Lucene version to match See above

stopwords - Reader to read stop words from

Throws:

IOException

See Also:

WordlistLoader.getWordSet(Reader)

Method Detail

tokenStream

public org.apache.lucene.analysis.TokenStream tokenStream(String fieldName,
                                                          Reader reader)

Constructs a StandardTokenizer filtered by a StandardFilter, a LowerCaseFilter and a StopFilter.

Overrides:

tokenStream in class org.apache.lucene.analysis.Analyzer

getMaxTokenLength

public int getMaxTokenLength()

See Also:

setMaxTokenLength(int)

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 reusableTokenStream is called.

reusableTokenStream

public org.apache.lucene.analysis.TokenStream reusableTokenStream(String fieldName,
                                                                  Reader reader)
                                                           throws IOException

Throws:

IOException