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

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

All Implemented Interfaces:

CommandWord, ParamWord, Word

public class DefaultWord
extends Object
implements ParamWord, CommandWord

The Search Word for a Word to search for. This is the default if no other Words match.

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

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Field Summary

private String

text The word that we represent

Constructor Summary

DefaultWord(String text)
Create a the default rule with the (presumably) Bible word that formed part of the original search string

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.
String	toString()
void	updatePassage(IndexSearcher engine, Key key) Alter a Passage in whatever manner is appropriate for this command.

Methods inherited from class java.lang.Object

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

Field Detail

text

private String text

The word that we represent

Constructor Detail

DefaultWord

public DefaultWord(String text)

Create a the default rule with the (presumably) Bible word that formed part of the original search string

Parameters:

text - The word to search (or otherwise) for

Method Detail

getWord

public String getWord(IndexSearcher engine)

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

toString

public String toString()

Overrides:

toString in class Object

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

updatePassage

public void updatePassage(IndexSearcher engine,
                          Key key)
                   throws BookException

Description copied from interface: CommandWord

Alter a Passage in whatever manner is appropriate for this command. For example the "~" command does something like this: ref.blur(engine.elements.next.getWord); The "&" command looks like this: ref.addAll(engine.elements.next.getPassage);

Specified by:

updatePassage in interface CommandWord

Parameters:

engine - The controller that can provide access to the search string or a default Bible.

key - The Passage to alter (if necessary)

Throws:

BookException