| Searcher.java |
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: Searcher.java 1966 2009-10-30 01:15:14Z dmsmith $
21 */
22 package org.crosswire.jsword.index.search;
23
24 import org.crosswire.jsword.book.BookException;
25 import org.crosswire.jsword.index.Index;
26 import org.crosswire.jsword.index.query.Query;
27 import org.crosswire.jsword.passage.Key;
28
29 /**
30 * The central interface to all searching.
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 Searcher {
37 /**
38 * Setup the index that this parser can use to do word level searches
39 *
40 * @param index
41 * The Index to query for words
42 */
43 void init(Index index);
44
45 /**
46 * Take a search request and decipher it into a Passage.
47 *
48 * @param request
49 * The request
50 * @return The matching verses
51 */
52 Key search(SearchRequest request) throws BookException;
53
54 /**
55 * Take a search request and decipher it into a Passage.
56 *
57 * @param request
58 * The request
59 * @return The matching verses
60 */
61 Key search(Query request) throws BookException;
62 }
63