Lucene - Opções de campo

O campo é a unidade mais importante do processo de indexação. É o objeto real que contém o conteúdo a ser indexado. Quando adicionamos um campo, o Lucene fornece vários controles no campo usando as Opções de campo, que indicam quanto um campo deve ser pesquisável.

Adicionamos Documento (s) contendo Campo (s) a IndexWriter onde IndexWriter é usado para atualizar ou criar índices.

Vamos agora mostrar uma abordagem passo a passo e ajudá-lo a entender as várias opções de campo usando um exemplo básico.

Várias opções de campo

A seguir estão as várias opções de campo -

  • Index.ANALYZED- Neste, primeiro analisamos, depois fazemos a indexação. Isso é usado para indexação de texto normal. O Analyzer dividirá o valor do campo em um fluxo de tokens e cada token pode ser pesquisado separadamente.

  • Index.NOT_ANALYZED- Nisto não analisamos mas sim indexamos. Isso é usado para indexação de texto completa. Por exemplo, nomes de pessoas, URL etc.

  • Index.ANALYZED_NO_NORMS - Esta é uma variante de Index.ANALYZED. O Analyzer dividirá o valor do campo em fluxo de tokens e cada token pode ser pesquisado separadamente. No entanto, os NORMs não são armazenados nos índices. NORMS são usados ​​para impulsionar a pesquisa e isso geralmente acaba consumindo muita memória.

  • Index.Index.NOT_ANALYZED_NO_NORMS - Esta é uma variante de Index.NOT_ANALYZED. A indexação é feita, mas as NORMAS não são armazenadas nos índices.

  • Index.NO - O valor do campo não é pesquisável.

Uso de opções de campo

A seguir estão as diferentes maneiras em que as opções de campo podem ser usadas -

  • Para criar um método para obter um documento Lucene de um arquivo de texto.

  • Para criar vários tipos de campos que são pares de valores-chave contendo chaves como nomes e valores como conteúdos a serem indexados.

  • Para definir o campo a ser analisado ou não. No nosso caso, apenas o conteúdo deve ser analisado, pois pode conter dados como a, am, are, an, etc., que não são necessários nas operações de pesquisa.

  • Para adicionar os campos recém-criados ao objeto de documento e retorná-lo ao método do chamador.

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

Aplicação de exemplo

Para testar o processo de indexação, precisamos criar um teste de aplicativo Lucene.

Degrau Descrição
1

Crie um projeto com um nome LuceneFirstApplication em um pacote com.tutorialspoint.lucene conforme explicado no capítulo Lucene - Primeiro Aplicativo . Você também pode usar o projeto criado no capítulo EJB - Primeiro Aplicativo como tal para este capítulo para entender o processo de indexação.
2

Crie LuceneConstants.java, TextFileFilter.java e Indexer.java conforme explicado no capítulo Lucene - Primeiro Aplicativo . Mantenha o resto dos arquivos inalterados.
3

Crie LuceneTester.java conforme mencionado abaixo.
4

Limpe e construa o aplicativo para garantir que a lógica de negócios esteja funcionando de acordo com os requisitos.

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 filtro de arquivo .txt.

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

LuceneTester.java

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

package com.tutorialspoint.lucene;

import java.io.IOException;

public class LuceneTester {
	
   String indexDir = "E:\\Lucene\\Index";
   String dataDir = "E:\\Lucene\\Data";
   Indexer indexer;
   
   public static void main(String[] args) {
      LuceneTester tester;
      try {
         tester = new LuceneTester();
         tester.createIndex();
      } catch (IOException 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");		
   }
}

Criação de 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.

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ê pode compilar e executar seu programa. Para fazer isso, mantenha oLuceneTester.Java guia de arquivo ativa e use a opção Executar disponível no IDE Eclipse ou use Ctrl + F11 para compilar e executar seu LuceneTesterinscrição. Se seu 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

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