com.funambol.common.pim.xvcalendar
Class XVCalendarParserListener

java.lang.Object
  extended by com.funambol.common.pim.vcalendar.BasicVCalendarParserListener
      extended by com.funambol.common.pim.xvcalendar.XVCalendarParserListener

public class XVCalendarParserListener
extends BasicVCalendarParserListener

This class implements the XVCalendarSyntaxParserListener interface in order to listen all the events during the vCalendar parsing process. Depending on the item type (event or task) it will be filled a JSR75 PIMItem (Event or ToDo), provided through the constructor. XVCalendarParserListener inherits from the BasicVCalendarParserListener which handles the vCalendar (1.0 and 2.0) common properties. The following methods can be overriden in order to handle properties not supported by the JSR75 PIMItem objects:

  • setTZ: set the timezone offset (e.g. +02:00)
  • setDaylight: set the daylight saving properties vector (e.g. TRUE;+02;20090329T020000;20091025T030000;;)
  • setTaskAlarm: set the task alarm property.
  • setAllDay: set the all day property for this item.
  • Note: only the audio alarm (AALARM propery) type is supported, since only one alarm can be set for each PIMItem object.


    Field Summary
     
    Fields inherited from class com.funambol.common.pim.vcalendar.BasicVCalendarParserListener
    alarm, alarmEndRelatedTime, alarmStartRelatedTime, allDay, pimItem, pimList, pimUtils
     
    Constructor Summary
    XVCalendarParserListener(PIMItem pimItem)
              The construtor accepts a PIMItem object that will be populated of all the vCalendar properties
     
    Method Summary
     void addEventProperty(ParserProperty property)
               
     void addProperty(ParserProperty property)
               
     void addToDoProperty(ParserProperty property)
               
     void end()
               
     void endEvent()
               
     void endToDo()
               
    protected  void setAlarm(java.lang.String value)
               
    protected  void setAllDay(boolean allday)
               
    protected  void setCategories(java.lang.String value)
               
    protected  void setDaylight(java.util.Vector daylights)
               
    protected  void setDue(java.lang.String value)
               
    protected  void setEnd(java.lang.String value)
               
    protected  void setRRULE(java.lang.String value)
               
    protected  void setStart(java.lang.String value)
              End listener methods
    protected  void setTaskAlarm(java.lang.String alarm)
               
    protected  void setTZ(java.lang.String value)
              Methods which should be implemented by a subclass in order to store additional data, not supported by JSR75.
     void start()
               
     void startEvent()
               
     void startToDo()
               
     
    Methods inherited from class com.funambol.common.pim.vcalendar.BasicVCalendarParserListener
    addAttendee, getCharset, getClearValue, getEncoding, getParameter, setClass, setEventAlarm, setLocation, setNote, setPriority, setRevision, setStatus, setSummary, setUID
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Constructor Detail

    XVCalendarParserListener

    public XVCalendarParserListener(PIMItem pimItem)
    The construtor accepts a PIMItem object that will be populated of all the vCalendar properties

    Parameters:
    pimItem - the PIMItem object
    Method Detail

    setTZ

    protected void setTZ(java.lang.String value)
    Methods which should be implemented by a subclass in order to store additional data, not supported by JSR75.


    setDaylight

    protected void setDaylight(java.util.Vector daylights)

    setTaskAlarm

    protected void setTaskAlarm(java.lang.String alarm)

    setAllDay

    protected void setAllDay(boolean allday)

    addProperty

    public void addProperty(ParserProperty property)
                     throws ParseException
    Throws:
    ParseException

    addEventProperty

    public void addEventProperty(ParserProperty property)
                          throws ParseException
    Overrides:
    addEventProperty in class BasicVCalendarParserListener
    Throws:
    ParseException

    addToDoProperty

    public void addToDoProperty(ParserProperty property)
                         throws ParseException
    Overrides:
    addToDoProperty in class BasicVCalendarParserListener
    Throws:
    ParseException

    start

    public void start()

    end

    public void end()

    endEvent

    public void endEvent()
                  throws ParseException
    Throws:
    ParseException

    startEvent

    public void startEvent()
                    throws ParseException
    Throws:
    ParseException

    startToDo

    public void startToDo()
                   throws ParseException
    Throws:
    ParseException

    endToDo

    public void endToDo()
                 throws ParseException
    Throws:
    ParseException

    setStart

    protected void setStart(java.lang.String value)
                     throws ParseException
    End listener methods

    Throws:
    ParseException

    setEnd

    protected void setEnd(java.lang.String value)
                   throws ParseException
    Throws:
    ParseException

    setDue

    protected void setDue(java.lang.String value)
                   throws ParseException
    Throws:
    ParseException

    setCategories

    protected void setCategories(java.lang.String value)
                          throws ParseException
    Throws:
    ParseException

    setAlarm

    protected void setAlarm(java.lang.String value)
                     throws ParseException
    Throws:
    ParseException

    setRRULE

    protected void setRRULE(java.lang.String value)
                     throws ParseException
    Throws:
    ParseException


    Copyright © 2001-2009 Funambol.