ParamWord

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> eireneh >> bible >> control >> search >> [ words overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.eireneh.bible.control.search.words.ParamWord

SOURCE |

Download com.eireneh.bible.control.search.words.ParamWord

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.eireneh.bible.control.search.words
Interface ParamWord

All Superinterfaces:: SearchWord

All Known Implementing Classes:: DefaultParamWord, GrammarParamWord, PassageLeftParamWord, PassageRightParamWord, StartsParamWord, SubLeftParamWord, SubRightParamWord

public interface ParamWord
extends SearchWord

A ParamWord extends SearchWord 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:
Project B 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, by writing to Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, Or locally at the Licence link below.
The copyright to this program is held by it's authors.

Method Summary

com.eireneh.bible.passage.Passage getPassage(com.eireneh.bible.control.search.Engine engine)
Get a Passage or throw-up if that is not appropriate for this Word.

java.lang.String getWord(com.eireneh.bible.control.search.Engine engine)
Get a word for something else to word on.

Method Detail

getWord

public java.lang.String getWord(com.eireneh.bible.control.search.Engine engine)
                         throws com.eireneh.bible.control.search.SearchException

Get a word for something else to word on.

getPassage

public com.eireneh.bible.passage.Passage getPassage(com.eireneh.bible.control.search.Engine engine)
                                             throws com.eireneh.bible.control.search.SearchException

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