net.sf.zekr.engine.page
Interface IPagingData

All Known Implementing Classes:
AbstractQuranPagingData, CustomPagingData, FixedAyaPagingData, HizbQuarterPagingData, JuzPagingData, SuraPagingData

public interface IPagingData

Author:
Mohsen Saboorian

Method Summary
 IQuranPage getContainerPage(IQuranLocation location)
          Find the page containing location.
 java.lang.String getId()
           
 java.lang.String getName()
           
 java.util.List getPageList()
           
 IQuranPage getQuranPage(int pageNum)
           
 void load()
           
 int size()
           
 

Method Detail

getId

java.lang.String getId()

getName

java.lang.String getName()

getQuranPage

IQuranPage getQuranPage(int pageNum)
Parameters:
pageNum - page number (counted from 1)
Returns:
quran page

getPageList

java.util.List getPageList()
Returns:
a list of all IQuranPages

size

int size()

load

void load()
          throws PagingException
Throws:
PagingException

getContainerPage

IQuranPage getContainerPage(IQuranLocation location)
Find the page containing location.

Parameters:
location - Quran location to be looked up in all pages
Returns:
the page containing Quran location