Source code: com/eireneh/bible/book/StudyBible.java
1
2 package com.eireneh.bible.book;
3
4 import com.eireneh.bible.passage.*;
5
6 /**
7 * A WordStudy is-an extension to Bible that knows about the original
8 * Greek/Hebrew in the form of Strongs numbers, and how these original
9 * words were translated into English (or whatever).
10 * <p>You might expect a method something like <code>
11 * Passage getPassage(String word)</code> for completeness, however
12 * this is a core part of the Bible interface and so redundant here.
13 * <p>The different conversions go something like this:
14 * <pre>
15 * .-------------------.
16 * | -> Strongs -------> Passage ---> PageDOM -\
17 * | / `-._,-' \---> HTML
18 * String .-' `-. /
19 * '-> (Word) --------> Translation ----------/
20 * </pre>
21 * </p>
22 *
23 * <table border='1' cellPadding='3' cellSpacing='0' width="100%">
24 * <tr><td bgColor='white'class='TableRowColor'><font size='-7'>
25 * Distribution Licence:<br />
26 * Project B is free software; you can redistribute it
27 * and/or modify it under the terms of the GNU General Public License,
28 * version 2 as published by the Free Software Foundation.<br />
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
32 * General Public License for more details.<br />
33 * The License is available on the internet
34 * <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, by writing to
35 * <i>Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
36 * MA 02111-1307, USA</i>, Or locally at the Licence link below.<br />
37 * The copyright to this program is held by it's authors.
38 * </font></td></tr></table>
39 * @see <a href='http://www.eireneh.com/servlets/Web'>Project B Home</a>
40 * @see docs.Licence
41 * @author Joe Walker
42 * @version D8.I7.T0
43 * @stereotype role
44 */
45 public interface StudyBible extends Bible
46 {
47 /**
48 * For a given strongs number find a list of references to it
49 * @param number The number to search for
50 * @return The references to the word
51 */
52 public Passage findPassage(Strongs number) throws BookException;
53
54 /**
55 * For a given word find a list words it is translated from
56 * @param word The text to search for
57 * @return The source numbers of that word
58 */
59 public Translation getTranslation(String word) throws BookException;
60
61 /**
62 * For a given number find a list of ways it is translated
63 * @param number The strongs number to search for
64 * @return The words that the number is translated to
65 */
66 public Translation getTranslations(Strongs number) throws BookException;
67 }