|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.zekr.common.resource.AbstractQuranText
net.sf.zekr.engine.translation.TranslationData
public class TranslationData
Field Summary | |
---|---|
java.io.File |
archiveFile
|
java.lang.String |
delimiter
Line delimiter String (each line contains an aya) |
java.lang.String |
direction
Text direction: ltr or rtl |
java.lang.String |
encoding
String encoding |
java.lang.String |
file
Text file name |
java.lang.String |
id
Translation Id. |
java.util.Locale |
locale
Language (locale) Id (e.g. |
java.lang.String |
localizedName
Translation localized name |
java.lang.String |
name
Translation English name |
byte[] |
signature
signature of the text file |
boolean |
verified
|
java.lang.String |
version
descriptor version |
Fields inherited from interface net.sf.zekr.engine.common.Signable |
---|
AUTHENTIC, NOT_AUTHENTIC, UNKNOWN |
Fields inherited from interface net.sf.zekr.common.resource.IQuranText |
---|
SIMPLE_MODE, UTHMANI_MODE |
Constructor Summary | |
---|---|
TranslationData()
|
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 |
getBismillah(int suraNum)
This method always returns the first aya of sura 1 (Al-Fatiha). |
java.lang.String |
getDirection()
|
java.lang.String[][] |
getFullText()
|
java.lang.String |
getId()
|
java.util.Locale |
getLocale()
|
int |
getMode()
Return Quran text mode. This method should only be implemented in subclasses which are aimed for Quran text. |
byte[] |
getSignature()
|
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. |
int |
getVerificationResult()
|
void |
load()
Loads the tranalation data file, if not already loaded. |
java.lang.String |
toString()
|
java.lang.String |
toText()
|
void |
unload()
Unloads the content of translation in order to let Java free more memory. |
boolean |
verify()
Verify the zip archive and close the zip file handle finally. |
Methods inherited from class net.sf.zekr.common.resource.AbstractQuranText |
---|
get |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public java.lang.String id
public java.lang.String name
public java.lang.String localizedName
public java.util.Locale locale
public java.lang.String direction
public java.lang.String encoding
public java.lang.String delimiter
public java.io.File archiveFile
public java.lang.String file
public byte[] signature
public boolean verified
public java.lang.String version
Constructor Detail |
---|
public TranslationData()
Method Detail |
---|
public java.lang.String get(int suraNum, int ayaNum)
IQuranText
get
in interface IQuranText
suraNum
- the sura number counted from 1ayaNum
- the aya number counted from 1
ayaNum
th aya of the suraNum
th sura of the Quran.public java.lang.String[] getSura(int suraNum)
IQuranText
getSura
in interface IQuranText
suraNum
- indicates the sura number (which is counted from 1)
String
array of the sura (#suraNum
) ayas.public java.lang.String[][] getFullText()
getFullText
in interface IQuranText
public java.lang.String toString()
toString
in class java.lang.Object
public void load() throws TranslationException
TranslationException
public void unload()
public boolean verify() throws java.io.IOException
true
if translation verified, false
otherwise.
java.io.IOException
public java.lang.String get(int absoluteAyaNum)
IQuranText
get
in interface IQuranText
absoluteAyaNum
- absolute sura number counted from 1
public TranslationData getTranslationData()
IQuranText
getTranslationData
in interface IQuranText
public java.lang.String getBismillah(int suraNum)
getBismillah
in interface IQuranText
suraNum
- sura number, counted from 1
public java.lang.String toText()
public java.lang.String getDirection()
public java.util.Locale getLocale()
public java.lang.String getId()
public byte[] getSignature()
getSignature
in interface Signable
public int getVerificationResult()
getVerificationResult
in interface Signable
Signable.UNKNOWN
if verification is not done yet, AUTHENTIC
if verification
is done and document is authentic and NOT_AUTHENTIC
if document is not authentic.public int getMode()
IQuranText
getMode
in interface IQuranText
IQuranText.SIMPLE_MODE
or IQuranText.UTHMANI_MODE
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |