Lucene教學 » Lucene PhraseQuery類

Lucene PhraseQuery類

詞組查詢用於搜尋包含詞條的特定序列的文件。

類宣告

以下是org.apache.lucene.search.PhraseQuery類的宣告：

public class PhraseQuery
   extends Query

類別建構函式

S.N. 建構函式和說明
1 PhraseQuery()
構造一個空的短語查詢。

類方法

S.N. 方法 & 描述
1 void add(Term term) 
增加了一個術語的查詢短語的末端。
2 void add(Term term, int position) 
增加了一個術語的查詢短語的末端。
3 Weight createWeight(Searcher searcher) 
構造一個適當的重量實現這個查詢。
4 boolean equals(Object o) 
返回true如果o為等於這一物件。
5 void extractTerms(Set<Term> queryTerms) 
加上在此查詢到設定的條款發生的所有條款。
6 int[] getPositions() 
返回這個詞組方面的相對位置。
7 int getSlop() 
返回斜率。
8 Term[] getTerms() 
返回這個詞組條款集合。
9 int hashCode() 
返回此物件的雜湊碼值。
10 Query rewrite(IndexReader reader) 
呼叫重新編寫查詢到原始查詢。
11 void setSlop(int s) 
設定了查詢短語中兩個詞之間允許其它詞的數量。
12 String toString(String f) 
列印這個查詢的一個使用者可讀的版本。

方法繼承

這個類從以下類繼承的方法：

  • org.apache.lucene.search.Query

  • java.lang.Object

使用

private void searchUsingPhraseQuery(String[] phrases)
   throws IOException, ParseException{
   searcher = new Searcher(indexDir);
   long startTime = System.currentTimeMillis();

   PhraseQuery query = new PhraseQuery();
   query.setSlop(0);

   for(String word:phrases){
      query.add(new Term(LuceneConstants.FILE_NAME,word));
   }

   //do the search
   TopDocs hits = searcher.search(query);
   long endTime = System.currentTimeMillis();

   System.out.println(hits.totalHits +
      " documents found. Time :" + (endTime - startTime) + "ms");
   for(ScoreDoc scoreDoc : hits.scoreDocs) {
      Document doc = searcher.getDocument(scoreDoc);
      System.out.println("File: "+ doc.get(LuceneConstants.FILE_PATH));
   }
   searcher.close();
}

應用程式範例

讓我們建立一個測試Lucene的應用程式中使用PhraseQuery測試搜尋。

步驟 描述
1 建立下名稱為LuceneFirstApplication的一個專案作為解釋Lucene的應用在包packagecom.yiibai.lucene下，在第一個應用程式的篇章。也可以使用Lucene建立的專案理解搜尋過程。
2 建立LuceneConstants.java和Searcher.java作為Lucene的解釋- 第一應用程式一章。保持其它檔案不變。
3 建立LuceneTester.java如下所述。
4 清理和構建應用程式，以確保業務邏輯按要求工作。

LuceneConstants.java

這個類是用來提供可應用於範例應用程式中使用的各種常數。

package com.yiibai.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;
}

Searcher.java

這個類用來讀取就使用Lucene庫的原始資料，並搜尋資料的索引。

package com.yiibai.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 TopDocs search(Query query) throws IOException, ParseException{
      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

這個類是用來測試Lucene庫的搜尋能力。

package com.yiibai.lucene;

import java.io.IOException;

import org.apache.lucene.document.Document;
import org.apache.lucene.index.Term;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.search.PhraseQuery;
import org.apache.lucene.search.Query;
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";
   Searcher searcher;

   public static void main(String[] args) {
      LuceneTester tester;
      try {
         tester = new LuceneTester();
         String[] phrases = new String[]{"record1.txt"};
         tester.searchUsingPhraseQuery(phrases);
      } catch (IOException e) {
         e.printStackTrace();
      } catch (ParseException e) {
         e.printStackTrace();
      }
   }

   private void searchUsingPhraseQuery(String[] phrases)
      throws IOException, ParseException{
      searcher = new Searcher(indexDir);
      long startTime = System.currentTimeMillis();

      PhraseQuery query = new PhraseQuery();
      query.setSlop(0);

      for(String word:phrases){
         query.add(new Term(LuceneConstants.FILE_NAME,word));
      }

      //do the search
      TopDocs hits = searcher.search(query);
      long endTime = System.currentTimeMillis();

      System.out.println(hits.totalHits +
         " documents found. Time :" + (endTime - startTime) + "ms");
      for(ScoreDoc scoreDoc : hits.scoreDocs) {
         Document doc = searcher.getDocument(scoreDoc);
         System.out.println("File: "+ doc.get(LuceneConstants.FILE_PATH));
      }
      searcher.close();
   }
}

資料和索引目錄的建立

從record1.txt到record10.txt的檔案中包含簡單的名稱以及學生的其他細節，並把它們放在目錄E:LuceneData。這是測試資料。索引目錄路徑應建立為E:LuceneIndex。期間，執行 Lucene索引程式後- 索引過程中，可以看到該檔案夾中建立的索引檔案的列表。

執行程式：

一旦建立源，創造了原始資料，資料目錄，索引目錄和索引完成後，已經準備好這一步是編譯和執行程式。要做到這一點，請LuceneTester.Java檔案索引標籤中使用Eclipse IDE可使用Run選項，或使用Ctrl+ F11來編譯和執行應用程式LuceneTester。如果您的應用程式一切正常，這將在Eclipse IDE的控制台列印以下訊息：

1 documents found. Time :14ms
File: E:LuceneDataecord1.txt