org.jqurantree.orthography.Document
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class Document
The top-level class in the orthography model, providing a structured representation of the entire text of the Holy Quran. This class provides static methods to access other elements of the orthography model, including chapters, verses and tokens.
| Method Summary | |
|---|---|
static Chapter |
getChapter(int chapterNumber)
Gets a chapter in the document by chapter number. |
static Chapter |
getChapter(Location location)
Gets a chapter in the document by Location reference. |
static int |
getChapterCount()
Gets the number of the chapters in the document. |
static java.lang.Iterable<Chapter> |
getChapters()
Gets an iterator used to enumerate over all chapters in the document. |
static java.lang.String |
getName()
Gets the name of the document. |
static Token |
getToken(int chapterNumber,
int verseNumber,
int tokenNumber)
Gets a token in the document by chapter, verse and token number. |
static Token |
getToken(Location location)
Gets a token in the document by Location reference. |
static int |
getTokenCount()
Gets the number of tokens in the document. |
static java.lang.Iterable<Token> |
getTokens()
Gets an iterator used to enumerate over all tokens in the document. |
static Verse |
getVerse(int chapterNumber,
int verseNumber)
Gets a verse in the document by chapter and verse number. |
static Verse |
getVerse(Location location)
Gets a verse in the document by Location reference. |
static int |
getVerseCount()
Gets the number of verses in the document. |
static java.lang.Iterable<Verse> |
getVerses()
Gets an iterator used to enumerate over all verses in the document. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public static java.lang.String getName()
public static int getChapterCount()
public static int getVerseCount()
public static int getTokenCount()
public static Chapter getChapter(int chapterNumber)
chapterNumber - the chapter number, between 1 and 114 inclusive
public static Chapter getChapter(Location location)
Location reference.
location - the chapter's location
public static java.lang.Iterable<Chapter> getChapters()
public static Verse getVerse(int chapterNumber,
int verseNumber)
chapterNumber - the chapter number, between 1 and 114 inclusiveverseNumber - the verse number, a positive integer
public static Verse getVerse(Location location)
Location reference.
location - the verse's location
public static java.lang.Iterable<Verse> getVerses()
public static Token getToken(int chapterNumber,
int verseNumber,
int tokenNumber)
chapterNumber - the chapter number, between 1 and 114 inclusiveverseNumber - the verse number, a positive integertokenNumber - the tokenNumber, a positive integer
public static Token getToken(Location location)
Location reference.
location - the token's location
public static java.lang.Iterable<Token> getTokens()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||