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()	Creates a new CalendarBean instance.

Method Summary

Modifier and Type	Method	Description
protected static void	addEmptyDays(CalendarItemWeek currentWeek, LocalDate date)	Add as many CalendarItemDays to 'currentWeek' as there are days between the start of the month and the previous monday.
String	getActualYear()	getActualYear.
List<CalendarItemCentury>	getAllActiveCenturies()	Returns a list of all active centuries.
Integer	getCentury(Integer year)
String	getCenturyLabel(Integer century, Locale locale)
String	getCollection()	Getter for the field collection.
int	getCountOfIncompleteData()	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.
org.apache.solr.client.solrj.response.QueryResponse	getFacetCounts(String... fields)
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)	Generates the data for each month of the selected year.
void	resetAllActiveYears()
void	resetCurrentSelection()	Resets the current selection for year, month and day; also selectYear and collection.
void	resetYears()	resetYears.
String	searchCalendar()	Generates the search string for the calendar search tab.
String	searchCalendar(CalendarItemMonth month, CalendarItemDay day)	searchCalendar.
String	searchForIncompleteData()	Generates the search string for incomplete data.
String	searchTimeline()	Generates the search string for the time line based search tab.
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()

Creates a new CalendarBean instance.

Method Details

setSearchBean

public void setSearchBean(SearchBean searchBean)

Required setter for ManagedProperty injection.

Parameters:

searchBean - the SearchBean instance to inject for testing

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 - newly selected calendar year item

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:

the calendar row containing the month items

setMonthRow

public void setMonthRow(CalendarRow monthRow)

Setter for the field monthRow.

Parameters:

monthRow - calendar row containing month items to set

getCurrentMonth

public CalendarItemMonth getCurrentMonth()

Getter for the field currentMonth.

Returns:

the currently selected calendar month item

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 - newly selected calendar month item

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getCurrentDay

public CalendarItemDay getCurrentDay()

Getter for the field currentDay.

Returns:

the currently selected calendar day item

setCurrentDay

public void setCurrentDay(CalendarItemDay currentDay)

Setter for the field currentDay.

Parameters:

currentDay - newly selected calendar day item

getCurrentDate

public LocalDateTime getCurrentDate()

getCurrentDate.

Returns:

the current date/time with the selected year, month, and day applied

getCurrentDateAsString

public String getCurrentDateAsString()

getDayRow

public CalendarRow getDayRow()

Getter for the field dayRow.

Returns:

the calendar row containing the day items for the currently selected week row

setDayRow

public void setDayRow(CalendarRow dayRow)

Setter for the field dayRow.

Parameters:

dayRow - calendar row containing day items to set

searchTimeline

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

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:

the navigation outcome after executing the timeline search

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

resetCurrentSelection

public void resetCurrentSelection()

Resets the current selection for year, month and day; also selectYear and collection.

resetAllActiveYears

public void resetAllActiveYears()

getAllActiveCenturies

public List<CalendarItemCentury> getAllActiveCenturies()
                                                throws PresentationException,
IndexUnreachableException

Returns a list of all active centuries.

The method searches for the facet of the field 'CENTURY'. If the count of a facet is greater than 0, the century is active.

Returns:

a list of CalendarItemCentury objects for each century that has at least one indexed record

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getCentury

public Integer getCentury(Integer year)

getFacetCounts

public org.apache.solr.client.solrj.response.QueryResponse getFacetCounts(String... fields)
                                                                   throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

resetYears

public void resetYears()
                throws PresentationException,
IndexUnreachableException

resetYears.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

setSelectYear

public void setSelectYear(String selectYear)
                   throws PresentationException,
IndexUnreachableException

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

Parameters:

selectYear - four-digit year string to select and populate calendar data for

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getSelectYear

public String getSelectYear()

Getter for the field selectYear.

Returns:

the four-digit year string currently selected for the calendar view

populateMonthsWithDays

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

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 - four-digit year string to populate data for

collection - Solr collection filter value, or null for all

filterQuery - additional Solr filter query to restrict results

Returns:

a list of CalendarItemMonth objects with day-level hit data populated for the given year

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

addEmptyDays

protected static void addEmptyDays(CalendarItemWeek currentWeek,
 LocalDate date)

Add as many CalendarItemDays to 'currentWeek' as there are days between the start of the month and the previous monday.

Parameters:

currentWeek - Week item to prepend empty days to

date - First day of the month

getMonthList

public List<CalendarItemMonth> getMonthList()

Getter for the field monthList.

Returns:

the list of calendar month items for the currently selected year

getYearEnd

public int getYearEnd()

Getter for the field yearEnd.

Returns:

the last year (inclusive) of the date range displayed in the calendar

getYearStart

public int getYearStart()

Getter for the field yearStart.

Returns:

the first year (inclusive) of the date range displayed in the calendar

setYearEnd

public void setYearEnd(int yearEnd)

Setter for the field yearEnd.

Parameters:

yearEnd - the last year (inclusive) of the date range to display

setYearStart

public void setYearStart(int yearStart)

Setter for the field yearStart.

Parameters:

yearStart - the first year (inclusive) of the date range to display

setCollection

public void setCollection(String collection)
                   throws PresentationException,
IndexUnreachableException

Setter for the field collection.

Parameters:

collection - Solr collection filter value to restrict the calendar view, or null for all collections

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getCollection

public String getCollection()

Getter for the field collection.

Returns:

the Solr collection filter value restricting the calendar view, or null for all collections

searchCalendar

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

searchCalendar.

Parameters:

month - a CalendarItemMonth object.

day - a CalendarItemDay object.

Returns:

the navigation outcome after executing the calendar search for the given month and day

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

searchCalendar

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

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:

the navigation outcome after executing the calendar search

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getCountOfIncompleteData

public int getCountOfIncompleteData()
                             throws PresentationException,
IndexUnreachableException

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:

the currently selected year string, or null if no year has been selected

searchForIncompleteData

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

Generates the search string for incomplete data. The search string will be handed over to the search bean to execute the search.

Returns:

the navigation outcome after executing the search for records with incomplete calendar data

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getCenturyLabel

public String getCenturyLabel(Integer century,
 Locale locale)