com.funambol.common.pim.xvcalendar
Class XVCalendarFormatter

java.lang.Object
  extended by com.funambol.common.pim.vcalendar.BasicVCalendarFormatter
      extended by com.funambol.common.pim.xvcalendar.XVCalendarFormatter

public class XVCalendarFormatter
extends BasicVCalendarFormatter

This class implements a vCalendar 1.0 formatter for JSR75 Event or ToDo objects. This class should be extended if you want to format extended fields, not directly included in the basic JSR75 implementation. In particular the following methods should be implemented:

  • getTZ(PIMItem pimItem);
  • getDaylight(PIMItem pimItem);
  • getTaskAlarmInterval(PIMItem pimItem);
  • isAllDay(PIMItem pimItem);
  • formatAttendees(PIMItem pimItem, OutputStream os);
  • Note: the items alarm property is mapped to the AALARM vCalendar property.


    Field Summary
     
    Fields inherited from class com.funambol.common.pim.vcalendar.BasicVCalendarFormatter
    alarm, defaultCharset, pimUtils
     
    Constructor Summary
    XVCalendarFormatter()
               
     
    Method Summary
    protected  void formatAlarm(PIMItem pimItem, java.io.OutputStream os, boolean allFields)
               
    protected  void formatDateTimeField(java.io.OutputStream os, PIMItem pimItem, int pimField, java.lang.String vCalField, boolean checkAllDay, boolean checkTimezone, boolean allFields)
              Format a date-time field.
    protected  void formatFunambolAllday(PIMItem pimItem, java.io.OutputStream os)
               
    protected  void formatTimezone(PIMItem pimItem, java.io.OutputStream os)
               
    protected  java.util.Vector getDaylight(PIMItem pimItem)
               
    protected  java.lang.String getTZ(PIMItem pimItem)
               
    protected  java.lang.String getVersion()
              Get the version property string (e.g.
     
    Methods inherited from class com.funambol.common.pim.vcalendar.BasicVCalendarFormatter
    encodeField, fixEndDate, format, formatAttendees, formatCategories, formatClass, formatCompleted, formatDTEnd, formatDTStart, formatDue, formatEvent, formatFunambolAllday, formatLocation, formatNote, formatPriority, formatRevision, formatRRule, formatSimpleField, formatStatus, formatSummary, formatToDo, formatUID, getTaskAlarmInterval, isAllDay, isSupported
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Constructor Detail

    XVCalendarFormatter

    public XVCalendarFormatter()
    Method Detail

    getVersion

    protected java.lang.String getVersion()
    Description copied from class: BasicVCalendarFormatter
    Get the version property string (e.g. VERSION:1.0)

    Specified by:
    getVersion in class BasicVCalendarFormatter
    Returns:

    formatAlarm

    protected void formatAlarm(PIMItem pimItem,
                               java.io.OutputStream os,
                               boolean allFields)
                        throws PIMException
    Specified by:
    formatAlarm in class BasicVCalendarFormatter
    Throws:
    PIMException

    formatTimezone

    protected void formatTimezone(PIMItem pimItem,
                                  java.io.OutputStream os)
                           throws PIMException
    Specified by:
    formatTimezone in class BasicVCalendarFormatter
    Throws:
    PIMException

    formatDateTimeField

    protected void formatDateTimeField(java.io.OutputStream os,
                                       PIMItem pimItem,
                                       int pimField,
                                       java.lang.String vCalField,
                                       boolean checkAllDay,
                                       boolean checkTimezone,
                                       boolean allFields)
                                throws PIMException
    Description copied from class: BasicVCalendarFormatter
    Format a date-time field.

    Specified by:
    formatDateTimeField in class BasicVCalendarFormatter
    Parameters:
    os - The output stream to print the field in.
    pimItem - The PIMItem
    pimField - The pim field index.
    vCalField - The vCalendar field name
    checkAllDay - Check whether the allday property shall be updated
    checkTimezone - Check whether the TZID param shall be added (only for iCalendar implementations)
    Throws:
    PIMException

    formatFunambolAllday

    protected void formatFunambolAllday(PIMItem pimItem,
                                        java.io.OutputStream os)
                                 throws PIMException
    Throws:
    PIMException

    getTZ

    protected java.lang.String getTZ(PIMItem pimItem)

    getDaylight

    protected java.util.Vector getDaylight(PIMItem pimItem)


    Copyright © 2001-2009 Funambol.