Package io.goobi.viewer.model.cms

Class PageList

java.lang.Object

io.goobi.viewer.model.cms.PageList

All Implemented Interfaces:

Iterable<String>

public class PageList
extends Object
implements Iterable<String>

A list of strings with some convenience methods. Each string is either the id of a cmsPage or a pageType name The list may be stored as a single string containing all strings in the list separated by ;

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
PageList()	Constructor for PageList.
PageList(String stringRep)	Constructor for PageList.
PageList(List<Long> pageIds)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getPage()	get the if/pageName of the first page, or an empty string if no pages exist
String	getPage(int index)	getPage.
CMSPage	getPage(String idString)	getPage.
List<String>	getPages()	Getter for the field pages.
SearchInterface	getSearch()	Get the matching SearchInterface for the first listed page.
SearchInterface	getSearch(int pageIndex)	getSearch.
String	getUrl(int pageIndex)	getUrl.
int	hashCode()
boolean	isEmpty()	isEmpty.
Iterator<String>	iterator()
void	setPage(String page)	Sets the pages list to a list containing only the given string
void	setPages(List<String> pages)	Setter for the field pages.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

PageList

public PageList()

Constructor for PageList.

PageList

public PageList(List<Long> pageIds)

PageList

public PageList(String stringRep)

Constructor for PageList.

Parameters:

stringRep - a String object.

Method Details

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPages

public List<String> getPages()

Getter for the field pages.

Returns:

the pages

setPages

public void setPages(List<String> pages)

Setter for the field pages.

Parameters:

pages - the pages to set

getPage

public String getPage()

get the if/pageName of the first page, or an empty string if no pages exist

Returns:

the if/pageName of the first page, or an empty string if no pages exist

getPage

public String getPage(int index)

getPage.

Parameters:

index - a int.

Returns:

a String object.

getSearch

public SearchInterface getSearch()
                          throws NumberFormatException,
DAOException

Get the matching SearchInterface for the first listed page. This is the SearchFunctionality of that page if any exists, or otherwise the SearchBean

Returns:

the matching SearchInterface for the first listed page. This is the SearchFunctionality of that page if any exists, or otherwise the SearchBean

Throws:

NumberFormatException - if any.

DAOException - if any.

getSearch

public SearchInterface getSearch(int pageIndex)
                          throws NumberFormatException,
DAOException

getSearch.

Parameters:

pageIndex - a int.

Returns:

a SearchInterface object.

Throws:

NumberFormatException - if any.

DAOException - if any.

getUrl

public String getUrl(int pageIndex)
              throws NumberFormatException,
DAOException

getUrl.

Parameters:

pageIndex - the index of the desired page in the page list

Returns:

the url of the page at pageIndex, relative to the host url

Throws:

NumberFormatException - if any.

DAOException - if any.

setPage

public void setPage(String page)

Sets the pages list to a list containing only the given string

Parameters:

page - a String object.

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

getPage

public CMSPage getPage(String idString)
                throws DAOException

getPage.

Parameters:

idString - a String object.

Returns:

a CMSPage object.

Throws:

DAOException - if any.

isEmpty

public boolean isEmpty()

isEmpty.

Returns:

a boolean.