Lucene - Primeiro Aplicativo

Neste capítulo, aprenderemos a programação real com Lucene Framework. Antes de começar a escrever seu primeiro exemplo usando a estrutura Lucene, você deve se certificar de que configurou seu ambiente Lucene corretamente, conforme explicado em Lucene - tutorial Configuração de Ambiente . É recomendável que você tenha o conhecimento prático do Eclipse IDE.

Vamos agora continuar escrevendo um aplicativo de pesquisa simples que imprimirá o número de resultados de pesquisa encontrados. Também veremos a lista de índices criados durante este processo.

Etapa 1 - Criar projeto Java

A primeira etapa é criar um projeto Java simples usando Eclipse IDE. Siga a opçãoFile > New -> Project e finalmente selecione Java Projectassistente da lista de assistentes. Agora nomeie seu projeto comoLuceneFirstApplication usando a janela do assistente da seguinte forma -

Assim que seu projeto for criado com sucesso, você terá o seguinte conteúdo em seu Project Explorer -

Etapa 2 - Adicionar bibliotecas necessárias

Vamos agora adicionar a biblioteca principal do Lucene Framework em nosso projeto. Para fazer isso, clique com o botão direito no nome do seu projetoLuceneFirstApplication e depois siga a seguinte opção disponível no menu de contexto: Build Path -> Configure Build Path para exibir a janela Java Build Path da seguinte maneira -

Agora usa Add External JARs botão disponível em Libraries guia para adicionar o seguinte JAR principal do diretório de instalação Lucene -

lucene-core-3.6.2

Etapa 3 - Criar arquivos de origem

Vamos agora criar arquivos de origem reais sob o LuceneFirstApplicationprojeto. Primeiro, precisamos criar um pacote chamadocom.tutorialspoint.lucene. Para fazer isso, clique com o botão direito em src na seção do explorador de pacotes e siga a opção: New -> Package.

Em seguida, vamos criar LuceneTester.java e outras classes java sob o com.tutorialspoint.lucene pacote.

LuceneConstants.java

Esta classe é usada para fornecer várias constantes a serem usadas no aplicativo de amostra.

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;
}

TextFileFilter.java

Esta classe é usada como um .txt file filtro.

package com.tutorialspoint.lucene;

import java.io.File;
import java.io.FileFilter;

public class TextFileFilter implements FileFilter {

   @Override
   public boolean accept(File pathname) {
      return pathname.getName().toLowerCase().endsWith(".txt");
   }
}

Indexer.java

Esta classe é usada para indexar os dados brutos para que possamos torná-los pesquisáveis usando a biblioteca Lucene.

package com.tutorialspoint.lucene;

import java.io.File;
import java.io.FileFilter;
import java.io.FileReader;
import java.io.IOException;

import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.apache.lucene.util.Version;

public class Indexer {

   private IndexWriter writer;

   public Indexer(String indexDirectoryPath) throws IOException {
      //this directory will contain the indexes
      Directory indexDirectory = 
         FSDirectory.open(new File(indexDirectoryPath));

      //create the indexer
      writer = new IndexWriter(indexDirectory, 
         new StandardAnalyzer(Version.LUCENE_36),true, 
         IndexWriter.MaxFieldLength.UNLIMITED);
   }

   public void close() throws CorruptIndexException, IOException {
      writer.close();
   }

   private Document getDocument(File file) throws IOException {
      Document document = new Document();

      //index file contents
      Field contentField = new Field(LuceneConstants.CONTENTS, new FileReader(file));
      //index file name
      Field fileNameField = new Field(LuceneConstants.FILE_NAME,
         file.getName(),Field.Store.YES,Field.Index.NOT_ANALYZED);
      //index file path
      Field filePathField = new Field(LuceneConstants.FILE_PATH,
         file.getCanonicalPath(),Field.Store.YES,Field.Index.NOT_ANALYZED);

      document.add(contentField);
      document.add(fileNameField);
      document.add(filePathField);

      return document;
   }   

   private void indexFile(File file) throws IOException {
      System.out.println("Indexing "+file.getCanonicalPath());
      Document document = getDocument(file);
      writer.addDocument(document);
   }

   public int createIndex(String dataDirPath, FileFilter filter) 
      throws IOException {
      //get all files in the data directory
      File[] files = new File(dataDirPath).listFiles();

      for (File file : files) {
         if(!file.isDirectory()
            && !file.isHidden()
            && file.exists()
            && file.canRead()
            && filter.accept(file)
         ){
            indexFile(file);
         }
      }
      return writer.numDocs();
   }
}

Searcher.java

Esta classe é usada para pesquisar os índices criados pelo Indexador para pesquisar o conteúdo solicitado.

package com.tutorialspoint.lucene;

import java.io.File;
import java.io.IOException;

import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.queryParser.QueryParser;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.TopDocs;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.apache.lucene.util.Version;

public class Searcher {
	
   IndexSearcher indexSearcher;
   QueryParser queryParser;
   Query query;
   
   public Searcher(String indexDirectoryPath) 
      throws IOException {
      Directory indexDirectory = 
         FSDirectory.open(new File(indexDirectoryPath));
      indexSearcher = new IndexSearcher(indexDirectory);
      queryParser = new QueryParser(Version.LUCENE_36,
         LuceneConstants.CONTENTS,
         new StandardAnalyzer(Version.LUCENE_36));
   }
   
   public TopDocs search( String searchQuery) 
      throws IOException, ParseException {
      query = queryParser.parse(searchQuery);
      return indexSearcher.search(query, LuceneConstants.MAX_SEARCH);
   }

   public Document getDocument(ScoreDoc scoreDoc) 
      throws CorruptIndexException, IOException {
      return indexSearcher.doc(scoreDoc.doc);	
   }

   public void close() throws IOException {
      indexSearcher.close();
   }
}

LuceneTester.java

Esta classe é usada para testar a indexação e capacidade de pesquisa da biblioteca lucene.

package com.tutorialspoint.lucene;

import java.io.IOException;

import org.apache.lucene.document.Document;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.TopDocs;

public class LuceneTester {
	
   String indexDir = "E:\\Lucene\\Index";
   String dataDir = "E:\\Lucene\\Data";
   Indexer indexer;
   Searcher searcher;

   public static void main(String[] args) {
      LuceneTester tester;
      try {
         tester = new LuceneTester();
         tester.createIndex();
         tester.search("Mohan");
      } catch (IOException e) {
         e.printStackTrace();
      } catch (ParseException e) {
         e.printStackTrace();
      }
   }

   private void createIndex() throws IOException {
      indexer = new Indexer(indexDir);
      int numIndexed;
      long startTime = System.currentTimeMillis();	
      numIndexed = indexer.createIndex(dataDir, new TextFileFilter());
      long endTime = System.currentTimeMillis();
      indexer.close();
      System.out.println(numIndexed+" File indexed, time taken: "
         +(endTime-startTime)+" ms");		
   }

   private void search(String searchQuery) throws IOException, ParseException {
      searcher = new Searcher(indexDir);
      long startTime = System.currentTimeMillis();
      TopDocs hits = searcher.search(searchQuery);
      long endTime = System.currentTimeMillis();
   
      System.out.println(hits.totalHits +
         " documents found. Time :" + (endTime - startTime));
      for(ScoreDoc scoreDoc : hits.scoreDocs) {
         Document doc = searcher.getDocument(scoreDoc);
            System.out.println("File: "
            + doc.get(LuceneConstants.FILE_PATH));
      }
      searcher.close();
   }
}

Etapa 4 - Criação do diretório de dados e índice

Usamos 10 arquivos de texto de record1.txt a record10.txt contendo nomes e outros detalhes dos alunos e os colocamos no diretório E:\Lucene\Data. Dados de teste . Um caminho de diretório de índice deve ser criado comoE:\Lucene\Index. Depois de executar este programa, você pode ver a lista de arquivos de índice criados nessa pasta.

Etapa 5 - Executando o programa

Depois de concluir a criação da fonte, dos dados brutos, do diretório de dados e do diretório de índice, você está pronto para compilar e executar seu programa. Para fazer isso, mantenha oLuceneTester.Java guia de arquivo ativa e use o Run opção disponível no IDE Eclipse ou use Ctrl + F11 para compilar e executar seu LuceneTesterinscrição. Se o aplicativo for executado com sucesso, ele imprimirá a seguinte mensagem no console do Eclipse IDE -

Indexing E:\Lucene\Data\record1.txt
Indexing E:\Lucene\Data\record10.txt
Indexing E:\Lucene\Data\record2.txt
Indexing E:\Lucene\Data\record3.txt
Indexing E:\Lucene\Data\record4.txt
Indexing E:\Lucene\Data\record5.txt
Indexing E:\Lucene\Data\record6.txt
Indexing E:\Lucene\Data\record7.txt
Indexing E:\Lucene\Data\record8.txt
Indexing E:\Lucene\Data\record9.txt
10 File indexed, time taken: 109 ms
1 documents found. Time :0
File: E:\Lucene\Data\record4.txt

Depois de executar o programa com sucesso, você terá o seguinte conteúdo em seu index directory -

↰ Previous page Next page ↱