Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.eireneh.bible.passage
Interface VerseBase  view VerseBase download VerseBase.java

All Superinterfaces:
java.lang.Cloneable, java.lang.Comparable, PassageConstants, java.io.Serializable
All Known Implementing Classes:
Verse, VerseRange

public interface VerseBase
extends java.lang.Cloneable, java.lang.Comparable, java.io.Serializable, PassageConstants

The base unit that is collected by a 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.

Version:
D9.I9.T7

Field Summary
 
Fields inherited from interface com.eireneh.bible.passage.PassageConstants
ACCURACY_BOOK_CHAPTER, ACCURACY_BOOK_ONLY, ACCURACY_BOOK_VERSE, ACCURACY_CHAPTER_VERSE, ACCURACY_NONE, ACCURACY_VERSE_ONLY, CASE_LOWER, CASE_MIXED, CASE_SENTANCE, CASE_UPPER, CASES, RANGE_ALLOWED_DELIMS, RANGE_PREF_DELIM, REF_ALLOWED_DELIMS, REF_PREF_DELIM, RESTRICT_BOOK, RESTRICT_CHAPTER, RESTRICT_NONE, RESTRICTIONS, VERSE_ALLOWED_DELIMS, VERSE_END_MARK1, VERSE_END_MARK2, VERSE_NUMERIC_BOOK, VERSE_PREF_DELIM1, VERSE_PREF_DELIM2
 
Method Summary
 java.lang.String getName()
          Translate the Passage into a human readable string
 java.lang.String getName(Verse base)
          Translate the Passage into a human readable string, with the assumption that the specified Verse has just been output, so if we are in the same book, we do not need to display the book name, and so on.
 Verse[] toVerseArray()
          Create an array of Verses.
 java.util.Enumeration verseElements()
          Enumerate over the verses in this object.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

public java.lang.String getName()
Translate the Passage into a human readable string


getName

public java.lang.String getName(Verse base)
Translate the Passage into a human readable string, with the assumption that the specified Verse has just been output, so if we are in the same book, we do not need to display the book name, and so on.


toVerseArray

public Verse[] toVerseArray()
Create an array of Verses. See note on verseElements()


verseElements

public java.util.Enumeration verseElements()
Enumerate over the verses in this object. I remember thinking at some stage that I ought to just use one of toVerseArray() and verseElements() and contemplated removing the other one, but didn't make the change. I suspect the newer (and therefore probably better) implementation is going to be further down the file (i.e. this one), and so toVerseArray should not be used anymore. However I can't remember the reasoning behind it other than the possibility of less Object generation if you are not going to itterate over the whole array.