1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: IndexManager.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.jsword.index;
23  
24  import java.net.URI;
25  
26  import org.crosswire.jsword.book.Book;
27  import org.crosswire.jsword.book.BookException;
28  
29  /**
30   * Manages the life-cycle of an Index.
31   * 
32   * @see gnu.lgpl.License for license details.<br>
33   *      The copyright to this program is held by it's authors.
34   * @author Joe Walker [joe at eireneh dot com]
35   */
36  public interface IndexManager {
37      /**
38       * Detects if index data has been stored for this Bible already
39       */
40      boolean isIndexed(Book book);
41  
42      /**
43       * Create a new Searcher.
44       */
45      Index getIndex(Book book) throws BookException;
46  
47      /**
48       * Read from the given source version to generate ourselves. On completion
49       * of this method the index should be usable.
50       */
51      void scheduleIndexCreation(Book book);
52  
53      /**
54       * We have downloaded a search index to a zip file. It should be installed
55       * from here.
56       * 
57       * @param book
58       *            The book that we downloaded an index for
59       * @param tempDest
60       *            The URI of a zip file to install
61       */
62      void installDownloadedIndex(Book book, URI tempDest) throws BookException;
63  
64      /**
65       * Tidy up after yourself and remove all the files that make up any indexes
66       * you created.
67       */
68      void deleteIndex(Book book) throws BookException;
69  }
70