|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jqurantree.orthography.Chapter
public class Chapter
One of the 114 chapters in the Holy Quran, with a unique chapter name and
number. Each chapter (sura in Arabic) is divided into a sequence of
Verses
.
Constructor Summary | |
---|---|
Chapter(int chapterNumber,
ArabicText name,
ArabicText bismillah,
Verse[] verses)
Creates a new chapter, used by JQuranTree when constructing the orthography model. |
Method Summary | |
---|---|
ArabicText |
getBismillah()
Gets the bismillah phrase preceding the chapter's verses. |
int |
getChapterNumber()
Gets the chapter number. |
Location |
getLocation()
Gets the chapter's location. |
ArabicText |
getName()
Gets the name of the chapter as ArabicText . |
int |
getTokenCount()
Gets the number of tokens in the chapter. |
Verse |
getVerse(int verseNumber)
Gets a verse in the chapter by verse number. |
Verse |
getVerse(Location location)
Gets a verse in the chapter by Location reference. |
int |
getVerseCount()
Gets the number of verses in the chapter. |
java.util.Iterator<Verse> |
iterator()
Gets an iterator used to enumerate over all verses in the chapter. |
java.lang.String |
toString()
Gets a string representation of the chapter's location, for example "Chapter 18". |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Chapter(int chapterNumber, ArabicText name, ArabicText bismillah, Verse[] verses)
chapterNumber
- the chapter's number, between 1 and 114 inclusivename
- the chapter's namebismillah
- the bismillah phrase preceding the chapter's verses if
present; null
otherwiseverses
- an array holding the chapter's versesMethod Detail |
---|
public int getChapterNumber()
public Location getLocation()
public ArabicText getName()
ArabicText
.
public ArabicText getBismillah()
null
otherwisepublic Verse getVerse(int verseNumber)
verseNumber
- the verse number, a positive integer
public Verse getVerse(Location location)
Location
reference.
location
- the verse's location
public int getVerseCount()
public int getTokenCount()
public java.util.Iterator<Verse> iterator()
iterator
in interface java.lang.Iterable<Verse>
public java.lang.String toString()
toString
in class java.lang.Object
string
representing the chapter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |