net.fortuna.ical4j.connector.dav

Class CalDavCalendarCollection

java.lang.Object

net.fortuna.ical4j.connector.dav.AbstractDavObjectCollection<net.fortuna.ical4j.model.Calendar>

net.fortuna.ical4j.connector.dav.CalDavCalendarCollection

All Implemented Interfaces:

CalendarCollection, ObjectCollection<net.fortuna.ical4j.model.Calendar>

public class CalDavCalendarCollection
extends AbstractDavObjectCollection<net.fortuna.ical4j.model.Calendar>
implements CalendarCollection

$Id$ Created on 24/02/2008

Author:

Ben

Field Summary

Fields inherited from class net.fortuna.ical4j.connector.dav.AbstractDavObjectCollection

properties

Method Summary

Methods

Modifier and Type	Method and Description
void	addCalendar(net.fortuna.ical4j.model.Calendar calendar) Add a new calendar object in the collection.
net.fortuna.ical4j.model.Calendar[]	doFreeBusyQuery() TODO: implement free-busy-query
net.fortuna.ical4j.model.Calendar	export() Exports the entire collection as a single calendar object.
net.fortuna.ical4j.model.Calendar	getCalendar(String uid) Returns the calendar object with the specified UID.
net.fortuna.ical4j.model.Calendar[]	getCalendars() Deprecated. Use the getEvents() method
String	getColor()
net.fortuna.ical4j.model.Calendar[]	getComponents() Returns all objects stored in the collection.
net.fortuna.ical4j.model.Calendar[]	getComponentsByType(String componentType)
String	getDescription() Provides a human-readable description of the calendar collection.
String	getDisplayName() Human-readable name of the collection.
net.fortuna.ical4j.model.Calendar[]	getEvents()
net.fortuna.ical4j.model.Calendar[]	getEventsForTimePeriod(net.fortuna.ical4j.model.DateTime startTime, net.fortuna.ical4j.model.DateTime endTime) Get a list of calendar objects of VEVENT type for a specific time period.
Integer	getMaxAttendeesPerInstance() Provides a numeric value indicating the maximum number of ATTENDEE properties in any instance of a calendar object resource stored in a calendar collection.
String	getMaxDateTime() Provides a DATE-TIME value indicating the latest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.
Integer	getMaxInstances() Provides a numeric value indicating the maximum number of recurrence instances that a calendar object resource stored in a calendar collection can generate.
long	getMaxResourceSize() Provides a numeric value indicating the maximum size of a resource in octets that the server is willing to accept when a calendar object resource is stored in a calendar collection.
String	getMinDateTime() Provides a DATE-TIME value indicating the earliest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.
net.fortuna.ical4j.model.Calendar[]	getObjectsByFilter(Element filter, Element calData) Returns a list of calendar objects by calling a REPORT method with a filter.
net.fortuna.ical4j.model.Calendar[]	getObjectsByMultiget(ArrayList<URI> hrefs, Element calData) TODO: implement calendar-multiget to fetch objects based on href
int	getOrder()
String[]	getSupportedComponentTypes() Get the list of calendar components (VEVENT, VTODO, etc.) that this collection supports.
net.fortuna.ical4j.model.Calendar[]	getTasks()
net.fortuna.ical4j.model.Calendar	getTimeZone() The CALDAV:calendar-timezone property is used to specify the time zone the server should rely on to resolve "date" values and "date with local time" values (i.e., floating time) to "date with UTC time" values.
void	merge(net.fortuna.ical4j.model.Calendar calendar) Merges the specified calendar object with this collecton.
static org.apache.jackrabbit.webdav.property.DavPropertyNameSet	propertiesForFetch()
net.fortuna.ical4j.model.Calendar	removeCalendar(String uid)
String	toString()
void	updateCalendar(net.fortuna.ical4j.model.Calendar calendar) Update a calendar object in the collection.
void	writeCalendarOnServer(net.fortuna.ical4j.model.Calendar calendar, boolean isNew)

Methods inherited from class net.fortuna.ical4j.connector.dav.AbstractDavObjectCollection

collectionsFromResponse, delete, exists, getId, getOwnerHref, getOwnerName, getPath, getProperty, getQuotaAvailableBytes, getQuotaUsedBytes, getResourceTypes, getStore, getSupportedMediaTypes, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.connector.CalendarCollection

getSupportedMediaTypes

Method Detail

getCalendars

@Deprecated
public net.fortuna.ical4j.model.Calendar[] getCalendars()

Deprecated. Use the getEvents() method

Returns:

an array of calendar objects

See Also:

net.fortuna.ical4j.connector.CalendarCollection#getCalendars()

getEvents

public net.fortuna.ical4j.model.Calendar[] getEvents()

Returns:

and array of calendar objects

getTasks

public net.fortuna.ical4j.model.Calendar[] getTasks()

Returns:

and array of calendar objects

getComponentsByType

public net.fortuna.ical4j.model.Calendar[] getComponentsByType(String componentType)

Parameters:

componentType - the type of component

Returns:

and array of calendar objects

getDescription

public String getDescription()

Provides a human-readable description of the calendar collection.

Specified by:

getDescription in interface ObjectCollection<net.fortuna.ical4j.model.Calendar>

Returns:

the collection description

getDisplayName

public String getDisplayName()

Human-readable name of the collection.

Specified by:

getDisplayName in interface ObjectCollection<net.fortuna.ical4j.model.Calendar>

Returns:

the collection name

getMaxAttendeesPerInstance

public Integer getMaxAttendeesPerInstance()

Provides a numeric value indicating the maximum number of ATTENDEE properties in any instance of a calendar object resource stored in a calendar collection.

Specified by:

getMaxAttendeesPerInstance in interface CalendarCollection

Returns:

a numeric value indicating the maximum number of ATTENDEE properties in any instance of a calendar object resource stored in a calendar collection.

getMaxDateTime

public String getMaxDateTime()

Provides a DATE-TIME value indicating the latest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.

Specified by:

getMaxDateTime in interface CalendarCollection

Returns:

a DATE-TIME value indicating the latest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.

getMaxInstances

public Integer getMaxInstances()

Provides a numeric value indicating the maximum number of recurrence instances that a calendar object resource stored in a calendar collection can generate.

Specified by:

getMaxInstances in interface CalendarCollection

Returns:

a numeric value indicating the maximum number of recurrence instances that a calendar object resource stored in a calendar collection can generate.

getMaxResourceSize

public long getMaxResourceSize()

Provides a numeric value indicating the maximum size of a resource in octets that the server is willing to accept when a calendar object resource is stored in a calendar collection. 0 = no limits.

Specified by:

getMaxResourceSize in interface CalendarCollection

Returns:

a numeric value indicating the maximum size of a resource in octets that the server is willing to accept when a calendar object resource is stored in a calendar collection.

getMinDateTime

public String getMinDateTime()

Provides a DATE-TIME value indicating the earliest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.

Specified by:

getMinDateTime in interface CalendarCollection

Returns:

a DATE-TIME value indicating the earliest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.

getSupportedComponentTypes

public String[] getSupportedComponentTypes()

Get the list of calendar components (VEVENT, VTODO, etc.) that this collection supports.

Specified by:

getSupportedComponentTypes in interface CalendarCollection

Returns:

an array of component names indicating the type of components supported by the collection.

getTimeZone

public net.fortuna.ical4j.model.Calendar getTimeZone()

The CALDAV:calendar-timezone property is used to specify the time zone the server should rely on to resolve "date" values and "date with local time" values (i.e., floating time) to "date with UTC time" values.

Specified by:

getTimeZone in interface CalendarCollection

Returns:

an iCalendar object with exactly one VTIMEZONE component.

getColor

public String getColor()

getOrder

public int getOrder()

addCalendar

public void addCalendar(net.fortuna.ical4j.model.Calendar calendar)
                 throws ObjectStoreException,
                        net.fortuna.ical4j.model.ConstraintViolationException

Add a new calendar object in the collection. Creation will be done on the server right away.

Specified by:

addCalendar in interface CalendarCollection

Parameters:

calendar - a calendar object instance to be added to the collection

Throws:

ObjectStoreException - when an unexpected error occurs (implementation-specific)

net.fortuna.ical4j.model.ConstraintViolationException - if the specified calendar has no single unique identifier (UID)

updateCalendar

public void updateCalendar(net.fortuna.ical4j.model.Calendar calendar)
                    throws ObjectStoreException,
                           net.fortuna.ical4j.model.ConstraintViolationException

Update a calendar object in the collection. Update will be send to the server right away.

Parameters:

calendar -

Throws:

ObjectStoreException

net.fortuna.ical4j.model.ConstraintViolationException

writeCalendarOnServer

public void writeCalendarOnServer(net.fortuna.ical4j.model.Calendar calendar,
                         boolean isNew)
                           throws ObjectStoreException,
                                  net.fortuna.ical4j.model.ConstraintViolationException

Throws:

ObjectStoreException

net.fortuna.ical4j.model.ConstraintViolationException

getCalendar

public net.fortuna.ical4j.model.Calendar getCalendar(String uid)

Returns the calendar object with the specified UID.

Specified by:

getCalendar in interface CalendarCollection

Parameters:

uid - the UID associated with the returned calendar

Returns:

a calendar object or null if no calendar with the specified UID exists

removeCalendar

public net.fortuna.ical4j.model.Calendar removeCalendar(String uid)
                                                 throws FailedOperationException,
                                                        ObjectStoreException

Specified by:

removeCalendar in interface CalendarCollection

Parameters:

uid - the UID of the calendar to remove

Returns:

the calendar that was successfully removed from the collection

Throws:

ObjectStoreException - where an unexpected error occurs

FailedOperationException

merge

public final void merge(net.fortuna.ical4j.model.Calendar calendar)
                 throws FailedOperationException,
                        ObjectStoreException

Merges the specified calendar object with this collecton. This is done by decomposing the calendar object into a set of objects per unique identifier (UID) and adding these objects to the collection.

Specified by:

merge in interface CalendarCollection

Parameters:

calendar - a calendar object instance to merge into the collection

Throws:

FailedOperationException - where the merge operation fails

ObjectStoreException

export

public net.fortuna.ical4j.model.Calendar export()
                                         throws ObjectStoreException

Exports the entire collection as a single calendar object.

Specified by:

export in interface CalendarCollection

Returns:

a calendar object instance that contains all calendars in the collection

Throws:

ObjectStoreException - where an unexpected error occurs

getComponents

public net.fortuna.ical4j.model.Calendar[] getComponents()
                                                  throws ObjectStoreException

Returns all objects stored in the collection.

Specified by:

getComponents in interface ObjectCollection<net.fortuna.ical4j.model.Calendar>

Returns:

an array of collection objects

Throws:

ObjectStoreException - where an unexpected error occurs

getEventsForTimePeriod

public net.fortuna.ical4j.model.Calendar[] getEventsForTimePeriod(net.fortuna.ical4j.model.DateTime startTime,
                                                         net.fortuna.ical4j.model.DateTime endTime)
                                                           throws IOException,
                                                                  org.apache.jackrabbit.webdav.DavException,
                                                                  ParserConfigurationException,
                                                                  net.fortuna.ical4j.data.ParserException

Get a list of calendar objects of VEVENT type for a specific time period.

Parameters:

startTime -

endTime -

Returns:

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

ParserConfigurationException

net.fortuna.ical4j.data.ParserException

getObjectsByFilter

public net.fortuna.ical4j.model.Calendar[] getObjectsByFilter(Element filter,
                                                     Element calData)
                                                       throws IOException,
                                                              org.apache.jackrabbit.webdav.DavException,
                                                              ParserConfigurationException,
                                                              net.fortuna.ical4j.data.ParserException

Returns a list of calendar objects by calling a REPORT method with a filter. You must pass a XML element as the argument, the element must contain the filter. For example, if you wish to filter objects to only get VEVENT objects you can build a filter like this: org.w3c.dom.Element calData = DomUtil.createElement(document, CalDavConstants.PROPERTY_CALENDAR_DATA, CalDavConstants.CALDAV_NAMESPACE); org.w3c.dom.Element calFilter = DomUtil.createElement(document, CalDavConstants.PROPERTY_COMP_FILTER, CalDavConstants.CALDAV_NAMESPACE); calFilter.setAttribute(CalDavConstants.ATTRIBUTE_NAME, Calendar.VCALENDAR); org.w3c.dom.Element eventFilter = DomUtil.createElement(document, CalDavConstants.PROPERTY_COMP_FILTER, CalDavConstants.CALDAV_NAMESPACE); eventFilter.setAttribute(CalDavConstants.ATTRIBUTE_NAME, Component.VEVENT); calFilter.appendChild(eventFilter); collection.getObjectsByFilter(calFilter); Check the examples in rfc4791

Parameters:

filter -

Returns:

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

ParserConfigurationException

net.fortuna.ical4j.data.ParserException

getObjectsByMultiget

public net.fortuna.ical4j.model.Calendar[] getObjectsByMultiget(ArrayList<URI> hrefs,
                                                       Element calData)
                                                         throws IOException,
                                                                org.apache.jackrabbit.webdav.DavException,
                                                                ParserConfigurationException,
                                                                net.fortuna.ical4j.data.ParserException

TODO: implement calendar-multiget to fetch objects based on href

Parameters:

hrefs -

calData -

Returns:

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

ParserConfigurationException

net.fortuna.ical4j.data.ParserException

doFreeBusyQuery

public net.fortuna.ical4j.model.Calendar[] doFreeBusyQuery()

TODO: implement free-busy-query

Returns:

propertiesForFetch

public static final org.apache.jackrabbit.webdav.property.DavPropertyNameSet propertiesForFetch()

toString

public String toString()

Overrides:

toString in class Object