de.uplanet.util

Class CalendarUtil

java.lang.Object

de.uplanet.util.CalendarUtil

@Scriptable
public final class CalendarUtil
extends Object

Version:

$Revision: 133214 $

Method Summary

Modifier and Type	Method and Description
static Date	getAscensionDate(Date p_dt, TimeZone p_tz)
static Date	getAscensionDate(int p_iYear, TimeZone p_tz)
static long	getAscensionDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getAshWednesdayDate(Date p_dt, TimeZone p_tz)
static Date	getAshWednesdayDate(int p_iYear, TimeZone p_tz)
static long	getAshWednesdayDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getCorpusChristiDate(Date p_dt, TimeZone p_tz)
static Date	getCorpusChristiDate(int p_iYear, TimeZone p_tz)
static long	getCorpusChristiDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getEasterDate(Date p_dt, TimeZone p_tz)
static Date	getEasterDate(int p_iYear, TimeZone p_tz)
static long	getEasterDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getEasterMondayDate(Date p_dt, TimeZone p_tz)
static Date	getEasterMondayDate(int p_iYear, TimeZone p_tz)
static long	getEasterMondayDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getGoodFridayDate(Date p_dt, TimeZone p_tz)
static Date	getGoodFridayDate(int p_iYear, TimeZone p_tz)
static long	getGoodFridayDateInMillis(int p_iYear, TimeZone p_tz)
static int	getISO8601WeekNumber(Date p_dt, TimeZone p_tz) Get the week number as defined in DIN 1355/ISO 8601.
static int	getISO8601WeekNumber(int p_iYear, int p_iMonth, int p_iDay) Get the week number as defined in DIN 1355/ISO 8601.
static int	getISO8601WeekStartOffset(int p_iYear, int p_iWeek) Get the offset in days of the first day of the given week, calculated from first of January of the given year.
static long	getLunationNumber(Date p_dt) Get the Brown Lunation Number.
static long	getLunationNumber(long p_lTime) Get the Brown Lunation Number.
static Date	getMaundyThursdayDate(Date p_dt, TimeZone p_tz)
static Date	getMaundyThursdayDate(int p_iYear, TimeZone p_tz)
static long	getMaundyThursdayDateInMillis(int p_iYear, TimeZone p_tz)
static long	getMeeusLunationNumber(Date p_dt) Get the Meeus Lunation Number.
static long	getMeeusLunationNumber(long p_lTime) Get the Meeus Lunation Number.
static long	getNumberOfMidnightsBetween(Date p_dt1, Date p_dt2, TimeZone p_tz) Get the number of midnights between two dates in the give time zone.
static Date	getPenanceDayDate(Date p_dt, TimeZone p_tz)
static Date	getPenanceDayDate(int p_iYear, TimeZone p_tz)
static long	getPenanceDayDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getPentecostDate(Date p_dt, TimeZone p_tz)
static Date	getPentecostDate(int p_iYear, TimeZone p_tz) Same as getWhitSundayDate(int, TimeZone).
static long	getPentecostDateInMillis(int p_iYear, TimeZone p_tz) Same as getWhitSundayDate(int, TimeZone).
static double	getPhaseOfTheMoon(Date p_dt) Get the phase of the moon.
static double	getPhaseOfTheMoon(long p_lTime) Get the phase of the moon.
static int	getQuarter(Date p_dt, TimeZone p_tz) Get the quarter that contains the given date.
static Date	getShroveMondayDate(Date p_dt, TimeZone p_tz)
static Date	getShroveMondayDate(int p_iYear, TimeZone p_tz)
static long	getShroveMondayDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getStartOfQuarter(Date p_dt, TimeZone p_tz) Get the start of the quarter that contains the given date.
static long	getStartOfQuarterInMillis(Date p_dt, TimeZone p_tz) Get the start of the quarter that contains the given date.
static Date	getStartOfWeek(Date p_dt, int p_iFirstDayOfWeek, TimeZone p_tz) Get the start of the week that contains the given date.
static long	getStartOfWeekInMillis(Date p_dt, int p_iFirstDayOfWeek, TimeZone p_tz) Get the start of the week that contains the given date.
static Date	getWhitMondayDate(Date p_dt, TimeZone p_tz)
static Date	getWhitMondayDate(int p_iYear, TimeZone p_tz)
static long	getWhitMondayDateInMillis(int p_iYear, TimeZone p_tz)
static Date	getWhitSundayDate(Date p_dt, TimeZone p_tz)
static Date	getWhitSundayDate(int p_iYear, TimeZone p_tz)
static long	getWhitSundayDateInMillis(int p_iYear, TimeZone p_tz)
static <T extends Calendar> T	modifyCalendar(T p_cal, String p_strRules) Calls modifyCalendar(Calendar, String, boolean) with the third parameter set to false, so that the millisecond field of the calendar is not being touched if the given rules do not specify a rule for the millisecond field.
static <T extends Calendar> T	modifyCalendar(T p_cal, String p_strRules, boolean p_bClearMillis) Modify the given calendar according to the rules specified in the p_strRules parameter.
static Date	modifyDate(Date p_dt, String p_strRules, TimeZone p_tz) Calls modifyDate(Date, String, TimeZone, boolean) with the fourth parameter set to false, so that the millisecond field of the date is not being touched if the given rules do not specify a rule for the millisecond field.
static Date	modifyDate(Date p_dt, String p_strRules, TimeZone p_tz, boolean p_bClearMillis) Modify the given date according to the rules specified in the p_strRules parameter.
static long	modifyDateInMillis(Date p_dt, String p_strRules, TimeZone p_tz) Calls modifyDateInMillis(Date, String, TimeZone, boolean) with the fourth parameter set to false, so that the millisecond field of the date is not being touched if the given rules do not specify a rule for the millisecond field.
static long	modifyDateInMillis(Date p_dt, String p_strRules, TimeZone p_tz, boolean p_bClearMillis) Modify the given date according to the rules specified in the p_strRules parameter.
static void	setStartOfWeek(Calendar p_cal, int p_iFirstDayOfWeek) Set the given calendar to the start of the week.

Methods inherited from class java.lang.Object

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

Method Detail

modifyDate

public static Date modifyDate(Date p_dt,
                              String p_strRules,
                              TimeZone p_tz)

Calls modifyDate(Date, String, TimeZone, boolean) with the fourth parameter set to false, so that the millisecond field of the date is not being touched if the given rules do not specify a rule for the millisecond field.

modifyDate

public static Date modifyDate(Date p_dt,
                              String p_strRules,
                              TimeZone p_tz,
                              boolean p_bClearMillis)

Modify the given date according to the rules specified in the p_strRules parameter.

The rules consist of up to seven rules for each of the calendar fields YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND, and MILLISECOND, in that order, and separated by commas. Each rule specifies either a positive or negative offset (e.g. -1, or +1), or an absolute value for the field (e.g. 15). Other than in the Java Calendar API, the month values are, 1-based, i.e. 1 = January, 2 = February, ...

Example:
+1,1,1,12,30,0,0 means the given date plus one year, the first of January, 12:30:00.0 on the 24-hour clock.

Parameters:

p_dt - The date to be modified.

p_strRules - The rules (must not be null or empty).

p_tz - The time zone to be used.

p_bClearMillis - true if the calendar's millisecond field should be set to zero if the rule does not specify the millisecond field, or false otherwise.

Returns:

The date modified according to the given rules.

Throws:

IllegalArgumentException - If p_strRules is null or empty.

modifyDateInMillis

public static long modifyDateInMillis(Date p_dt,
                                      String p_strRules,
                                      TimeZone p_tz)

Calls modifyDateInMillis(Date, String, TimeZone, boolean) with the fourth parameter set to false, so that the millisecond field of the date is not being touched if the given rules do not specify a rule for the millisecond field.

modifyDateInMillis

public static long modifyDateInMillis(Date p_dt,
                                      String p_strRules,
                                      TimeZone p_tz,
                                      boolean p_bClearMillis)

Modify the given date according to the rules specified in the p_strRules parameter.

The rules consist of up to seven rules for each of the calendar fields YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND, and MILLISECOND, in that order, and separated by commas. Each rule specifies either a positive or negative offset (e.g. -1, or +1), or an absolute value for the field (e.g. 15). Other than in the Java Calendar API, the month values are, 1-based, i.e. 1 = January, 2 = February, ...

Example:
+1,1,1,12,30,0,0 means the given date plus one year, the first of January, 12:30:00.0 on the 24-hour clock.

Parameters:

p_dt - The date to be modified.

p_strRules - The rules (must not be null or empty).

p_tz - The time zone to be used.

p_bClearMillis - true if the calendar's millisecond field should be set to zero if the rule does not specify the millisecond field, or false otherwise.

Returns:

The date in milliseconds since 1970-01-01 00:00:00 UTC, modified according to the given rules.

Throws:

IllegalArgumentException - If p_strRules is null or empty.

modifyCalendar

public static <T extends Calendar> T modifyCalendar(T p_cal,
                                                    String p_strRules)

Calls modifyCalendar(Calendar, String, boolean) with the third parameter set to false, so that the millisecond field of the calendar is not being touched if the given rules do not specify a rule for the millisecond field.

Returns:

The given calendar p_cal.

modifyCalendar

public static <T extends Calendar> T modifyCalendar(T p_cal,
                                                    String p_strRules,
                                                    boolean p_bClearMillis)

Modify the given calendar according to the rules specified in the p_strRules parameter.

The rules consist of up to seven rules for each of the calendar fields YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND, and MILLISECOND, in that order, and separated by commas. Each rule specifies either a positive or negative offset (e.g. -1, or +1), or an absolute value for the field (e.g. 15). Other than in the Java Calendar API, the month values are, 1-based, i.e. 1 = January, 2 = February, ...

Example:
+1,1,1,12,30,0,0 means the given date plus one year, the first of January, 12:30:00.0 on the 24-hour clock.

Parameters:

p_cal - The calendar to be modified.

p_strRules - The rules (must not be null or empty).

p_bClearMillis - true if the calendar's millisecond field should be set to zero if the rule does not specify the millisecond field, or false otherwise.

Returns:

The given calendar p_cal.

Throws:

IllegalArgumentException - If p_strRules is null or empty.

getISO8601WeekNumber

public static int getISO8601WeekNumber(Date p_dt,
                                       TimeZone p_tz)

Get the week number as defined in DIN 1355/ISO 8601.

Parameters:

p_dt - The date.

p_tz - The time zone to be used.

Returns:

The week number as defined in DIN 1355/ISO 8601.

getISO8601WeekNumber

public static int getISO8601WeekNumber(int p_iYear,
                                       int p_iMonth,
                                       int p_iDay)

Get the week number as defined in DIN 1355/ISO 8601.

Parameters:

p_iYear - The year.

p_iMonth - The month (0 for January, ...).

p_iDay - The day of month.

Returns:

The week number as defined in DIN 1355/ISO 8601.

getISO8601WeekStartOffset

public static int getISO8601WeekStartOffset(int p_iYear,
                                            int p_iWeek)

Get the offset in days of the first day of the given week, calculated from first of January of the given year.

Parameters:

p_iYear - The year.

p_iWeek - The week (1 is the first week of the year, 2 the second ..., 0 ist the last week of the year before, ...).

Returns:

The offset in days.

getStartOfWeek

public static Date getStartOfWeek(Date p_dt,
                                  int p_iFirstDayOfWeek,
                                  TimeZone p_tz)

Get the start of the week that contains the given date. Hour, minute, seconds, and fractions of seconds are set to zero.

Parameters:

p_dt - The date.

p_iFirstDayOfWeek - The day the weeks starts with (1 for Sunday, 2 for Monday, ..., 7 for Saturday).

p_tz - The time zone.

Returns:

The date that represents the requested start of the week.

getStartOfWeekInMillis

public static long getStartOfWeekInMillis(Date p_dt,
                                          int p_iFirstDayOfWeek,
                                          TimeZone p_tz)

Get the start of the week that contains the given date. Hour, minute, seconds, and fractions of seconds are set to zero.

Parameters:

p_dt - The date.

p_iFirstDayOfWeek - The day the weeks starts with (1 for Sunday, 2 for Monday, ..., 7 for Saturday).

p_tz - The time zone.

Returns:

The time (in milliseconds since 1970-01-01Z00:00:00Z) that represents the requested start of the week.

Throws:

IllegalArgumentException - If p_iFirstDayOfWeek has an invalid value.

setStartOfWeek

public static void setStartOfWeek(Calendar p_cal,
                                  int p_iFirstDayOfWeek)

Set the given calendar to the start of the week. Hour, minute, seconds, and fractions of seconds are set to zero.

Parameters:

p_cal - The calendar.

p_iFirstDayOfWeek - The day the weeks starts with (1 for Sunday, 2 for Monday, ..., 7 for Saturday).

Throws:

IllegalArgumentException - If p_iFirstDayOfWeek has an invalid value.

Since:

Intrexx 7.0.

getQuarter

public static int getQuarter(Date p_dt,
                             TimeZone p_tz)

Get the quarter that contains the given date.

Parameters:

p_dt - The date.

p_tz - The time zone.

Returns:

The quarter, i.e. either 1, 2, 3, or 4.

Since:

Intrexx 7.0.

getStartOfQuarter

public static Date getStartOfQuarter(Date p_dt,
                                     TimeZone p_tz)

Get the start of the quarter that contains the given date. Hour, minute, seconds, and fractions of seconds are set to zero.

Parameters:

p_dt - The date.

p_tz - The time zone.

Returns:

The date that represents the requested start of the quarter.

Since:

Intrexx 7.0.

getStartOfQuarterInMillis

public static long getStartOfQuarterInMillis(Date p_dt,
                                             TimeZone p_tz)

Get the start of the quarter that contains the given date. Hour, minute, seconds, and fractions of seconds are set to zero.

Parameters:

p_dt - The date.

p_tz - The time zone.

Returns:

The time (in milliseconds since 1970-01-01Z00:00:00Z) that represents the requested start of the quarter.

Since:

Intrexx 7.0.

getNumberOfMidnightsBetween

public static long getNumberOfMidnightsBetween(Date p_dt1,
                                               Date p_dt2,
                                               TimeZone p_tz)

Get the number of midnights between two dates in the give time zone.

The result may be negative if the second date is before the first date.

Parameters:

p_dt1 - The first date.

p_dt2 - The second date.

p_tz - The time zone.

Returns:

Get the number of midnights between two dates.

getLunationNumber

public static long getLunationNumber(Date p_dt)

Get the Brown Lunation Number.

See Wikipedia: Lunation Number

Parameters:

p_dt - The date for which the lunation number should be calculated.

Returns:

The Brown Lunation Number.

getLunationNumber

public static long getLunationNumber(long p_lTime)

Get the Brown Lunation Number.

See Wikipedia: Lunation Number

Parameters:

p_lTime - The date for which the lunation number should be calculated.

Returns:

The Brown Lunation Number.

getMeeusLunationNumber

public static long getMeeusLunationNumber(Date p_dt)

Get the Meeus Lunation Number.

See Wikipedia: Lunation Number

Parameters:

p_dt - The date for which the lunation number should be calculated.

Returns:

The Brown Lunation Number.

getMeeusLunationNumber

public static long getMeeusLunationNumber(long p_lTime)

Get the Meeus Lunation Number.

See Wikipedia: Lunation Number

Parameters:

p_lTime - The date for which the lunation number should be calculated.

Returns:

The Brown Lunation Number.

getPhaseOfTheMoon

public static double getPhaseOfTheMoon(Date p_dt)

Get the phase of the moon.

The result is a value greater or equal zero, and less than one, representing the phase of the moon from new moon to new moon.

Parameters:

p_dt - The date for which the phase of the moon should be calculated.

Returns:

A value greater or equal zero, and less than one.

getPhaseOfTheMoon

public static double getPhaseOfTheMoon(long p_lTime)

Get the phase of the moon.

The result is a value greater or equal zero, and less than one, representing the phase of the moon from new moon to new moon.

Parameters:

p_lTime - The date for which the phase of the moon should be calculated.

Returns:

A value greater or equal zero, and less than one.

getShroveMondayDate

public static Date getShroveMondayDate(int p_iYear,
                                       TimeZone p_tz)

getShroveMondayDateInMillis

public static long getShroveMondayDateInMillis(int p_iYear,
                                               TimeZone p_tz)

getShroveMondayDate

public static Date getShroveMondayDate(Date p_dt,
                                       TimeZone p_tz)

getAshWednesdayDate

public static Date getAshWednesdayDate(int p_iYear,
                                       TimeZone p_tz)

getAshWednesdayDateInMillis

public static long getAshWednesdayDateInMillis(int p_iYear,
                                               TimeZone p_tz)

getAshWednesdayDate

public static Date getAshWednesdayDate(Date p_dt,
                                       TimeZone p_tz)

getMaundyThursdayDate

public static Date getMaundyThursdayDate(int p_iYear,
                                         TimeZone p_tz)

getMaundyThursdayDateInMillis

public static long getMaundyThursdayDateInMillis(int p_iYear,
                                                 TimeZone p_tz)

getMaundyThursdayDate

public static Date getMaundyThursdayDate(Date p_dt,
                                         TimeZone p_tz)

getGoodFridayDate

public static Date getGoodFridayDate(int p_iYear,
                                     TimeZone p_tz)

getGoodFridayDateInMillis

public static long getGoodFridayDateInMillis(int p_iYear,
                                             TimeZone p_tz)

getGoodFridayDate

public static Date getGoodFridayDate(Date p_dt,
                                     TimeZone p_tz)

getEasterDate

public static Date getEasterDate(int p_iYear,
                                 TimeZone p_tz)

getEasterDateInMillis

public static long getEasterDateInMillis(int p_iYear,
                                         TimeZone p_tz)

getEasterDate

public static Date getEasterDate(Date p_dt,
                                 TimeZone p_tz)

getEasterMondayDate

public static Date getEasterMondayDate(int p_iYear,
                                       TimeZone p_tz)

getEasterMondayDateInMillis

public static long getEasterMondayDateInMillis(int p_iYear,
                                               TimeZone p_tz)

getEasterMondayDate

public static Date getEasterMondayDate(Date p_dt,
                                       TimeZone p_tz)

getAscensionDate

public static Date getAscensionDate(int p_iYear,
                                    TimeZone p_tz)

getAscensionDateInMillis

public static long getAscensionDateInMillis(int p_iYear,
                                            TimeZone p_tz)

getAscensionDate

public static Date getAscensionDate(Date p_dt,
                                    TimeZone p_tz)

getWhitSundayDate

public static Date getWhitSundayDate(int p_iYear,
                                     TimeZone p_tz)

getWhitSundayDateInMillis

public static long getWhitSundayDateInMillis(int p_iYear,
                                             TimeZone p_tz)

getWhitSundayDate

public static Date getWhitSundayDate(Date p_dt,
                                     TimeZone p_tz)

getWhitMondayDate

public static Date getWhitMondayDate(int p_iYear,
                                     TimeZone p_tz)

getWhitMondayDateInMillis

public static long getWhitMondayDateInMillis(int p_iYear,
                                             TimeZone p_tz)

getWhitMondayDate

public static Date getWhitMondayDate(Date p_dt,
                                     TimeZone p_tz)

getPentecostDate

public static Date getPentecostDate(int p_iYear,
                                    TimeZone p_tz)

Same as getWhitSundayDate(int, TimeZone).

Parameters:

p_iYear - The year.

p_tz - The time zone in which this date should be created.

Returns:

The date.

getPentecostDateInMillis

public static long getPentecostDateInMillis(int p_iYear,
                                            TimeZone p_tz)

Same as getWhitSundayDate(int, TimeZone).

Parameters:

p_iYear - The year.

p_tz - The time zone in which this date should be created.

Returns:

The date in milliseconds since 1970-01-01 00:00:00 UTC.

getPentecostDate

public static Date getPentecostDate(Date p_dt,
                                    TimeZone p_tz)

getCorpusChristiDate

public static Date getCorpusChristiDate(int p_iYear,
                                        TimeZone p_tz)

getCorpusChristiDateInMillis

public static long getCorpusChristiDateInMillis(int p_iYear,
                                                TimeZone p_tz)

getCorpusChristiDate

public static Date getCorpusChristiDate(Date p_dt,
                                        TimeZone p_tz)

getPenanceDayDate

public static Date getPenanceDayDate(int p_iYear,
                                     TimeZone p_tz)

getPenanceDayDateInMillis

public static long getPenanceDayDateInMillis(int p_iYear,
                                             TimeZone p_tz)

getPenanceDayDate

public static Date getPenanceDayDate(Date p_dt,
                                     TimeZone p_tz)