Source code: com/eireneh/bible/book/raw/Insts.java
1
2 package com.eireneh.bible.book.raw;
3
4 import java.io.IOException;
5 import com.eireneh.bible.passage.Verse;
6
7 /**
8 * Insts is an interface that contains lists of numbers, generally
9 * referring to members of an instance of an Items object.
10 *
11 * <table border='1' cellPadding='3' cellSpacing='0' width="100%">
12 * <tr><td bgColor='white'class='TableRowColor'><font size='-7'>
13 * Distribution Licence:<br />
14 * Project B is free software; you can redistribute it
15 * and/or modify it under the terms of the GNU General Public License,
16 * version 2 as published by the Free Software Foundation.<br />
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.<br />
21 * The License is available on the internet
22 * <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, by writing to
23 * <i>Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
24 * MA 02111-1307, USA</i>, Or locally at the Licence link below.<br />
25 * The copyright to this program is held by it's authors.
26 * </font></td></tr></table>
27 * @see <a href='http://www.eireneh.com/servlets/Web'>Project B Home</a>
28 * @see docs.Licence
29 * @author Joe Walker
30 * @version D0.I0.T0
31 */
32 public interface Insts
33 {
34 /**
35 * Retrieve an ordered list of the words in a Verse
36 * @param verse The Verse to retrieve words for
37 * @return An array of word indexes
38 */
39 public int[] getIndexes(Verse verse);
40
41 /**
42 * Retrieve an ordered list of the words in a Verse
43 * @param verse The Verse to retrieve words for
44 * @return An array of word indexes
45 */
46 public int[] getIndexes(int ordinal);
47
48 /**
49 * Set a list of word indexes as the test to a Verse
50 * @param verse The Verse to set the words for
51 * @param indexes The array of word indexes
52 */
53 public void setIndexes(int[] indexes, Verse verse);
54
55 /**
56 * Ensure that all changes to the index of words are written to disk
57 */
58 public void save() throws IOException;
59 }