michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import java.text.ParseException;
michael@0: 
michael@0: import net.fortuna.ical4j.model.DateList;
michael@0: import net.fortuna.ical4j.model.Parameter;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.PeriodList;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.TimeZone;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: import net.fortuna.ical4j.model.parameter.Value;
michael@0: import net.fortuna.ical4j.util.ParameterValidator;
michael@0: import net.fortuna.ical4j.util.Strings;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines an RDATE iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.5.3 Recurrence Date/Times
michael@0:  *     
michael@0:  *        Property Name: RDATE
michael@0:  *     
michael@0:  *        Purpose: This property defines the list of date/times for a
michael@0:  *        recurrence set.
michael@0:  *     
michael@0:  *        Value Type: The default value type for this property is DATE-TIME.
michael@0:  *        The value type can be set to DATE or PERIOD.
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard, value data type and time zone
michael@0:  *        identifier property parameters can be specified on this property.
michael@0:  *     
michael@0:  *        Conformance: The property can be specified in &quot;VEVENT&quot;, &quot;VTODO&quot;,
michael@0:  *        &quot;VJOURNAL&quot; or &quot;VTIMEZONE&quot; calendar components.
michael@0:  *     
michael@0:  *        Description: This property can appear along with the &quot;RRULE&quot; property
michael@0:  *        to define an aggregate set of repeating occurrences. When they both
michael@0:  *        appear in an iCalendar object, the recurring events are defined by
michael@0:  *        the union of occurrences defined by both the &quot;RDATE&quot; and &quot;RRULE&quot;.
michael@0:  *     
michael@0:  *        The recurrence dates, if specified, are used in computing the
michael@0:  *        recurrence set. The recurrence set is the complete set of recurrence
michael@0:  *        instances for a calendar component. The recurrence set is generated
michael@0:  *        by considering the initial &quot;DTSTART&quot; property along with the &quot;RRULE&quot;,
michael@0:  *        &quot;RDATE&quot;, &quot;EXDATE&quot; and &quot;EXRULE&quot; properties contained within the
michael@0:  *        iCalendar object. The &quot;DTSTART&quot; property defines the first instance
michael@0:  *        in the recurrence set. Multiple instances of the &quot;RRULE&quot; and &quot;EXRULE&quot;
michael@0:  *        properties can also be specified to define more sophisticated
michael@0:  *        recurrence sets. The final recurrence set is generated by gathering
michael@0:  *        all of the start date/times generated by any of the specified &quot;RRULE&quot;
michael@0:  *        and &quot;RDATE&quot; properties, and excluding any start date/times which fall
michael@0:  *        within the union of start date/times generated by any specified
michael@0:  *        &quot;EXRULE&quot; and &quot;EXDATE&quot; properties. This implies that start date/times
michael@0:  *        within exclusion related properties (i.e., &quot;EXDATE&quot; and &quot;EXRULE&quot;)
michael@0:  *        take precedence over those specified by inclusion properties (i.e.,
michael@0:  *        &quot;RDATE&quot; and &quot;RRULE&quot;). Where duplicate instances are generated by the
michael@0:  *        &quot;RRULE&quot; and &quot;RDATE&quot; properties, only one recurrence is considered.
michael@0:  *        Duplicate instances are ignored.
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          rdate      = &quot;RDATE&quot; rdtparam &quot;:&quot; rdtval *(&quot;,&quot; rdtval) CRLF
michael@0:  *     
michael@0:  *          rdtparam   = *(
michael@0:  *     
michael@0:  *                     ; the following are optional,
michael@0:  *                     ; but MUST NOT occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; &quot;VALUE&quot; &quot;=&quot; (&quot;DATE-TIME&quot;
michael@0:  *                      / &quot;DATE&quot; / &quot;PERIOD&quot;)) /
michael@0:  *                     (&quot;;&quot; tzidparam) /
michael@0:  *     
michael@0:  *                     ; the following is optional,
michael@0:  *                     ; and MAY occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *                     )
michael@0:  *     
michael@0:  *          rdtval     = date-time / date / period
michael@0:  *          ;Value MUST match value type
michael@0:  *     
michael@0:  *        Example: The following are examples of this property:
michael@0:  *     
michael@0:  *          RDATE:19970714T123000Z
michael@0:  *     
michael@0:  *          RDATE;TZID=US-EASTERN:19970714T083000
michael@0:  *     
michael@0:  *          RDATE;VALUE=PERIOD:19960403T020000Z/19960403T040000Z,
michael@0:  *           19960404T010000Z/PT3H
michael@0:  *     
michael@0:  *          RDATE;VALUE=DATE:19970101,19970120,19970217,19970421
michael@0:  *           19970526,19970704,19970901,19971014,19971128,19971129,19971225
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class RDate extends DateListProperty {
michael@0: 
michael@0:     private static final long serialVersionUID = -3320381650013860193L;
michael@0: 
michael@0:     private PeriodList periods;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public RDate() {
michael@0:         super(RDATE, PropertyFactoryImpl.getInstance());
michael@0:         periods = new PeriodList(false, true);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      * @throws ParseException where the specified value string is not a valid date-time/date representation
michael@0:      */
michael@0:     public RDate(final ParameterList aList, final String aValue)
michael@0:             throws ParseException {
michael@0:         super(RDATE, aList, PropertyFactoryImpl.getInstance());
michael@0:         periods = new PeriodList(false, true);
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
michael@0:      * @param dates a list of dates
michael@0:      */
michael@0:     public RDate(final DateList dates) {
michael@0:         super(RDATE, dates, PropertyFactoryImpl.getInstance());
michael@0:         periods = new PeriodList(false, true);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param dates a list of dates
michael@0:      */
michael@0:     public RDate(final ParameterList aList, final DateList dates) {
michael@0:         super(RDATE, aList, dates, PropertyFactoryImpl.getInstance());
michael@0:         periods = new PeriodList(false, true);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor.
michael@0:      * @param periods a list of periods
michael@0:      */
michael@0:     public RDate(final PeriodList periods) {
michael@0:         super(RDATE, new DateList(true), PropertyFactoryImpl.getInstance());
michael@0:         this.periods = periods;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor.
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param periods a list of periods
michael@0:      */
michael@0:     public RDate(final ParameterList aList, final PeriodList periods) {
michael@0:         super(RDATE, aList, new DateList(true), PropertyFactoryImpl.getInstance());
michael@0:         this.periods = periods;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0: 
michael@0:         /*
michael@0:          * ; the following are optional, ; but MUST NOT occur more than once (";" "VALUE" "=" ("DATE-TIME" / "DATE" /
michael@0:          * "PERIOD")) / (";" tzidparam) /
michael@0:          */
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.VALUE,
michael@0:                 getParameters());
michael@0: 
michael@0:         final Parameter valueParam = getParameter(Parameter.VALUE);
michael@0: 
michael@0:         if (valueParam != null && !Value.DATE_TIME.equals(valueParam)
michael@0:                 && !Value.DATE.equals(valueParam)
michael@0:                 && !Value.PERIOD.equals(valueParam)) {
michael@0:             throw new ValidationException("Parameter [" + Parameter.VALUE
michael@0:                     + "] is invalid");
michael@0:         }
michael@0: 
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.TZID,
michael@0:                 getParameters());
michael@0: 
michael@0:         /*
michael@0:          * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0:          */
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the period list.
michael@0:      */
michael@0:     public final PeriodList getPeriods() {
michael@0:         return periods;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setValue(final String aValue) throws ParseException {
michael@0:         if (Value.PERIOD.equals(getParameter(Parameter.VALUE))) {
michael@0:             periods = new PeriodList(aValue);
michael@0:         }
michael@0:         else {
michael@0:             super.setValue(aValue);
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         if (periods != null && !(periods.isEmpty() && periods.isUnmodifiable())) {
michael@0:             return Strings.valueOf(getPeriods());
michael@0:         }
michael@0:         return super.getValue();
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setTimeZone(TimeZone timezone) {
michael@0:         if (periods != null && !(periods.isEmpty() && periods.isUnmodifiable())) {
michael@0:             periods.setTimeZone(timezone);
michael@0:         }
michael@0:         else {
michael@0:             super.setTimeZone(timezone);
michael@0:         }
michael@0:     }
michael@0: }