|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IQuranText
A general interface for Quran text access. All classes/methods who need Quran access should have this
through IQuranText
interface.
This interface is applicable to translation as well as Quran.
Field Summary | |
---|---|
static int |
SIMPLE_MODE
Simple (Imlaaei) Quran text |
static int |
UTHMANI_MODE
Uthmani Quran text |
Method Summary | |
---|---|
java.lang.String |
get(int absoluteAyaNum)
Returns the requested absolute aya. |
java.lang.String |
get(int suraNum,
int ayaNum)
Returns the requested aya. |
java.lang.String |
get(IQuranLocation quranLocation)
Returns the requested aya. |
java.lang.String |
getBismillah(int suraNum)
Return Bismillah (the beginning part of suras). |
java.lang.String[][] |
getFullText()
|
int |
getMode()
Return Quran text mode. This method should only be implemented in subclasses which are aimed for Quran text. |
java.lang.String[] |
getSura(int suraNum)
Returns the requested sura as an array of strings. Note: no range check is performed. |
TranslationData |
getTranslationData()
This method should only be implemented in subclasses which are aimed for Quran translation. |
Field Detail |
---|
static final int UTHMANI_MODE
static final int SIMPLE_MODE
Method Detail |
---|
java.lang.String get(int suraNum, int ayaNum)
suraNum
- the sura number counted from 1ayaNum
- the aya number counted from 1
ayaNum
th aya of the suraNum
th sura of the Quran.java.lang.String get(int absoluteAyaNum)
absoluteAyaNum
- absolute sura number counted from 1
java.lang.String get(IQuranLocation quranLocation)
quranLocation
- sura-aya location of the Quran text to be retrieved
java.lang.String[] getSura(int suraNum)
suraNum
- indicates the sura number (which is counted from 1)
String
array of the sura (#suraNum
) ayas.java.lang.String[][] getFullText()
TranslationData getTranslationData()
java.lang.String getBismillah(int suraNum)
suraNum
- sura number (1-based)
int getMode()
SIMPLE_MODE
or UTHMANI_MODE
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |