org.dmfs.rfc5545.recur.ByWeekNoMonthlyOverlapExpander Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 Marten Gajda 
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.dmfs.rfc5545.recur;

import org.dmfs.rfc5545.Instance;
import org.dmfs.rfc5545.calendarmetrics.CalendarMetrics;
import org.dmfs.rfc5545.recur.RecurrenceRule.Part;


/**
 * A filter expands recurrence rules by week of year. This is allowed for yearly rules only.  If a BYMONTH part is present and any BY*DAY rules follows this
 * filter also expands weeks that overlap the expanded month. That means two subsequent interval sets can include the same week. The BY*DAY filters will take
 * care of filtering those. 
 *
 * @author Marten Gajda
 */
final class ByWeekNoMonthlyOverlapExpander extends ByExpander
{
    /**
     * The week number to let pass or the expand.
     */
    private final int[] mByWeekNo;

    private final int mOriginalWeekDay;


    public ByWeekNoMonthlyOverlapExpander(RecurrenceRule rule, RuleIterator previous, CalendarMetrics calendarTools, long start)
    {
        super(previous, calendarTools, start);

        mByWeekNo = StaticUtils.ListToSortedArray(rule.getByPart(Part.BYWEEKNO));

        // BYWEEKNO expansion preserves the original day of week
        mOriginalWeekDay = calendarTools.getDayOfWeek(Instance.year(start), Instance.month(start), Instance.dayOfMonth(start));
    }


    @Override
    void expand(long instance, long notBefore)
    {
        int year = Instance.year(instance);
        int month = Instance.month(instance);
        int hour = Instance.hour(instance);
        int minute = Instance.minute(instance);
        int second = Instance.second(instance);

        // get the number of weeks in that year
        int yearWeeks = mCalendarMetrics.getWeeksPerYear(year);

        for (int weekOfYear : mByWeekNo)
        {
            int actualWeek = weekOfYear;
            if (weekOfYear < 0)
            {
                actualWeek = yearWeeks + weekOfYear + 1;
            }

            if (actualWeek <= 0 || actualWeek > yearWeeks)
            {
                continue;
            }

            /*
             * Expand instances if the week intersects instance.month. The by-day expansion will filter any instances not in that month.
             */
            int yearDay = mCalendarMetrics.getYearDayOfIsoYear(year, actualWeek, mOriginalWeekDay);
            int monthAndDay = mCalendarMetrics.getMonthAndDayOfYearDay(year, yearDay);
            int newMonth = CalendarMetrics.packedMonth(monthAndDay);
            if (newMonth == month)
            {
                addInstance(Instance.make(year, newMonth, CalendarMetrics.dayOfMonth(monthAndDay), hour, minute,
                        second));
            }
            else
            {
                int firstDayOfWeek = mCalendarMetrics.weekStartInt;

                // check if the first day of this week is still in this month
                int yearDay2 = mCalendarMetrics.getYearDayOfIsoYear(year, actualWeek, firstDayOfWeek);
                if (yearDay2 < 1 || yearDay2 > mCalendarMetrics.getDaysPerYear(year))
                {
                    // definitely a different month
                    continue;
                }

                int monthAndDay2 = mCalendarMetrics.getMonthAndDayOfYearDay(year, yearDay2);
                int newMonth2 = CalendarMetrics.packedMonth(monthAndDay2);
                if (newMonth2 == month)
                {
                    // create a new instance and adjust day values
                    int offset = (mOriginalWeekDay - firstDayOfWeek + 7) % 7;
                    addInstance(Instance.make(year, month, CalendarMetrics.dayOfMonth(monthAndDay2) + offset, hour,
                            minute, second));
                }
                else
                {
                    // check if the last day of this week is still in this month
                    int yearDay3 = mCalendarMetrics.getYearDayOfIsoYear(year, actualWeek, (firstDayOfWeek + 6) % 7);
                    if (yearDay3 < 1 || yearDay3 > mCalendarMetrics.getDaysPerYear(year))
                    {
                        // definitely a different month
                        continue;
                    }
                    int monthAndDay3 = mCalendarMetrics.getMonthAndDayOfYearDay(year, yearDay3);
                    int newMonth3 = CalendarMetrics.packedMonth(monthAndDay3);
                    if (newMonth3 == month)
                    {
                        // create a new instance and adjust day values
                        int offset = (mOriginalWeekDay - firstDayOfWeek - 6) % 7;
                        addInstance(
                                Instance.make(year, month, CalendarMetrics.dayOfMonth(monthAndDay3) + offset, hour,
                                        minute, second));
                    }
                }
            }
        }
    }
}