Package io.goobi.viewer.managedbeans

Class CalendarBean

java.lang.Object

io.goobi.viewer.managedbeans.CalendarBean

All Implemented Interfaces:

Serializable

@Named
@SessionScoped
public class CalendarBean
extends Object
implements Serializable

This bean provides data for the calendar and time based search entries.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CalendarBean()	Constructor for CalendarBean.

Method Summary

Modifier and Type	Method	Description
String	getActualYear()	getActualYear.
List<CalendarItemYear>	getAllActiveYears()	This method returns a list of all active years.
String	getCollection()	Getter for the field collection.
int	getCountOfIncompleteData()	This method returns the count of all data without a value in YEARMONTHDAY for the selected year.
LocalDateTime	getCurrentDate()	getCurrentDate.
String	getCurrentDateAsString()
CalendarItemDay	getCurrentDay()	Getter for the field currentDay.
CalendarItemMonth	getCurrentMonth()	Getter for the field currentMonth.
CalendarItemYear	getCurrentYear()	Getter for the field currentYear.
CalendarRow	getDayRow()	Getter for the field dayRow.
List<CalendarItemMonth>	getMonthList()	Getter for the field monthList.
CalendarRow	getMonthRow()	Getter for the field monthRow.
int	getRowIndex()	Getter for the field rowIndex.
String	getSelectYear()	Getter for the field selectYear.
int	getYearEnd()	Getter for the field yearEnd.
int	getYearStart()	Getter for the field yearStart.
static List<CalendarItemMonth>	populateMonthsWithDays(String selectYear, String collection, String filterQuery)	This method generates the data for each month of the selected year.
void	resetAllActiveYears()
void	resetCurrentSelection()	This method resets the current selection for year, month and day; also selectYear and collection.
void	resetYears()	resetYears.
String	searchCalendar()	This method generates the search string for the calendar search tab.
String	searchCalendar(CalendarItemMonth month, CalendarItemDay day)	searchCalendar.
String	searchForIncompleteData()	This method generates the search string for incomplete data.
String	searchTimeline()	This method generates the search string for the time line based search tab.
void	selectYearListener()	Forwards to the URL containing the selected year.
void	setCollection(String collection)	Setter for the field collection.
void	setCurrentDay(CalendarItemDay currentDay)	Setter for the field currentDay.
void	setCurrentMonth(CalendarItemMonth currentMonth)	Set a new value for month.
void	setCurrentYear(CalendarItemYear currentYear)	Set a new value for year.
void	setDayRow(CalendarRow dayRow)	Setter for the field dayRow.
void	setMonthRow(CalendarRow monthRow)	Setter for the field monthRow.
void	setRowIndex(int rowIndex)	Setter for the field rowIndex.
void	setSearchBean(SearchBean searchBean)	Required setter for ManagedProperty injection
void	setSelectYear(String selectYear)	Select a year.
void	setYearEnd(int yearEnd)	Setter for the field yearEnd.
void	setYearStart(int yearStart)	Setter for the field yearStart.

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarBean

public CalendarBean()

Constructor for CalendarBean.

Method Details

setSearchBean

public void setSearchBean(SearchBean searchBean)

Required setter for ManagedProperty injection

Parameters:

searchBean - the searchBean to set

getCurrentYear

public CalendarItemYear getCurrentYear()

Getter for the field currentYear.

Returns:

selected year

setCurrentYear

public void setCurrentYear(CalendarItemYear currentYear)
                    throws PresentationException,
IndexUnreachableException

Set a new value for year. If the selected year is the same as the old selection, the data will be unselected. Otherwise the new data will be generated.

Parameters:

currentYear - a CalendarItemYear object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getRowIndex

public int getRowIndex()

Getter for the field rowIndex.

Returns:

a int.

setRowIndex

public void setRowIndex(int rowIndex)

Setter for the field rowIndex.

Parameters:

rowIndex - a int.

getMonthRow

public CalendarRow getMonthRow()

Getter for the field monthRow.

Returns:

a CalendarRow object.

setMonthRow

public void setMonthRow(CalendarRow monthRow)

Setter for the field monthRow.

Parameters:

monthRow - a CalendarRow object.

getCurrentMonth

public CalendarItemMonth getCurrentMonth()

Getter for the field currentMonth.

Returns:

a CalendarItemMonth object.

setCurrentMonth

public void setCurrentMonth(CalendarItemMonth currentMonth)
                     throws PresentationException,
IndexUnreachableException

Set a new value for month. If the selected month is the same as the old selection, the month and day will be unselected. Otherwise the data for the month gets generated.

Parameters:

currentMonth - a CalendarItemMonth object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getCurrentDay

public CalendarItemDay getCurrentDay()

Getter for the field currentDay.

Returns:

a CalendarItemDay object.

setCurrentDay

public void setCurrentDay(CalendarItemDay currentDay)

Setter for the field currentDay.

Parameters:

currentDay - a CalendarItemDay object.

getCurrentDate

public LocalDateTime getCurrentDate()

getCurrentDate.

Returns:

a LocalDateTime object.

getCurrentDateAsString

public String getCurrentDateAsString()

getDayRow

public CalendarRow getDayRow()

Getter for the field dayRow.

Returns:

the dayRow

setDayRow

public void setDayRow(CalendarRow dayRow)

Setter for the field dayRow.

Parameters:

dayRow - the dayRow to set

searchTimeline

public String searchTimeline()
                      throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

This method generates the search string for the time line based search tab. The search string will be handed over to the search bean to execute the search.

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

resetCurrentSelection

public void resetCurrentSelection()

This method resets the current selection for year, month and day; also selectYear and collection.

resetAllActiveYears

public void resetAllActiveYears()

getAllActiveYears

public List<CalendarItemYear> getAllActiveYears()
                                         throws PresentationException,
IndexUnreachableException

This method returns a list of all active years.
The method searches for the facet of the field 'YEAR'. If the count of a facet is greater than 0, the year is active.

Returns:

a List object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

resetYears

public void resetYears()
                throws PresentationException,
IndexUnreachableException

resetYears.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

setSelectYear

public void setSelectYear(String selectYear)
                   throws PresentationException,
IndexUnreachableException,
IOException

Select a year. If the new value differs from the old one, the data for the new value gets generated.

Parameters:

selectYear - the selectYear to set

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

IOException

selectYearListener

public void selectYearListener()

Forwards to the URL containing the selected year.

getSelectYear

public String getSelectYear()

Getter for the field selectYear.

Returns:

the selectYear

populateMonthsWithDays

public static List<CalendarItemMonth> populateMonthsWithDays(String selectYear,
 String collection,
 String filterQuery)
                                                      throws PresentationException,
IndexUnreachableException

This method generates the data for each month of the selected year.
It runs a facet search for YEARMONTH and YEARMONTHDAY for the current year. For each day of the year, the method checks if the count of the field YEARMONTHDAY is greater than 0. If this is the case, the day is an active element, otherwise it has no hits.

Parameters:

selectYear - a String object.

collection - a String object.

filterQuery - a String object.

Returns:

a List object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getMonthList

public List<CalendarItemMonth> getMonthList()

Getter for the field monthList.

Returns:

the monthList

getYearEnd

public int getYearEnd()

Getter for the field yearEnd.

Returns:

the yearEnd

getYearStart

public int getYearStart()

Getter for the field yearStart.

Returns:

the yearStart

setYearEnd

public void setYearEnd(int yearEnd)

Setter for the field yearEnd.

Parameters:

yearEnd - the yearEnd to set

setYearStart

public void setYearStart(int yearStart)

Setter for the field yearStart.

Parameters:

yearStart - the yearStart to set

setCollection

public void setCollection(String collection)
                   throws PresentationException,
IndexUnreachableException

Setter for the field collection.

Parameters:

collection - the collection to set

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getCollection

public String getCollection()

Getter for the field collection.

Returns:

the collection

searchCalendar

public String searchCalendar(CalendarItemMonth month,
 CalendarItemDay day)
                      throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

searchCalendar.

Parameters:

month - a CalendarItemMonth object.

day - a CalendarItemDay object.

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

searchCalendar

public String searchCalendar()
                      throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

This method generates the search string for the calendar search tab. The search string will be handed over to the search bean to execute the search.

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getCountOfIncompleteData

public int getCountOfIncompleteData()
                             throws PresentationException,
IndexUnreachableException

This method returns the count of all data without a value in YEARMONTHDAY for the selected year.

Returns:

a int.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getActualYear

public String getActualYear()

getActualYear.

Returns:

a String object.

searchForIncompleteData

public String searchForIncompleteData()
                               throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

This method generates the search string for incomplete data. The search string will be handed over to the search bean to execute the search.

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.