net.sf.zekr.common.resource
Class SuraProperties

java.lang.Object
  extended by net.sf.zekr.common.resource.SuraProperties

public class SuraProperties
extends java.lang.Object

This class holds attributes of a sura of the Holy Quran.

Author:
Mohsen Saboorian

Constructor Summary
SuraProperties()
           
 
Method Summary
 int getAyaCount()
           
 java.lang.String getEnglishT13N()
           
 java.lang.String getEnglishTrans()
           
 int getIndex()
           
 java.lang.String getLocalizedT13N()
           
 java.lang.String getLocalizedTrans()
           
 java.lang.String getName()
           
 boolean isMadani()
           
 void setAyaCount(int ayaCount)
           
 void setEnglishT13N(java.lang.String englishT13N)
          Set English transliteration of sura name.
 void setEnglishTrans(java.lang.String englishName)
          Set English translation of sura name.
 void setIndex(int index)
           
 void setMadani(boolean madani)
           
 void setName(java.lang.String name)
          Set Arabic sura name.
 java.lang.String toText()
          There are currently 5 modes to show sura name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SuraProperties

public SuraProperties()
Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)
Set Arabic sura name.

Parameters:
name -

getEnglishTrans

public java.lang.String getEnglishTrans()

setEnglishTrans

public void setEnglishTrans(java.lang.String englishName)
Set English translation of sura name.

Parameters:
englishName -

getEnglishT13N

public java.lang.String getEnglishT13N()

setEnglishT13N

public void setEnglishT13N(java.lang.String englishT13N)
Set English transliteration of sura name.

Parameters:
englishT13N -

getLocalizedTrans

public java.lang.String getLocalizedTrans()

getLocalizedT13N

public java.lang.String getLocalizedT13N()

getAyaCount

public int getAyaCount()

setAyaCount

public void setAyaCount(int ayaCount)

isMadani

public boolean isMadani()
Returns:
true if sura is Madani or (otherwise) false if it is Makki

setMadani

public void setMadani(boolean madani)

getIndex

public int getIndex()
Returns:
absolute sura number (counted from 1)

setIndex

public void setIndex(int index)

toText

public java.lang.String toText()
There are currently 5 modes to show sura name. These modes are specified in Zekr configuration properties under view.sura.name property.
  1. QuranPropertiesNaming.SURA_NAME_ARABIC
  2. QuranPropertiesNaming.SURA_NAME_ENGLISH_T9N
  3. QuranPropertiesNaming.SURA_NAME_ENGLISH_T13N
  4. QuranPropertiesNaming.SURA_NAME_T9N
  5. QuranPropertiesNaming.SURA_NAME_T13N

Returns:
the sura name, in the format specified by view.sura.name properties.