net.sf.mpxj.primavera.ProjectCalendarHelper 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).

There is a newer version: 13.8.0

Show newest version

/*
 * file:       ProjectCalendarHelper.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2023
 * date:       07/03/2023
 */

/*
 * 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.primavera;

import net.sf.mpxj.CalendarType;
import net.sf.mpxj.DateRange;
import net.sf.mpxj.Day;
import net.sf.mpxj.ProjectCalendar;
import net.sf.mpxj.ProjectCalendarHours;
import net.sf.mpxj.common.DateHelper;

/**
 * Common methods to support working with P6 calendars.
 */
final class ProjectCalendarHelper
{
   /**
    * Tries to ensure that the calendar structure we write matches P6's expectations.
    *
    * @param calendar calendar to normalize
    * @return normalized calendar
    */
   public static ProjectCalendar normalizeCalendar(ProjectCalendar calendar)
   {
      ProjectCalendar result = calendar;
      if (calendar.getType() == CalendarType.GLOBAL && calendar.isDerived())
      {
         // Global calendars in P6 are not derived from other calendars.
         // If this calendar is marked as a global calendar, and it is
         // derived then we'll flatten it.
         result = net.sf.mpxj.common.ProjectCalendarHelper.createTemporaryFlattenedCalendar(calendar);
      }
      return result;
   }

   /**
    * Ensure that a calendar has some working time. If it does not,
    * update the calendar using default values.
    *
    * @param calendar calendar to check
    */
   public static void ensureWorkingTime(ProjectCalendar calendar)
   {
      // Check for working time
      boolean hasWorkingTime = false;
      for (Day day : Day.values())
      {
         ProjectCalendarHours hours = calendar.getCalendarHours(day);
         hasWorkingTime = hours != null && !hours.isEmpty();
         if (hasWorkingTime)
         {
            break;
         }
      }

      if (!hasWorkingTime)
      {
         // if there is not DaysOfWeek data, Primavera seems to default to Mon-Fri, 8:00-16:00
         DateRange defaultHourRange = getDefaultCalendarHours();
         for (Day day : Day.values())
         {
            ProjectCalendarHours hours = calendar.addCalendarHours(day);
            if (day != Day.SATURDAY && day != Day.SUNDAY)
            {
               calendar.setWorkingDay(day, true);
               hours.add(defaultHourRange);
            }
            else
            {
               calendar.setWorkingDay(day, false);
            }
         }
      }
   }

   /**
    * Create a new DareRange instance containing the default calendar hours used by P6.
    *
    * @return default calendar hours
    */
   public static DateRange getDefaultCalendarHours()
   {
      return new DateRange(DateHelper.getTime(8, 0), DateHelper.getTime(16, 0));
   }
}