|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.search.parse.DefaultWord
public class DefaultWord
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. |
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 |
---|
private String text
Constructor Detail |
---|
public DefaultWord(String text)
text
- The word to search (or otherwise) forMethod Detail |
---|
public String getWord(IndexSearcher engine)
ParamWord
getWord
in interface ParamWord
engine
- The controller that can provide access to the search
string or a default Bible.
public String toString()
toString
in class Object
public Key getKeyList(IndexSearcher engine) throws BookException
ParamWord
getKeyList
in interface ParamWord
engine
- The controller that can provide access to the search
string or a default Bible.
BookException
- If this action is not appropriatepublic void updatePassage(IndexSearcher engine, Key key) throws BookException
CommandWord
ref.blur(engine.elements.next.getWord);
The "&" command looks like this:
ref.addAll(engine.elements.next.getPassage);
updatePassage
in interface CommandWord
engine
- The controller that can provide access to the search
string or a default Bible.key
- The Passage to alter (if necessary)
BookException
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |