org.sdmxsource.sdmx.util.date

Class DateUtil

java.lang.Object

org.sdmxsource.sdmx.util.date.DateUtil

public class DateUtil
extends java.lang.Object

Class provided to perform date operations

Constructor Summary

Constructors

Constructor and Description
DateUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Calendar	createCalendar(java.util.Date date)
static java.util.List<java.lang.String>	createTimeValues(java.util.Date dateFrom, java.util.Date dateTo, TIME_FORMAT format) Creates a list of all the date values between the from and to dates.
static javax.xml.datatype.XMLGregorianCalendar	createXMLGregorianCalendar(java.util.Date date)
static java.lang.String	formatDate(java.util.Date dt)
static java.lang.String	formatDate(java.util.Date date, TIME_FORMAT format) Return an SDMX-ML formatted time period, based on the frequency supplied.
static java.util.Date	formatDate(java.lang.Object dateObject, boolean startOfPeriod) Formats a String as a date.
static java.lang.String	formatDateForSdmxVersion1(java.lang.String aDate) SDMX 1.0 does not support quarterly dates (2001-Q1) or half-yearly dates (2001-S1) and these must be converted into monthly dates where: Q1 is month 01 Q2 is month 04 Q3 is month 07 Q4 is month 10 S1 is month 01 S2 is month 07
static java.lang.String	formatDateForSdmxVersion2(java.lang.String aDate) SDMX 2.1 represents Bi-annual dates as [0-9][0-9][0-9][0-9]-S[1-2] e.g.
static java.lang.String	formatDateForSdmxVersion21(java.lang.String aDate) SDMX 2.1 represents Bi-annual dates as [0-9][0-9][0-9][0-9]-S[1-2] e.g.
static java.util.Calendar	getCalendar() This method should be used instead of Calendar.getInstance() since it constructs a Calendar with the appropriate default settings which ensures Dates are calculated correctly.
static java.util.Calendar	getCalendar(int calfield, int num) Returns a calendar which is initialized with date now() +/- the time given in the calfield, obtained from Calendar.[Feild] and the time.
static java.text.DateFormat	getDateFormat()
static java.text.DateFormat	getDateFormatter(java.lang.String pattern) Returns a DateFormat object which has its TimeZone set to GMT.
static java.text.DateFormat	getDateTimeFormat() Returns a DateFormat object that can be used to format a date string as a date object.
static java.lang.String	getDateTimeStringNow()
static java.util.Date	getEndOfDay(java.util.Date date) Returns the end of the day (23:59:59:999) for the supplied date and returns a new date instance.
static java.text.DateFormat	getMonthFormat()
static TIME_FORMAT	getTimeFormatOfDate(java.lang.String dateStr) Validates the date is in SDMX date/time format, and returns the Time Format for the date
static java.text.DateFormat	getYearFormat()
static java.text.DateFormat	geWeekFormat()
static boolean	isSdmxDate(java.lang.String dateStr) Returns true if the input string can be expressed as an SDMX date, false if not
static java.util.Date	moveToEndofPeriod(java.util.Date date, TIME_FORMAT timeFormat) Returns the end value for the specified date.
static java.util.Date	parseDate(java.lang.String date, java.lang.String dateFormat)

Methods inherited from class java.lang.Object

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

Constructor Detail

DateUtil

public DateUtil()

Method Detail

getCalendar

public static java.util.Calendar getCalendar(int calfield,
                             int num)

Returns a calendar which is initialized with date now() +/- the time given in the calfield, obtained from Calendar.[Feild] and the time. For example to get a calendar where the date is 1 day previous to now() Calendar cal = Calendar.getCalendar(Calendar.DAY_OF_YEAR, -1)

Parameters:

calfield -

num -

Returns:

createCalendar

public static java.util.Calendar createCalendar(java.util.Date date)

createXMLGregorianCalendar

public static javax.xml.datatype.XMLGregorianCalendar createXMLGregorianCalendar(java.util.Date date)

moveToEndofPeriod

public static java.util.Date moveToEndofPeriod(java.util.Date date,
                               TIME_FORMAT timeFormat)

Returns the end value for the specified date. The end value is determined by the TIME_FORMAT. If the TIME_FORMAT is year then the returned date will be the end of the year.

Parameters:

date - the date to analyse

timeFormat - The timeFormat to use.

Returns:

The end date for the specified timeFormat

formatDate

public static java.util.Date formatDate(java.lang.Object dateObject,
                        boolean startOfPeriod)

Formats a String as a date.

The expected string must be in either of the two following formats.

1. yyyy-MM-dd'T'HH:mm:ss.SSSz
2. yyyy-MM-dd

Parameters:

dateObject -

startOfPeriod - formats the date to the start of the period, otherwise it will be end of period

Returns:

isSdmxDate

public static boolean isSdmxDate(java.lang.String dateStr)

Returns true if the input string can be expressed as an SDMX date, false if not

Parameters:

dateString -

Returns:

getTimeFormatOfDate

public static TIME_FORMAT getTimeFormatOfDate(java.lang.String dateStr)

Validates the date is in SDMX date/time format, and returns the Time Format for the date

Parameters:

dateStr -

Returns:

Throws:

javax.xml.bind.ValidationException - if the data format is invalid, with regards to the allowed SDMX date formats

formatDate

public static java.lang.String formatDate(java.util.Date dt)

getDateTimeFormat

public static java.text.DateFormat getDateTimeFormat()

Returns a DateFormat object that can be used to format a date string as a date object.

For a String to be successfully formatted as a Date using the returned DateFormat object, it must conform to the ISO8601 Standard Date/Time format.

Returns:

DateFormat object

getDateFormat

public static java.text.DateFormat getDateFormat()

getYearFormat

public static java.text.DateFormat getYearFormat()

getMonthFormat

public static java.text.DateFormat getMonthFormat()

geWeekFormat

public static java.text.DateFormat geWeekFormat()

createTimeValues

public static java.util.List<java.lang.String> createTimeValues(java.util.Date dateFrom,
                                                java.util.Date dateTo,
                                                TIME_FORMAT format)

Creates a list of all the date values between the from and to dates. The dates are iterated by the time format. The format of the dates is also dependent on the time format.

Parameters:

dateFrom -

dateTo -

format -

Returns:

formatDate

public static java.lang.String formatDate(java.util.Date date,
                          TIME_FORMAT format)

Return an SDMX-ML formatted time period, based on the frequency supplied. The value returned from this method will be determined based on the frequency and the date value supplied as follows: Annual: The year of the date Biannual: January 1 - June 30 = 1st half, July 1 - December 31 = 2nd half Triannual: January 1 - April 30 = 1st third, May 1 - August 30 = 2nd third, September 1 - December 31 = 3rd third Quarterly: January 1 - March 31 = 1st quarter, April 1 - June 30 = 2nd quarter, July 1 - September 30 = 3rd quarter, October 1 - December 31 = 4th quarter Monthly: The month of the date Weekly: The week of the year according to ISO 8601. Daily: The date only Hourly: The full date time representation.

Parameters:

date - the date to convert

freq - the frequency on which the conversion should be based

Returns:

The date in SDMX-ML TimePeriodType format.

getDateTimeStringNow

public static java.lang.String getDateTimeStringNow()

getCalendar

public static java.util.Calendar getCalendar()

This method should be used instead of Calendar.getInstance() since it constructs a Calendar with the appropriate default settings which ensures Dates are calculated correctly. The use of a Calendar with TimeZone of GMT is important since GMT is NOT a TimeZone that has any daylight saving hours issues.

Returns:

A Calendar

getEndOfDay

public static java.util.Date getEndOfDay(java.util.Date date)

Returns the end of the day (23:59:59:999) for the supplied date and returns a new date instance.

Parameters:

date -

Returns:

parseDate

public static java.util.Date parseDate(java.lang.String date,
                       java.lang.String dateFormat)

getDateFormatter

public static java.text.DateFormat getDateFormatter(java.lang.String pattern)

Returns a DateFormat object which has its TimeZone set to GMT. The use of a Calendar with TimeZone of GMT is important since GMT is NOT a TimeZone that has any daylight saving hours issues.

formatDateForSdmxVersion21

public static java.lang.String formatDateForSdmxVersion21(java.lang.String aDate)

SDMX 2.1 represents Bi-annual dates as [0-9][0-9][0-9][0-9]-S[1-2] e.g. 1999-S1 whereas SDMX 2.0 represents Bi-annual dates as [0-9][0-9][0-9][0-9]-B[1-2] e.g. 1999-B1. The reason appears to be that they were called biannual dates in SDMX 2.0 and Reporting Semesters in SDMX 2.1

Parameters:

aDate -

Returns:

formatDateForSdmxVersion2

public static java.lang.String formatDateForSdmxVersion2(java.lang.String aDate)

SDMX 2.1 represents Bi-annual dates as [0-9][0-9][0-9][0-9]-S[1-2] e.g. 1999-S1 whereas SDMX 2.0 represents Bi-annual dates as [0-9][0-9][0-9][0-9]-B[1-2] e.g. 1999-B1. The reason appears to be that they were called biannual dates in SDMX 2.0 and Reporting Semesters in SDMX 2.1

Parameters:

aDate -

Returns:

formatDateForSdmxVersion1

public static java.lang.String formatDateForSdmxVersion1(java.lang.String aDate)

SDMX 1.0 does not support quarterly dates (2001-Q1) or half-yearly dates (2001-S1) and these must be converted into monthly dates where:

Q1 is month 01

Q2 is month 04

Q3 is month 07

Q4 is month 10

S1 is month 01

S2 is month 07