org.mpxj.common

Class TimescaleHelper

java.lang.Object

org.mpxj.common.TimescaleHelper

public final class TimescaleHelper
extends Object

This class contains methods related to creation of timescale data.

Constructor Summary

Constructors

Constructor and Description
TimescaleHelper()

Method Summary

Modifier and Type	Method and Description
List<LocalDateTimeRange>	createTimescale(LocalDateTime startDate, int count, TimescaleUnits units) Given a start date, the number of ranges required, and a timescale unit, this method creates a list of date ranges.
List<LocalDateTimeRange>	createTimescale(LocalDateTime startDate, LocalDateTime endDate, TimescaleUnits units) Given a start date, an end date, and a timescale unit, this method creates a list of date ranges.
DayOfWeek	getWeekStartDay() Retrieves the day on which the week starts.
void	setWeekStartDay(DayOfWeek weekStartDay) Set the day on which the week starts.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimescaleHelper

public TimescaleHelper()

Method Detail

createTimescale

public final List<LocalDateTimeRange> createTimescale(LocalDateTime startDate,
                                                      int count,
                                                      TimescaleUnits units)

Given a start date, the number of ranges required, and a timescale unit, this method creates a list of date ranges. For example, if "Months" is selected as the timescale units, this method will create a list of ranges, each one representing a month. The number of entries in the list is determined by the count.

Each of these date ranges is equivalent one of the columns displayed by MS Project when viewing data with a "timescale" at the top of the page.

Note: that the ranges returned by this method are "half open". So for time t to be within a range the following must be true: start <= t < end.

Note: the first range start date will be aligned as follows based on the requested units: MINUTES: first second of the supplied minute, HOURS: first minute of the supplied hour, DAYS: midnight on the supplied start date, WEEKS: midnight on the week start day before the supplied start date, THIRDS_OF_MONTHS: midnight on the first day of the supplied month, MONTHS: midnight on the first day of the supplied month, QUARTERS: midnight on the first day of the quarter containing the supplied date, HALF_YEARS: midnight on the first day of the half year containing the supplied date, YEARS: midnight on the 1st of January in the year containing the supplied date.

Parameters:

startDate - start date

count - number of ranges required

units - units to be represented by each range

Returns:

list of ranges

createTimescale

public final List<LocalDateTimeRange> createTimescale(LocalDateTime startDate,
                                                      LocalDateTime endDate,
                                                      TimescaleUnits units)

Given a start date, an end date, and a timescale unit, this method creates a list of date ranges. For example, if "Months" is selected as the timescale units, this method will create a list of ranges, each one representing a month. The number of entries in the will be sufficient to ensure that the supplied end date falls within the final range.

Each of these date ranges is equivalent one of the columns displayed by MS Project when viewing data with a "timescale" at the top of the page.

Note: that the ranges returned by this method are "half open". So for time t to be within a range the following must be true: start <= t < end.

Note: the first range start date will be aligned as follows based on the requested units: MINUTES: first second of the supplied minute, HOURS: first minute of the supplied hour, DAYS: midnight on the supplied start date, WEEKS: midnight on the week start day before the supplied start date, THIRDS_OF_MONTHS: midnight on the first day of the supplied month, MONTHS: midnight on the first day of the supplied month, QUARTERS: midnight on the first day of the quarter containing the supplied date, HALF_YEARS: midnight on the first day of the half year containing the supplied date, YEARS: midnight on the 1st of January in the year containing the supplied date.

Parameters:

startDate - start date

endDate - end date

units - units to be represented by each range

Returns:

list of ranges

setWeekStartDay

public void setWeekStartDay(DayOfWeek weekStartDay)

Set the day on which the week starts. Defaults to Calendar.MONDAY.

Parameters:

weekStartDay - week start day

getWeekStartDay

public DayOfWeek getWeekStartDay()

Retrieves the day on which the week starts.

Returns:

week start day