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

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

public class AddCommandWord
extends Object
implements CommandWord

Alter the Passage by calling addAll with a Passage grabbed from the next word in the search string.

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: AddCommandWord.java,v 1.8 2004/09/29 22:21:23 joe Exp $
Author:
Joe Walker [joe at eireneh dot com]
See Also:
Licence

Constructor Summary
AddCommandWord()
           
 
Method Summary
 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, toString, wait, wait, wait
 

Constructor Detail

AddCommandWord

public AddCommandWord()
Method Detail

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

Copyright ? 2003-2004