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:RangeQuery.java 984 2006-01-23 14:18:33 -0500 (Mon, 23 Jan 2006) dmsmith $
21   */
22  package org.crosswire.jsword.index.query;
23  
24  import org.crosswire.jsword.JSMsg;
25  import org.crosswire.jsword.book.BookException;
26  import org.crosswire.jsword.index.Index;
27  import org.crosswire.jsword.passage.Key;
28  import org.crosswire.jsword.passage.NoSuchKeyException;
29  
30  /**
31   * A range query specifies how a range should be included in the search. It
32   * provides a range, a modifier (AND [+] or AND NOT [-]).
33   * 
34   * @see gnu.lgpl.License for license details.<br>
35   *      The copyright to this program is held by it's authors.
36   * @author DM Smith [ dmsmith555 at yahoo dot com]
37   */
38  public class RangeQuery extends AbstractQuery {
39  
40      /**
41       * Construct a query from the range specification.
42       * 
43       * @param theRange
44       */
45      public RangeQuery(String theRange) {
46          super(theRange);
47      }
48  
49      /*
50       * (non-Javadoc)
51       * 
52       * @see
53       * org.crosswire.jsword.index.search.parse.Query#find(org.crosswire.jsword
54       * .index.search.Index)
55       */
56      public Key find(Index index) throws BookException {
57          String range = getQuery();
58          try {
59              return index.getKey(range);
60          } catch (NoSuchKeyException e) {
61              // TRANSLATOR: User error condition: The passage range could not be understood. {0} is a placeholder for the passage.
62              throw new BookException(JSMsg.gettext("Syntax Error: Invalid passage \"{0}\"", range), e);
63          }
64      }
65  }
66