Reading Calendar Information

Retrieving Calendar Information

Microsoft Project lets users associate a variety of different calendars with working time, tasks and resources. These features are also available in Aspose.Tasks. This article explains how to retrieve information about which calendars are used in a project. Aspose.Tasks can retrieve calendar information for all versions of Microsoft Project: 2003, 2007, 2010, and 2013.

The CalendarS property exposed by the Project class supports List of Aspose.Tasks.Calendar objects. This property can be used to retrieve the calendar information carried by the project.

To view calendar information in Microsoft Project:

1. Open a project.
2. From the Project menu, select Change Working Time.

The following piece of code retrieves the calendar information from a project.

// For complete examples and data files, please go to https://github.com/aspose-tasks/Aspose.Tasks-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(RetrieveCalendarInfo.class);

long OneSec = 10000000;// microsecond * 10
long OneMin = 60 * OneSec;
long OneHour = 60 * OneMin;

// Create a project reader instance
Project project = new Project(dataDir + "input.mpp");

// Retrieve Calendars Information
CalendarCollection alCals = project.getCalendars();

for (Calendar cal : alCals) {
    if (cal.getName() != null) {
        System.out.println("Calendar UID : " + cal.getUid());
        System.out.println("Calendar Name : " + cal.getName());

        WeekDayCollection alDays = cal.getWeekDays();
        for (WeekDay wd : alDays) {
            double ts = wd.getWorkingTime(); // milliseconds
            double time = ts / (OneHour);
            if (wd.getDayWorking()) {
                System.out.print(wd.getDayType() + ":");
                System.out.print("Working Time:" + time + " Hours");
                System.out.println(", Ticks = " + ts);
            }
        }
    }
}

// Display result of conversion.
System.out.println("Process completed Successfully");

Reading Work Weeks Information from Calendar

Aspose.Tasks for Java API can read Work weeks information from any of the Project’s calendar. The WorkWeek class can be used to achieve this.

// The path to the documents directory.
String dataDir = Utils.getDataDir(ReadWorkWeeks.class);

// Create project instance and access calendar and work weeks collection
Project project = new Project(dataDir + "ReadWorkWeeksInformation.mpp");
Calendar calendar = project.getCalendars().getByUid(3);
WorkWeekCollection collection = calendar.getWorkWeeks();

for (WorkWeek workWeek : collection) {
    // Display work week name, from and to dates
    System.out.println(workWeek.getName());
    System.out.println(workWeek.getFromDate());
    System.out.println(workWeek.getToDate());

    // This data is all about "Details." button you can set special working times
    // for special WeekDay or even make it non-working
    WeekDayCollection weekDays = workWeek.getWeekDays();
    for (WeekDay day : weekDays) {
        // You can further traverse through working times and display these
        WorkingTimeCollection workingTimes = day.getWorkingTimes();
    }
}

Getting Working Hours On or Between Dates

Working hours are typically defined as a range of hours over a day, on specific days of the week. For example, 09:00 – 17:00, Monday to Friday. With Aspose.Tasks for Java, it is possible to calculate the number of working hours that fall on a date, or between two dates. Finding out the number of working dates between two dates help project managers figure out whether there are enough hours to get work done, or if they need to find more resources to complete a task.

Calculating Working Hours

The Calendar class exposes two overloaded methods for finding working hours on or between dates:

• getWorkingHours(Date dt) returns a long data type to hold the working hours on a date passed.
• getWorkingHours(Date startdt, Date enddt) returns a WorkUnit object to define the working hours between two dates.

The following example shows how to find the duration in minutes, hours and days between two dates.

// The path to the documents directory.
String dataDir = Utils.getDataDir(GetWorkingHours.class);

long OneSec = 10000000;//microsecond * 10
long OneMin = 60 * OneSec;
long OneHour = 60 * OneMin;

Project project = new Project(dataDir + "BaselineTask.mpp");
Task task = project.getRootTask().getChildren().getById(1);

Calendar taskCalendar = task.get(Tsk.CALENDAR);

java.util.Calendar calStartDate = java.util.Calendar.getInstance();
calStartDate.setTime(task.get(Tsk.START));

java.util.Calendar calEndDate = java.util.Calendar.getInstance();
calEndDate.setTime(task.get(Tsk.FINISH));

java.util.Calendar tempDate = java.util.Calendar.getInstance();
tempDate = calStartDate;

Resource resource = project.getResources().getById(1);
Calendar resourceCalendar = resource.get(Rsc.CALENDAR);

//TimeSpan timeSpan;
long timeSpan = 0;

//Get Duration in Minutes
double durationInMins = 0;

while (tempDate.before(calEndDate))
{
    if (taskCalendar.isDayWorking(tempDate.getTime()) && resourceCalendar.isDayWorking(tempDate.getTime()))
    {
        timeSpan = (long) taskCalendar.getWorkingHours(tempDate.getTime());
        durationInMins = durationInMins + (timeSpan / OneMin);
    }
    tempDate.add(java.util.Calendar.DATE, 1);
}
tempDate.setTime(task.get(Tsk.START));

//Get Duration in Hours
double durationInHours = 0;

while (tempDate.before(calEndDate))
{
    if (taskCalendar.isDayWorking(tempDate.getTime()) && resourceCalendar.isDayWorking(tempDate.getTime()))
    {
        timeSpan = (long) taskCalendar.getWorkingHours(tempDate.getTime());
        durationInHours = durationInHours + (timeSpan / OneHour);
    }
    tempDate.add(java.util.Calendar.DATE, 1);
}
tempDate.setTime(task.get(Tsk.START));

//Get Duration in Days
double durationInDays = 0;

while (tempDate.before(calEndDate))
{
    if (taskCalendar.isDayWorking(tempDate.getTime()) && resourceCalendar.isDayWorking(tempDate.getTime()))
    {
        timeSpan = (long) taskCalendar.getWorkingHours(tempDate.getTime());
        if ((timeSpan / OneHour) > 0)
            durationInDays = durationInDays + (timeSpan/OneHour/8.0);
    }
    tempDate.add(java.util.Calendar.DATE, 1);
}
tempDate = calStartDate;

System.out.println("Duration in Minutes = " + durationInMins);
System.out.println("Duration in Hours = " + durationInHours);
System.out.println("Duration in Days = " + durationInDays);
System.out.println();