net.sf.zekr.engine.page
Class AbstractQuranPagingData

java.lang.Object
  extended by net.sf.zekr.engine.common.LocalizedResource
      extended by net.sf.zekr.engine.page.AbstractQuranPagingData
All Implemented Interfaces:
IPagingData
Direct Known Subclasses:
CustomPagingData, FixedAyaPagingData, HizbQuarterPagingData, JuzPagingData, SuraPagingData

public abstract class AbstractQuranPagingData
extends LocalizedResource
implements IPagingData

Abstract quran paging data.

Author:
Mohsen Saboorian

Field Summary
protected  java.lang.String id
           
protected  java.lang.String name
           
protected  java.util.List pageList
          List of QuranPage items.
 
Fields inherited from class net.sf.zekr.engine.common.LocalizedResource
names
 
Constructor Summary
AbstractQuranPagingData()
           
 
Method Summary
 IQuranPage getContainerPage(IQuranLocation loc)
          Find the page containing location.
 java.lang.String getId()
           
 java.lang.String getName()
           
 java.util.List getPageList()
           
 IQuranPage getQuranPage(int pageNum)
           
 void load()
           
protected  java.lang.String meaning(java.lang.String key)
           
 int size()
           
 java.lang.String toString()
           
 
Methods inherited from class net.sf.zekr.engine.common.LocalizedResource
getLocalizedName, getName, getNames
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

protected java.lang.String id

name

protected java.lang.String name

pageList

protected java.util.List pageList
List of QuranPage items.

Constructor Detail

AbstractQuranPagingData

public AbstractQuranPagingData()
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface IPagingData

getPageList

public java.util.List getPageList()
Specified by:
getPageList in interface IPagingData
Returns:
a list of all IQuranPages

getQuranPage

public IQuranPage getQuranPage(int pageNum)
Specified by:
getQuranPage in interface IPagingData
Parameters:
pageNum - page number (counted from 1)
Returns:
quran page

load

public void load()
          throws PagingException
Specified by:
load in interface IPagingData
Throws:
PagingException

getId

public java.lang.String getId()
Specified by:
getId in interface IPagingData

size

public int size()
Specified by:
size in interface IPagingData

getContainerPage

public IQuranPage getContainerPage(IQuranLocation loc)
Description copied from interface: IPagingData
Find the page containing location.

Specified by:
getContainerPage in interface IPagingData
Parameters:
loc - Quran location to be looked up in all pages
Returns:
the page containing Quran location

meaning

protected java.lang.String meaning(java.lang.String key)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object