org.apache.lucene.analysis: public final class: StopAnalyzer

org.apache.lucene.analysis
public final class: StopAnalyzer [javadoc | source]

java.lang.Object
   org.apache.lucene.analysis.Analyzer
      org.apache.lucene.analysis.StopAnalyzer

All Implemented Interfaces:
Closeable

Filters LetterTokenizer with LowerCaseFilter and StopFilter .

You must specify the required Version compatibility when creating StopAnalyzer:

As of 2.9, position increments are preserved

Field Summary
public static final Set<?>	ENGLISH_STOP_WORDS_SET	An unmodifiable set containing some common English words that are not usually useful for searching.

Fields inherited from org.apache.lucene.analysis.Analyzer:
overridesTokenStreamMethod

Constructor:

Constructor:
public StopAnalyzer(Version matchVersion) { stopWords = ENGLISH_STOP_WORDS_SET; enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion); } Builds an analyzer which removes words in #ENGLISH_STOP_WORDS_SET . Parameters: `matchVersion` - See above
public StopAnalyzer(Version matchVersion, Set<?> stopWords) { this.stopWords = stopWords; enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion); } Builds an analyzer with the stop words from the given set. Parameters: `matchVersion` - See above `stopWords` - Set of stop words
public StopAnalyzer(Version matchVersion, File stopwordsFile) throws IOException { stopWords = WordlistLoader.getWordSet(stopwordsFile); this.enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion); } Builds an analyzer with the stop words from the given file. Parameters: `matchVersion` - See above `stopwordsFile` - File to load stop words from Also see: WordlistLoader#getWordSet(File)
public StopAnalyzer(Version matchVersion, Reader stopwords) throws IOException { stopWords = WordlistLoader.getWordSet(stopwords); this.enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion); } Builds an analyzer with the stop words from the given reader. Parameters: `matchVersion` - See above `stopwords` - Reader to load stop words from Also see: WordlistLoader#getWordSet(Reader)

 public StopAnalyzer(Version matchVersion) {
    stopWords = ENGLISH_STOP_WORDS_SET;
    enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion);
}

#ENGLISH_STOP_WORDS_SET

Parameters:

matchVersion - See above

 public StopAnalyzer(Version matchVersion,
    Set<?> stopWords) {
    this.stopWords = stopWords;
    enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion);
}

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

Parameters:

matchVersion - See above

stopWords - Set of stop words

 public StopAnalyzer(Version matchVersion,
    File stopwordsFile) throws IOException {
    stopWords = WordlistLoader.getWordSet(stopwordsFile);
    this.enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion);
}

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

Parameters:

matchVersion - See above

stopwordsFile - File to load stop words from

Also see:

WordlistLoader#getWordSet(File)

 public StopAnalyzer(Version matchVersion,
    Reader stopwords) throws IOException {
    stopWords = WordlistLoader.getWordSet(stopwords);
    this.enablePositionIncrements = StopFilter.getEnablePositionIncrementsVersionDefault(matchVersion);
}

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

Parameters:

matchVersion - See above

stopwords - Reader to load stop words from

Also see:

WordlistLoader#getWordSet(Reader)

Method from org.apache.lucene.analysis.StopAnalyzer Summary:
reusableTokenStream, tokenStream

Methods from org.apache.lucene.analysis.Analyzer:
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, reusableTokenStream, setOverridesTokenStreamMethod, setPreviousTokenStream, tokenStream

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.lucene.analysis.StopAnalyzer Detail:
public TokenStream reusableTokenStream(String fieldName, Reader reader) throws IOException { SavedStreams streams = (SavedStreams) getPreviousTokenStream(); if (streams == null) { streams = new SavedStreams(); streams.source = new LowerCaseTokenizer(reader); streams.result = new StopFilter(enablePositionIncrements, streams.source, stopWords); setPreviousTokenStream(streams); } else streams.source.reset(reader); return streams.result; }
public TokenStream tokenStream(String fieldName, Reader reader) { return new StopFilter(enablePositionIncrements, new LowerCaseTokenizer(reader), stopWords); } Filters LowerCaseTokenizer with StopFilter.

Method from org.apache.lucene.analysis.StopAnalyzer Detail:

 public TokenStream reusableTokenStream(String fieldName,
    Reader reader) throws IOException {
    SavedStreams streams = (SavedStreams) getPreviousTokenStream();
    if (streams == null) {
      streams = new SavedStreams();
      streams.source = new LowerCaseTokenizer(reader);
      streams.result = new StopFilter(enablePositionIncrements, streams.source, stopWords);
      setPreviousTokenStream(streams);
    } else
      streams.source.reset(reader);
    return streams.result;
}

 public TokenStream tokenStream(String fieldName,
    Reader reader) {
    return new StopFilter(enablePositionIncrements, new LowerCaseTokenizer(reader), stopWords);
}

Filters LowerCaseTokenizer with StopFilter.