Package io.goobi.viewer.model.cms.itemfunctionality

Class TocFunctionality

java.lang.Object

io.goobi.viewer.model.cms.itemfunctionality.TocFunctionality

All Implemented Interfaces:

Functionality

public class TocFunctionality
extends Object
implements Functionality

CMS item functionality that displays a table of contents for a specified record.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
TocFunctionality(TocFunctionality blueprint)	Creates a new TocFunctionality instance.
TocFunctionality(String pi)	Creates a new TocFunctionality instance.

Method Summary

Modifier and Type	Method	Description
String	getBannerUrl(int width, int height)	getBannerUrl.
StructElement	getDocStruct()	Getter for the field docStruct.
int	getPageNo()	getPageNo.
String	getPi()	Getter for the field pi.
TOC	getToc()	Getter for the field toc.
void	setPageNo(int pageNo)	setPageNo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TocFunctionality

public TocFunctionality(String pi)

Creates a new TocFunctionality instance.

Parameters:

pi - process identifier of the record to display

TocFunctionality

public TocFunctionality(TocFunctionality blueprint)

Creates a new TocFunctionality instance.

Parameters:

blueprint - existing instance to copy state from

Method Details

getBannerUrl

public String getBannerUrl(int width,
 int height)
                    throws IndexUnreachableException,
PresentationException,
DAOException,
ViewerConfigurationException

getBannerUrl.

Parameters:

width - a int.

height - a int.

Returns:

the banner image URL for the current TOC record, scaled to the given dimensions

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getToc

public TOC getToc()
           throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Getter for the field toc.

Returns:

the TOC for the current record, creating it if necessary

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getDocStruct

public StructElement getDocStruct()
                           throws IndexUnreachableException,
PresentationException

Getter for the field docStruct.

Returns:

the top-level StructElement for the current record, creating it if necessary

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

getPi

public String getPi()

Getter for the field pi.

Returns:

the persistent identifier of the record whose table of contents is displayed, or an empty string if none is set

setPageNo

public void setPageNo(int pageNo)

setPageNo.

Specified by:

setPageNo in interface Functionality

Parameters:

pageNo - a int.

getPageNo

public int getPageNo()

getPageNo.

Specified by:

getPageNo in interface Functionality

Returns:

a int.