org.crosswire.jsword.book.search.parse
Class StartsParamWord

java.lang.Object
  extended by org.crosswire.jsword.book.search.parse.StartsParamWord
All Implemented Interfaces:
ParamWord, Word

public class StartsParamWord
extends Object
implements ParamWord

The Search Word for a Word to search for.

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: StartsParamWord.java,v 1.11 2005/03/06 20:21:47 dmsmith Exp $
Author:
Joe Walker [joe at eireneh dot com]
See Also:
Licence

Field Summary
private  Thesaurus thesaurus
          The source of thesaurus data
 
Constructor Summary
StartsParamWord()
          Default ctor
 
Method Summary
 Key getKeyList(IndexSearcher engine)
          WARNING the return from this method is a PassageTally which is not a 100% match for the Passage interface.
 String getWord(IndexSearcher engine)
          Get a word for something else to word on.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

thesaurus

private Thesaurus thesaurus
The source of thesaurus data

Constructor Detail

StartsParamWord

public StartsParamWord()
                throws InstantiationException
Default ctor

Throws:
InstantiationException
Method Detail

getWord

public String getWord(IndexSearcher engine)
               throws BookException
Description copied from interface: ParamWord
Get a word for something else to word on.

Specified by:
getWord in interface ParamWord
Parameters:
engine - The controller that can provide access to the search string or a default Bible.
Returns:
The requested text
Throws:
BookException - If this action is not appropriate

getKeyList

public Key getKeyList(IndexSearcher engine)
               throws BookException
WARNING the return from this method is a PassageTally which is not a 100% match for the Passage interface. Maybe this needs to be fixed somehow.

Specified by:
getKeyList in interface ParamWord
Parameters:
engine - The controller that can provide access to the search string or a default Bible.
Returns:
A Passage relevant to this command
Throws:
BookException - If this action is not appropriate
See Also:
ParamWord.getKeyList(org.crosswire.jsword.book.search.parse.IndexSearcher)

Copyright ? 2003-2004