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: Query.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.jsword.index.query;
23  
24  import org.crosswire.jsword.book.BookException;
25  import org.crosswire.jsword.index.Index;
26  import org.crosswire.jsword.passage.Key;
27  
28  /**
29   * The search.Searcher uses a Query to calculate a search result.
30   * 
31   * @see gnu.lgpl.License for license details.<br>
32   *      The copyright to this program is held by it's authors.
33   * @author DM Smith [dmsmith555 at yahoo dot com]
34   */
35  public interface Query {
36      /**
37       * Find the keys that match the query in the index
38       * 
39       * @param index
40       *            the index to search
41       * @return the set of keys that match
42       * @throws BookException
43       */
44      Key find(Index index) throws BookException;
45  }
46