org.crosswire.jsword.book.search.parse
Interface ParamWord

All Superinterfaces:

Word

All Known Implementing Classes:

DefaultWord, GrammarParamWord, PassageLeftParamWord, PassageRightParamWord, PhraseParamWord, StartsParamWord, SubLeftParamWord, SubRightParamWord

public interface ParamWord
extends Word

A ParamWord extends Word to provide more information to a CommandWord. This will either be in the form of a String or in the form of a Passage (from a search) ParamWords are used by CommandWords that alter the final Passage.

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: ParamWord.java,v 1.7 2004/09/29 22:21:23 joe Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Method Summary

Key	getKeyList(IndexSearcher engine) Get a Passage or throw-up if that is not appropriate for this Word.
String	getWord(IndexSearcher engine) Get a word for something else to word on.

Method Detail

getWord

String getWord(IndexSearcher engine)
               throws BookException

Get a word for something else to word on.

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

Key getKeyList(IndexSearcher engine)
               throws BookException

Get a Passage or throw-up if that is not appropriate for this Word.

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