Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.crosswire.jsword.book.search
Interface Searcher

All Known Implementing Classes:
  IndexSearcher

    public interface Searcher

The central interface to all searching.

Distribution Licence: JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA The copyright to this program is held by it's authors.

Version:
  $Id: Searcher.java,v 1.6 2004/10/09 21:45:04 joe Exp $
Author:
  Joe Walker [joe at eireneh dot com]
See Also:
  `Licence`

Method Summary
`void` | `init(Index index)` Setup the index that this parser can use to do word level searches
`Key` | `search(String search)` Take a search string and decipher it into a Passage.

Method Detail

### init

    void init(Index index)

  Setup the index that this parser can use to do word level searches

  Parameters:
    `index` - The Index to query for words

### search

    Key search(String search)
               throws BookException

  Take a search string and decipher it into a Passage.

  Parameters:
    `search` - The string to be searched for
  Returns:
    The matching verses
  Throws:
    `BookException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Copyright ? 2003-2004
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD