Package io.goobi.viewer.model.viewer.pageloader

Interface IPageLoader

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractPageLoader, EagerPageLoader, EmptyPageLoader, LeanPageLoader

public interface IPageLoader
extends Serializable

IPageLoader interface.

Method Summary

Modifier and Type	Method	Description
PhysicalElement	findPageForFilename(String filename)
void	generateSelectItems(List<SelectPageItem> dropdownPages, List<SelectPageItem> dropdownFulltext, String urlRoot, boolean recordBelowFulltextThreshold, Locale locale)	generateSelectItems.
int	getFirstPageOrder()	getFirstPageOrder.
int	getLastPageOrder()	getLastPageOrder.
int	getNumPages()	getNumPages.
Long	getOwnerIddocForPage(int pageOrder)	getOwnerIddocForPage.
PhysicalElement	getPage(int pageOrder)	getPage.
PhysicalElement	getPageForFileName(String fileName)	getPageForFileName.

Method Details

getNumPages

int getNumPages()
         throws IndexUnreachableException

getNumPages.

Returns:

a int.

Throws:

IndexUnreachableException - if any.

getFirstPageOrder

int getFirstPageOrder()

getFirstPageOrder.

Returns:

a int.

getLastPageOrder

int getLastPageOrder()

getLastPageOrder.

Returns:

a int.

getPage

PhysicalElement getPage(int pageOrder)
                 throws IndexUnreachableException

getPage.

Parameters:

pageOrder - a int.

Returns:

a PhysicalElement object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

getPageForFileName

PhysicalElement getPageForFileName(String fileName)
                            throws PresentationException,
IndexUnreachableException,
DAOException

getPageForFileName.

Parameters:

fileName - a String object.

Returns:

a PhysicalElement object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getOwnerIddocForPage

Long getOwnerIddocForPage(int pageOrder)
                   throws IndexUnreachableException,
PresentationException

getOwnerIddocForPage.

Parameters:

pageOrder - a int.

Returns:

a Long object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

generateSelectItems

void generateSelectItems(List<SelectPageItem> dropdownPages,
 List<SelectPageItem> dropdownFulltext,
 String urlRoot,
 boolean recordBelowFulltextThreshold,
 Locale locale)
                  throws IndexUnreachableException

generateSelectItems.

Parameters:

dropdownPages - Image view drop-down item

dropdownFulltext - Full-text view drop-down item list

urlRoot - a String object.

locale - a Locale object.

recordBelowFulltextThreshold - a boolean.

Throws:

IndexUnreachableException - if any.

findPageForFilename

PhysicalElement findPageForFilename(String filename)