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

Class CalendarGeneratorImpl

java.lang.Object

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

All Implemented Interfaces:

ICalendarGenerator

Direct Known Subclasses:

PlanningCalendarGeneratorImpl, SchedulerCalendarGeneratorImpl

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 org.osivia.portal.api.internationalization.IBundleFactory	bundleFactory Bundle factory.
protected PeriodTypes	periodType
protected static int	PLANNING_COMPACT_MAX Planning compact maximum number of days to display.

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

DAYS_IN_WEEK

Constructor Summary

Constructors

Constructor and Description
CalendarGeneratorImpl() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	fillCalendarDates(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData, Date forcedSelectedDate) Fill calendar dates.
CalendarData	generateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, PeriodTypes periodType) Generate calendar data.
EventsData	generateEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Generate events 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 Date	getEndDate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, PeriodTypes periodType, Date selectedDate, Date startDate) Get end date.
PeriodTypes	getPeriodType() Get generator period type.
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	setPeriodType(PeriodTypes period) Set generator period type.
void	updateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData, Date selectedDate) Update calendar data.

Methods inherited from class java.lang.Object

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

Field Detail

PLANNING_COMPACT_MAX

protected static final int PLANNING_COMPACT_MAX

Planning compact maximum number of days to display.

See Also:

Constant Field Values

bundleFactory

protected final org.osivia.portal.api.internationalization.IBundleFactory bundleFactory

Bundle factory.

periodType

protected PeriodTypes periodType

Constructor Detail

CalendarGeneratorImpl

public CalendarGeneratorImpl()

Constructor.

Method Detail

getPeriodType

public PeriodTypes getPeriodType()
                          throws javax.portlet.PortletException

Get generator period type.

Specified by:

getPeriodType in interface ICalendarGenerator

Returns:

period type

Throws:

javax.portlet.PortletException

setPeriodType

public void setPeriodType(PeriodTypes period)
                   throws javax.portlet.PortletException

Description copied from interface: ICalendarGenerator

Set generator period type.

Specified by:

setPeriodType in interface ICalendarGenerator

Throws:

javax.portlet.PortletException

generateCalendarData

public CalendarData generateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                         PeriodTypes periodType)
                                  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

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

fillCalendarDates

protected void fillCalendarDates(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                 CalendarData calendarData,
                                 Date forcedSelectedDate)
                          throws javax.portlet.PortletException

Fill calendar dates.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

forcedSelectedDate - forced selected date, may be null

Throws:

javax.portlet.PortletException

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

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

getBundleFactory

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

Getter for bundleFactory.

Returns:

the bundleFactory