net.sf.mpxj.ProjectCalendarWeek Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

The newest version!

/*
 * file:       ProjectCalendarWeek.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2011
 * date:       08/11/2011
 */

/*
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

package net.sf.mpxj;

import java.io.ByteArrayOutputStream;
import java.io.PrintWriter;

import java.time.DayOfWeek;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;

import net.sf.mpxj.common.LocalDateHelper;

/**
 * This class represents a basic working week, with no exceptions.
 */
public class ProjectCalendarWeek extends ProjectCalendarDays implements Comparable
{
   /**
    * Retrieves the data range for which this week is valid.
    * Returns null if this is the default week.
    *
    * @return date range, or null
    */
   public LocalDateRange getDateRange()
   {
      return m_dateRange;
   }

   /**
    * Sets the date range for this week. Set this to null to indicate
    * the default week.
    *
    * @param range date range, or null
    */
   public void setDateRange(LocalDateRange range)
   {
      m_dateRange = range;
   }

   /**
    * Converts this working week into a set of equivalent recurring exceptions.
    * Note that this can't be applied to the default working week.
    *
    * @param earliestStartDate earliest start date for recurring exceptions
    * @param latestFinishDate latest finish date for recurring exceptions
    * @return recurring exceptions equivalent to this working week
    */
   public List convertToRecurringExceptions(LocalDate earliestStartDate, LocalDate latestFinishDate)
   {
      // We can't expand the default week
      if (m_dateRange == null)
      {
         throw new UnsupportedOperationException();
      }

      // Avoid generating exceptions beyond the supplied bounds
      List result = new ArrayList<>();
      LocalDate fromDate = m_dateRange.getStart();
      if (LocalDateHelper.compare(earliestStartDate, fromDate) > 0)
      {
         fromDate = earliestStartDate;
      }

      LocalDate toDate = m_dateRange.getEnd();
      if (LocalDateHelper.compare(toDate, latestFinishDate) > 0)
      {
         toDate = latestFinishDate;
      }

      //
      // Generate a recurring exception for each day
      //
      for (DayOfWeek day : DayOfWeek.values())
      {
         if (getCalendarDayType(day) == DayType.DEFAULT)
         {
            continue;
         }

         RecurringData recurrence = new RecurringData();
         recurrence.setRecurrenceType(RecurrenceType.WEEKLY);
         recurrence.setStartDate(fromDate);
         recurrence.setFinishDate(toDate);
         recurrence.setUseEndDate(true);
         recurrence.setWeeklyDay(day, true);

         ProjectCalendarException ex = new ProjectCalendarException(recurrence);
         ProjectCalendarHours hours = getCalendarHours(day);
         // TODO: for consistency this should never be null, just empty?
         if (hours != null)
         {
            ex.addAll(hours);
         }

         result.add(ex);
      }

      return result;
   }

   @Override public int compareTo(ProjectCalendarWeek o)
   {
      return m_dateRange.getStart().compareTo(o.m_dateRange.getStart());
   }

   @Override public String toString()
   {
      ByteArrayOutputStream os = new ByteArrayOutputStream();
      PrintWriter pw = new PrintWriter(os);
      pw.println("[ProjectCalendarWeek");
      pw.println("   name=" + getName());
      pw.println("   date_range=" + getDateRange());

      for (DayOfWeek day : DayOfWeek.values())
      {
         pw.println("   [Day " + day);
         pw.println("      type=" + getCalendarDayType(day));
         pw.println("      hours=" + getCalendarHours(day));
         pw.println("   ]");
      }

      pw.println("]");
      pw.flush();
      return (os.toString());
   }

   /**
    * Date range for which this week is valid, null if this is the default week.
    */
   private LocalDateRange m_dateRange;
}