package com.laozizhu.search;

import java.util.List;

/**
 * 存儲接口。<br>
 * 負責保存，查詢和刪除數據。
 * 
 * @author 老紫竹(laozizhu.com)
 */
public interface Store {
  /**
   * 保存數據。<br>
   * 根據URL區分，如果不存在則新增，如果存在則更新。
   * 
   * @param item 被保存的數據
   */
  public boolean save(Item item);

  /**
   * 刪除指定URL的數據項。
   * 
   * @param url 被刪除的URL
   */
  public void deleteByUrl(String url);

  /**
   * 搜索指定URL的數據
   * 
   * @param url
   * @return
   */
  public Item searchByUrl(String url);

  /**
   * 搜索指定id的數據
   * 
   * @param id
   * @return
   */
  public Item searchById(int id);

  /**
   * 關鍵字查詢
   * 
   * @param keyword 關鍵字
   * @return 符合條件的數據。
   */
  public SearchResult seach(String keyword, int begin, int number);

  /**
   * 數據優化
   */
  public void optimize();

  /**
   * 根據內部id順序,查找一定數量
   * 
   * @param begin 起始位置，指內部號碼，需要根據前一次返回的最大doc號計算。
   * @param number 數量
   * @return
   */
  public List<Item> findAll(int begin, int number);

  /**
   * 刪除指定內部編號的索引。
   * 
   * @param id
   */
  public void deleteById(int id);
}