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

Filters LetterTokenizer with LowerCaseFilter and StopFilter.

Field Summary
public static final String[]	ENGLISH_STOP_WORDS	An array containing some common English words that are not usually useful for searching.

Constructor:
public StopAnalyzer() { stopWords = StopFilter.makeStopSet(ENGLISH_STOP_WORDS); } Builds an analyzer which removes words in ENGLISH_STOP_WORDS.
public StopAnalyzer(Set stopWords) { this.stopWords = stopWords; } Builds an analyzer with the stop words from the given set.
public StopAnalyzer(String[] stopWords) { this.stopWords = StopFilter.makeStopSet(stopWords); } Builds an analyzer which removes words in the provided array.
public StopAnalyzer(File stopwordsFile) throws IOException { stopWords = WordlistLoader.getWordSet(stopwordsFile); } Builds an analyzer with the stop words from the given file. Also see: WordlistLoader#getWordSet(File)
public StopAnalyzer(Reader stopwords) throws IOException { stopWords = WordlistLoader.getWordSet(stopwords); } Builds an analyzer with the stop words from the given reader. Also see: WordlistLoader#getWordSet(Reader)

Constructor:

 public StopAnalyzer() {
           
    stopWords = StopFilter.makeStopSet(ENGLISH_STOP_WORDS);
}

Builds an analyzer which removes words in ENGLISH_STOP_WORDS.

 public StopAnalyzer(Set stopWords) {
    this.stopWords = stopWords;
}

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

 public StopAnalyzer(String[] stopWords) {
    this.stopWords = StopFilter.makeStopSet(stopWords);
}

Builds an analyzer which removes words in the provided array.

 public StopAnalyzer(File stopwordsFile) throws IOException {
    stopWords = WordlistLoader.getWordSet(stopwordsFile);
}

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

Also see:

WordlistLoader#getWordSet(File)

 public StopAnalyzer(Reader stopwords) throws IOException {
    stopWords = WordlistLoader.getWordSet(stopwords);
}

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

Also see:

WordlistLoader#getWordSet(Reader)

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

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

Methods from java.lang.Object:
equals, 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(streams.source, stopWords); setPreviousTokenStream(streams); } else streams.source.reset(reader); return streams.result; }
public TokenStream tokenStream(String fieldName, Reader reader) { return new StopFilter(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(streams.source, stopWords);
      setPreviousTokenStream(streams);
    } else
      streams.source.reset(reader);
    return streams.result;
}

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

Filters LowerCaseTokenizer with StopFilter.