Query.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 or later 5 * as published by the Free Software Foundation. This program is distributed 6 * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even 7 * the 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 * © CrossWire Bible Society, 2005 - 2016 18 * 19 */ 20 package org.crosswire.jsword.index.query; 21 22 import org.crosswire.jsword.book.BookException; 23 import org.crosswire.jsword.index.Index; 24 import org.crosswire.jsword.passage.Key; 25 26 /** 27 * The search.Searcher uses a Query to calculate a search result. 28 * 29 * @see gnu.lgpl.License The GNU Lesser General Public License for details. 30 * @author DM Smith 31 */ 32 public interface Query { 33 /** 34 * Find the keys that match the query in the index 35 * 36 * @param index 37 * the index to search 38 * @return the set of keys that match 39 * @throws BookException 40 */ 41 Key find(Index index) throws BookException; 42 } 43