org.jasig.portlet.calendar.adapter
Class AbstractCalendarAdapter

java.lang.Object
  org.jasig.portlet.calendar.adapter.AbstractCalendarAdapter

All Implemented Interfaces:

ICalendarAdapter

Direct Known Subclasses:

CalDavCalendarAdapter, ConfigurableFileCalendarAdapter, ConfigurableHttpCalendarAdapter, CoursesCalendarAdapter, ExchangeCalendarAdapter

public abstract class AbstractCalendarAdapter
extends Object
implements ICalendarAdapter

AbstractCalendarAdapter provides a base representation of a calendar adapter, without any implementation-specfic functionality.

Version:

$Revision$

Author:

Jen Bourey

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

AbstractCalendarAdapter()

Method Summary

String	getDescriptionKey() Get the message key to be used as the description for this adapter.
List<org.jasig.portlet.form.parameter.Parameter>	getParameters() Get the list of configuration parameters available for this adapter.
String	getTitleKey() Get the message key to be used as the title for this adapter.
protected CalendarEventSet	insertCalendarEventSetIntoCache(net.sf.ehcache.Cache cache, String processorCacheKey, Set<net.fortuna.ical4j.model.component.VEvent> events) Creates a CalendarEventSet from a set of calendar events, inserts it into the cache, and copies the cached element's expiration time into the CalendarEventSet.
protected CalendarEventSet	insertCalendarEventSetIntoCache(net.sf.ehcache.Cache cache, String processorCacheKey, Set<net.fortuna.ical4j.model.component.VEvent> events, int secondsToLive) Creates a CalendarEventSet from a set of calendar events, inserts it into the cache with a specified lifetime, and copies the cached element's expiration time into the CalendarEventSet.
void	setDescriptionKey(String descriptionKey)
void	setParameters(List<org.jasig.portlet.form.parameter.Parameter> parameters)
void	setTitleKey(String titleKey)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portlet.calendar.adapter.ICalendarAdapter

getEvents, getLink

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

AbstractCalendarAdapter

public AbstractCalendarAdapter()

Method Detail

getTitleKey

public String getTitleKey()

Description copied from interface: ICalendarAdapter

Get the message key to be used as the title for this adapter.

Specified by:

getTitleKey in interface ICalendarAdapter

Returns:

getDescriptionKey

public String getDescriptionKey()

Description copied from interface: ICalendarAdapter

Get the message key to be used as the description for this adapter.

Specified by:

getDescriptionKey in interface ICalendarAdapter

Returns:

getParameters

public List<org.jasig.portlet.form.parameter.Parameter> getParameters()

Description copied from interface: ICalendarAdapter

Get the list of configuration parameters available for this adapter.

Specified by:

getParameters in interface ICalendarAdapter

Returns:

setParameters

public void setParameters(List<org.jasig.portlet.form.parameter.Parameter> parameters)

setTitleKey

public void setTitleKey(String titleKey)

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

insertCalendarEventSetIntoCache

protected CalendarEventSet insertCalendarEventSetIntoCache(net.sf.ehcache.Cache cache,
                                                           String processorCacheKey,
                                                           Set<net.fortuna.ical4j.model.component.VEvent> events,
                                                           int secondsToLive)

Creates a CalendarEventSet from a set of calendar events, inserts it into the cache with a specified lifetime, and copies the cached element's expiration time into the CalendarEventSet.

Parameters:

cache - Cache to insert the event set into

processorCacheKey - Key for the event set

events - set of calendar events to cache

secondsToLive - Number of seconds for the event set to survive in cache. < 0 for the default cache value, 0 for unlimited (for consistency with ehCache interface)

Returns:

Cached CalendarEventSet with cache expiration indication

insertCalendarEventSetIntoCache

protected CalendarEventSet insertCalendarEventSetIntoCache(net.sf.ehcache.Cache cache,
                                                           String processorCacheKey,
                                                           Set<net.fortuna.ical4j.model.component.VEvent> events)

Creates a CalendarEventSet from a set of calendar events, inserts it into the cache, and copies the cached element's expiration time into the CalendarEventSet.

Parameters:

cache - Cache to insert the event set into

processorCacheKey - Key for the event set

events - set of calendar events to cache

Returns:

Cached CalendarEventSet with cache expiration indication