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

java.lang.Object
  org.crosswire.jsword.book.search.parse.PassageRightParamWord

All Implemented Interfaces:

ParamWord, Word

public class PassageRightParamWord
extends Object
implements ParamWord

The end of an escape to specify a passage directly.

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

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Constructor Summary

PassageRightParamWord()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PassageRightParamWord

public PassageRightParamWord()

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

Description copied from interface: ParamWord

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

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