|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ParamWord
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. |
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 |
---|
String getWord(IndexSearcher engine) throws BookException
engine
- The controller that can provide access to the search
string or a default Bible.
BookException
- If this action is not appropriateKey getKeyList(IndexSearcher engine) throws BookException
engine
- The controller that can provide access to the search
string or a default Bible.
BookException
- If this action is not appropriate
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |