Lucene - StopAnalyzer

This analyzer works similar to SimpleAnalyzer and remove the common words like 'a', 'an', 'the', etc.

Class Declaration

Following is the declaration for the org.apache.lucene.analysis.StopAnalyzer class −

public final class StopAnalyzer
   extends StopwordAnalyzerBase

Fields

Following are the fields for the org.apache.lucene.analysis.StopAnalyzer class −

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

Class Constructors

The following table shows the different class constructors −

S.No.	Constructor & Description
1	StopAnalyzer(Version matchVersion) Builds an analyzer which removes words in ENGLISH_STOP_WORDS_SET.
2	StopAnalyzer(Version matchVersion, File stopwordsFile) Builds an analyzer with the stop words from the given file.
3	StopAnalyzer(Version matchVersion, Reader stopwords) Builds an analyzer with the stop words from the given reader.
4	StopAnalyzer(Version matchVersion, Set<?> stopWords) Builds an analyzer with the stop words from the given set.

Class Methods

The following table shows the different class methods −

S.No.	Method & Description
1	protected Reusable Analyzer Base. Token Stream Components create Components (String field Name, Reader reader) Creates a new ReusableAnalyzerBase.TokenStreamComponents used to tokenize all the text in the provided Reader.

Methods Inherited

This class inherits methods from the following classes −

org.apache.lucene.analysis.StopwordAnalyzerBase
org.apache.lucene.analysis.ReusableAnalyzerBase
org.apache.lucene.analysis.Analyzer
java.lang.Object

Usage

private void displayTokenUsingStopAnalyzer() throws IOException {
   String text 
      = "Lucene is simple yet powerful java based search library.";
   Analyzer analyzer = new StopAnalyzer(Version.LUCENE_36);
   TokenStream tokenStream 
      = analyzer.tokenStream(LuceneConstants.CONTENTS, 
      new StringReader(text));
   TermAttribute term = tokenStream.addAttribute(TermAttribute.class);
   while(tokenStream.incrementToken()) {
      System.out.print("[" + term.term() + "] ");
   }
}

Example Application

Let us create a test Lucene application to test search using BooleanQuery.

Step	Description
1	Create a project with a name LuceneFirstApplication under a package com.tutorialspoint.lucene as explained in the Lucene - First Application chapter. You can also use the project created in Lucene - First Application chapter as such for this chapter to the understand searching process.
2	Create LuceneConstants.java as explained in the Lucene - First Application chapter. Keep the rest of the files unchanged.
3	Create LuceneTester.java as mentioned below.
4	Clean and Build the application to make sure the business logic is working as per the requirements.

LuceneConstants.java

This class is used to provide various constants to be used across the sample application.

package com.tutorialspoint.lucene;

public class LuceneConstants {
   public static final String CONTENTS = "contents";
   public static final String FILE_NAME = "filename";
   public static final String FILE_PATH = "filepath";
   public static final int MAX_SEARCH = 10;
}

LuceneTester.java

This class is used to test the searching capability of the Lucene library.

package com.tutorialspoint.lucene;

import java.io.IOException;
import java.io.StringReader;

import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.StopAnalyzer;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.tokenattributes.TermAttribute;
import org.apache.lucene.util.Version;

public class LuceneTester {
	
   public static void main(String[] args) {
      LuceneTester tester;

      tester = new LuceneTester();
   
      try {
         tester.displayTokenUsingStopAnalyzer();
      } catch (IOException e) {
         e.printStackTrace();
      }
   }

   private void displayTokenUsingStopAnalyzer() throws IOException {
      String text 
         = "Lucene is simple yet powerful java based search library.";
      Analyzer analyzer = new StopAnalyzer(Version.LUCENE_36);
      TokenStream tokenStream = analyzer.tokenStream(
         LuceneConstants.CONTENTS, new StringReader(text));
      TermAttribute term = tokenStream.addAttribute(TermAttribute.class);
      while(tokenStream.incrementToken()) {
         System.out.print("[" + term.term() + "] ");
      }
   }
}

Running the Program

Once you are done with the creation of the source, you can proceed by compiling and running your program. To do this, keep the LuceneTester.Java file tab active and use either the Run option available in the Eclipse IDE or use Ctrl + F11 to compile and run your LuceneTester application. If your application runs successfully, it will print the following message in Eclipse IDE's console −

[lucene] [simple] [yet] [powerful] [java] [based] [search] [library]

lucene_analysis.htm