net.sf.mpxj.common

Class ProjectCalendarHelper

java.lang.Object

net.sf.mpxj.common.ProjectCalendarHelper

public final class ProjectCalendarHelper
extends Object

Helper methods for working with ProjectCalendar instances.

Constructor Summary

Constructors

Constructor and Description
ProjectCalendarHelper()

Method Summary

Modifier and Type	Method and Description
static ProjectCalendar	createTemporaryDerivedCalendar(ProjectCalendar baseCalendar, Resource resource) Create a temporary derived calendar.
static ProjectCalendar	createTemporaryFlattenedCalendar(ProjectCalendar calendar) Creates a temporary base calendar by flattening an existing calendar's hierarchy.
static void	mergeExceptions(ProjectCalendar target, List<ProjectCalendarException> sourceExceptions) Merge the supplied list of exceptions into the target calendar.
static void	mergeExceptions(ProjectCalendar target, ProjectCalendar source) Merge exceptions recursively from the source calendar (and any calendars from which it is derived) into the target calendar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectCalendarHelper

public ProjectCalendarHelper()

Method Detail

createTemporaryFlattenedCalendar

public static ProjectCalendar createTemporaryFlattenedCalendar(ProjectCalendar calendar)

Creates a temporary base calendar by flattening an existing calendar's hierarchy. This is typically used to create a calendar which is compatible with Microsoft Project.

Parameters:

calendar - calendar to flatten

Returns:

flattened calendar

createTemporaryDerivedCalendar

public static ProjectCalendar createTemporaryDerivedCalendar(ProjectCalendar baseCalendar,
                                                             Resource resource)

Create a temporary derived calendar. This is typically used to create a calendar which is compatible with Microsoft Project.

Parameters:

baseCalendar - calendar to derive from

resource - link the new calendar to this resource

Returns:

derived calendar

mergeExceptions

public static void mergeExceptions(ProjectCalendar target,
                                   ProjectCalendar source)

Merge exceptions recursively from the source calendar (and any calendars from which it is derived) into the target calendar.

Parameters:

target - target calendar to receive exceptions

source - source calendar from which exceptions are read

mergeExceptions

public static void mergeExceptions(ProjectCalendar target,
                                   List<ProjectCalendarException> sourceExceptions)

Merge the supplied list of exceptions into the target calendar.

Parameters:

target - calendar into which the exceptions are merged

sourceExceptions - exceptions to merge