org.osivia.services.calendar.portlet.service.generator

Class CalendarGeneratorImpl

java.lang.Object

org.osivia.services.calendar.portlet.service.generator.CalendarGeneratorImpl

All Implemented Interfaces:

ICalendarGenerator

Direct Known Subclasses:

DailyCalendarGeneratorImpl, MonthlyCalendarGeneratorImpl, PlanningCalendarGeneratorImpl, WeeklyCalendarGeneratorImpl

public abstract class CalendarGeneratorImpl
extends Object
implements ICalendarGenerator

Calendar generator implementation super-class.

Author:

Cédric Krommenhoek

See Also:

ICalendarGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_SCROLL_TOP_HOUR Default scroll top hour.
protected static int	HOUR_DISPLAY_HEIGHT Hour display height (in px).
protected static int	PLANNING_COMPACT_MAX Planning compact maximum number of days to display.

Fields inherited from interface org.osivia.services.calendar.portlet.service.generator.ICalendarGenerator

DAYS_IN_WEEK

Constructor Summary

Constructors

Constructor and Description
CalendarGeneratorImpl() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
CalendarData	generateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Generate calendar data.
EventsData	generateEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Generate events data.
protected abstract CalendarData	generateSpecializedCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Generate specialized calendar data.
protected abstract EventsData	generateSpecializedEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData, List<Event> events) Generate specialized events data.
org.osivia.portal.api.internationalization.IBundleFactory	getBundleFactory() Getter for bundleFactory.
protected abstract String	getDisplayDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Get display date.
protected Date	getEndDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, PeriodTypes periodType, Date selectedDate, Date startDate) Get end date.
protected float	getEventHours(Calendar startCalendar, Calendar endCalendar, boolean begin, boolean end) Get event hours.
protected Date	getSelectedDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, PeriodTypes periodType) Get selected date.
protected Date	getStartDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, PeriodTypes periodType, Date selectedDate) Get start date.
void	updateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData, Date selectedDate) Update calendar data.
protected abstract void	updateSpecializedCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Update specialized calendar data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.osivia.services.calendar.portlet.service.generator.ICalendarGenerator

getPeriodType

Field Detail

HOUR_DISPLAY_HEIGHT

protected static final int HOUR_DISPLAY_HEIGHT

Hour display height (in px).

See Also:

Constant Field Values

DEFAULT_SCROLL_TOP_HOUR

protected static final int DEFAULT_SCROLL_TOP_HOUR

Default scroll top hour.

See Also:

Constant Field Values

PLANNING_COMPACT_MAX

protected static final int PLANNING_COMPACT_MAX

Planning compact maximum number of days to display.

See Also:

Constant Field Values

Constructor Detail

CalendarGeneratorImpl

public CalendarGeneratorImpl()

Constructor.

Method Detail

generateCalendarData

public CalendarData generateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                  throws javax.portlet.PortletException

Generate calendar data.

Specified by:

generateCalendarData in interface ICalendarGenerator

Parameters:

portalControllerContext - portal controller context

Returns:

calendar data

Throws:

javax.portlet.PortletException

generateSpecializedCalendarData

protected abstract CalendarData generateSpecializedCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                                         throws javax.portlet.PortletException

Generate specialized calendar data.

Parameters:

portalControllerContext - portal controller context

Returns:

specialized calendar data

Throws:

javax.portlet.PortletException

updateCalendarData

public void updateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                      CalendarData calendarData,
                      Date selectedDate)
                        throws javax.portlet.PortletException

Update calendar data.

Specified by:

updateCalendarData in interface ICalendarGenerator

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

selectedDate - selected date, may be null

Throws:

javax.portlet.PortletException

updateSpecializedCalendarData

protected abstract void updateSpecializedCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                 CalendarData calendarData)

Update specialized calendar data.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

getSelectedDate

protected Date getSelectedDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                   PeriodTypes periodType)

Get selected date.

Parameters:

portalControllerContext - portal controller context

periodType - period type

Returns:

selected date

getStartDate

protected Date getStartDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                PeriodTypes periodType,
                Date selectedDate)

Get start date.

Parameters:

portalControllerContext - portal controller context

periodType - period type

selectedDate - selected date

Returns:

start date

getEndDate

protected Date getEndDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
              PeriodTypes periodType,
              Date selectedDate,
              Date startDate)

Get end date.

Parameters:

portalControllerContext - portal controller context

periodType - period type

selectedDate - selected date

startDate - start date

Returns:

end date

getDisplayDate

protected abstract String getDisplayDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                    CalendarData calendarData)
                                  throws javax.portlet.PortletException

Get display date.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

display date

Throws:

javax.portlet.PortletException

generateEventsData

public EventsData generateEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                            CalendarData calendarData)
                              throws javax.portlet.PortletException

Generate events data.

Specified by:

generateEventsData in interface ICalendarGenerator

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

events data

Throws:

javax.portlet.PortletException

generateSpecializedEventsData

protected abstract EventsData generateSpecializedEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                       CalendarData calendarData,
                                       List<Event> events)
                                                     throws javax.portlet.PortletException

Generate specialized events data.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

events - events

Returns:

specialized events data

Throws:

javax.portlet.PortletException

getEventHours

protected float getEventHours(Calendar startCalendar,
                  Calendar endCalendar,
                  boolean begin,
                  boolean end)

Get event hours.

Parameters:

startCalendar - start calendar

endCalendar - end calendar

begin - begin indicator

end - end indicator

Returns:

event hours

getBundleFactory

public org.osivia.portal.api.internationalization.IBundleFactory getBundleFactory()

Getter for bundleFactory.

Returns:

the bundleFactory