ucar.visad

Class UtcDate

java.lang.Object

ucar.visad.UtcDate

public final class UtcDate
extends java.lang.Object

A set of utility functions for UTC DateTimes

Author:

Unidata Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PATTERN Default time format
static java.util.TimeZone	GMT GMT Timezone
static java.lang.String	HH_FORMAT hour format string (HH)
static java.lang.String	HH_MM_FORMAT hour:minute format string (HH:mm)
static java.lang.String	HMS_FORMAT hour:minute:second format string (HH:mm:ss)
static java.lang.String	IYD_FORMAT Year-Day format string
static java.lang.String	JDAY_FORMAT Julian day format string
static java.lang.String	MACRO_TIMESTAMP timestamp macro identifier
static java.lang.String	TEMPLATE_TIMEFORMAT timestamp macro identifier
static java.lang.String	YMD_FORMAT Year-Month-Day format string

Constructor Summary

Constructors

Constructor and Description
UtcDate() default constructor

Method Summary

Modifier and Type	Method and Description
static java.lang.String	applyTimeMacro(java.lang.String template, visad.DateTime dttm) Apply the timestamp macro to the string
static java.lang.String	applyTimeMacro(java.lang.String template, visad.DateTime dttm, java.lang.String noTimeLabel) Apply the timestamp macro to the string
static java.lang.String	applyTimeMacro(java.lang.String template, visad.DateTime dttm, java.lang.String noTimeLabel, java.lang.String prefix, java.lang.String suffix) Apply the timestamp macro to the string
static java.lang.String	applyTimeMacro(java.lang.String template, visad.DateTime dttm, java.lang.String noTimeLabel, java.lang.String prefix, java.lang.String suffix, java.util.TimeZone tz) Apply the timestamp macro to the string
static java.lang.String	applyTimeMacro(java.lang.String template, visad.DateTime dttm, java.util.TimeZone tz) Apply the timestamp macro to the string
static boolean	containsTimeMacro(java.lang.String s) See if the string contains a timestamp macro
static boolean	containsTimeMacro(java.lang.String s, java.lang.String prefix) Does this string contain a time macro
static int[]	convertDateTimeToJulianDay(visad.DateTime[] dates) Convert an array of DateTime objects to an array of the Julian day of each date
static int[]	convertDateTimeToJulianDay(visad.Gridded1DSet timeSet) Convert the time set to an array of the Julian days of each date in the set
static visad.DateTime	createDateTime(java.lang.String dateString) Create a DateTime object.
static visad.DateTime	createDateTime(java.lang.String dateString, java.lang.String pattern) Create a DateTime object.
static visad.DateTime	createDateTime(java.lang.String dateString, java.lang.String pattern, java.util.TimeZone tz) Create a DateTime object.
static visad.DateTime	createDateTime(java.lang.String dateString, java.lang.String pattern, java.util.TimeZone tz, ucar.nc2.time.Calendar cal) Create a DateTime object.
static java.lang.String	formatUtcDate(visad.DateTime dt, java.lang.String pattern) Return a formated date in UTC time.
static java.lang.String	formatUtcDate(visad.DateTime dt, java.lang.String pattern, java.util.TimeZone tz) Return a formated date in UTC time.
static java.lang.String	getHH(visad.DateTime dt) Get the hour as a String.
static java.lang.String	getHH(visad.DateTime dt, java.util.TimeZone tz) Get the hour as a String.
static java.lang.String	getHHMM(visad.DateTime dt) Get the hour:minute as a String.
static java.lang.String	getHHMM(visad.DateTime dt, java.util.TimeZone tz) Get the hour:minute as a String.
static java.lang.String	getHMS(visad.DateTime dt) Get the hour/minute/second as a String
static java.lang.String	getHMS(visad.DateTime dt, java.util.TimeZone tz) Get the hour/minute/second as a String
static java.lang.String	getIYD(visad.DateTime dt) Get the year.jday (IYD_FORMAT) as a String
static java.lang.String	getIYD(visad.DateTime dt, java.util.TimeZone tz) Get the year.jday (IYD_FORMAT) as a String
static java.lang.String	getUtcDate(visad.DateTime dt) Get the full datetime using the DEFAULT_PATTERN
static java.lang.String	getYMD(visad.DateTime dt) Get the year-month-day as a String
static java.lang.String	getYMD(visad.DateTime dt, java.util.TimeZone tz) Get the year-month-day as a String

Methods inherited from class java.lang.Object

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

Field Detail

MACRO_TIMESTAMP

public static final java.lang.String MACRO_TIMESTAMP

timestamp macro identifier

See Also:

Constant Field Values

TEMPLATE_TIMEFORMAT

public static final java.lang.String TEMPLATE_TIMEFORMAT

timestamp macro identifier

See Also:

Constant Field Values

YMD_FORMAT

public static final java.lang.String YMD_FORMAT

Year-Month-Day format string

See Also:

Constant Field Values

HMS_FORMAT

public static final java.lang.String HMS_FORMAT

hour:minute:second format string (HH:mm:ss)

See Also:

Constant Field Values

HH_MM_FORMAT

public static final java.lang.String HH_MM_FORMAT

hour:minute format string (HH:mm)

See Also:

Constant Field Values

HH_FORMAT

public static final java.lang.String HH_FORMAT

hour format string (HH)

See Also:

Constant Field Values

IYD_FORMAT

public static final java.lang.String IYD_FORMAT

Year-Day format string

See Also:

Constant Field Values

JDAY_FORMAT

public static final java.lang.String JDAY_FORMAT

Julian day format string

See Also:

Constant Field Values

GMT

public static final java.util.TimeZone GMT

GMT Timezone

DEFAULT_PATTERN

public static final java.lang.String DEFAULT_PATTERN

Default time format

See Also:

Constant Field Values

Constructor Detail

UtcDate

public UtcDate()

default constructor

Method Detail

getHH

public static java.lang.String getHH(visad.DateTime dt)

Get the hour as a String.

Parameters:

dt - DateTime to use

Returns:

hour as a String (HH)

getHH

public static java.lang.String getHH(visad.DateTime dt,
                                     java.util.TimeZone tz)

Get the hour as a String.

Parameters:

dt - DateTime to use

tz - the TimeZone to use

Returns:

hour as a String (HH)

containsTimeMacro

public static boolean containsTimeMacro(java.lang.String s)

See if the string contains a timestamp macro

Parameters:

s - the string

Returns:

true if it contains the macro

containsTimeMacro

public static boolean containsTimeMacro(java.lang.String s,
                                        java.lang.String prefix)

Does this string contain a time macro

Parameters:

s - the string

prefix - the prefix

Returns:

true if it contains a time macro

applyTimeMacro

public static java.lang.String applyTimeMacro(java.lang.String template,
                                              visad.DateTime dttm)

Apply the timestamp macro to the string

Parameters:

template - the timestamp template

dttm - the DateTime

Returns:

a formatted string of form template

applyTimeMacro

public static java.lang.String applyTimeMacro(java.lang.String template,
                                              visad.DateTime dttm,
                                              java.util.TimeZone tz)

Apply the timestamp macro to the string

Parameters:

template - the timestamp template

dttm - the DateTime

tz - the TimeZone to use

Returns:

a formatted string of form template

applyTimeMacro

public static java.lang.String applyTimeMacro(java.lang.String template,
                                              visad.DateTime dttm,
                                              java.lang.String noTimeLabel)

Apply the timestamp macro to the string

Parameters:

template - the timestamp template

dttm - the DateTime

noTimeLabel - the label if dttm is null;

Returns:

a formatted string of form template

applyTimeMacro

public static java.lang.String applyTimeMacro(java.lang.String template,
                                              visad.DateTime dttm,
                                              java.lang.String noTimeLabel,
                                              java.lang.String prefix,
                                              java.lang.String suffix)

Apply the timestamp macro to the string

Parameters:

template - the timestamp template

dttm - the DateTime

noTimeLabel - the label if dttm is null;

prefix - macro prefix

suffix - macro suffix

Returns:

the String with the macro applied

applyTimeMacro

public static java.lang.String applyTimeMacro(java.lang.String template,
                                              visad.DateTime dttm,
                                              java.lang.String noTimeLabel,
                                              java.lang.String prefix,
                                              java.lang.String suffix,
                                              java.util.TimeZone tz)

Apply the timestamp macro to the string

Parameters:

template - the timestamp template

dttm - the DateTime

noTimeLabel - the label if dttm is null;

prefix - macro prefix

suffix - macro suffix

tz - TimeZone

Returns:

the String with the macro applied

getHHMM

public static java.lang.String getHHMM(visad.DateTime dt)

Get the hour:minute as a String.

Parameters:

dt - DateTime to use

Returns:

hour:minute as a String (HH:mm);

getHHMM

public static java.lang.String getHHMM(visad.DateTime dt,
                                       java.util.TimeZone tz)

Get the hour:minute as a String.

Parameters:

dt - DateTime to use

tz - the TimeZone to use

Returns:

hour:minute as a String (HH:mm);

getYMD

public static java.lang.String getYMD(visad.DateTime dt)

Get the year-month-day as a String

Parameters:

dt - DateTime to use

Returns:

year-month-day as a String (yyyy-MM-dd);

getYMD

public static java.lang.String getYMD(visad.DateTime dt,
                                      java.util.TimeZone tz)

Get the year-month-day as a String

Parameters:

dt - DateTime to use

tz - the TimeZone to use

Returns:

year-month-day as a String (yyyy-MM-dd);

getHMS

public static java.lang.String getHMS(visad.DateTime dt)

Get the hour/minute/second as a String

Parameters:

dt - DateTime to use

Returns:

the hour/minute/second as a String (HH:mm:ss)

getHMS

public static java.lang.String getHMS(visad.DateTime dt,
                                      java.util.TimeZone tz)

Get the hour/minute/second as a String

Parameters:

dt - DateTime to use

tz - the TimeZone to use

Returns:

the hour/minute/second as a String (HH:mm:ss)

getUtcDate

public static java.lang.String getUtcDate(visad.DateTime dt)

Get the full datetime using the DEFAULT_PATTERN

Parameters:

dt - DateTime to use

Returns:

the formatted UTC date

getIYD

public static java.lang.String getIYD(visad.DateTime dt)

Get the year.jday (IYD_FORMAT) as a String

Parameters:

dt - DateTime to use

Returns:

year.jday as a String (yyyyDDD);

getIYD

public static java.lang.String getIYD(visad.DateTime dt,
                                      java.util.TimeZone tz)

Get the year.jday (IYD_FORMAT) as a String

Parameters:

dt - DateTime to use

tz - the TimeZone to use

Returns:

year.jday as a String (yyyyDDD);

formatUtcDate

public static java.lang.String formatUtcDate(visad.DateTime dt,
                                             java.lang.String pattern)

Return a formated date in UTC time. Uses DateTime.formatString() with the UTC (GMT) time zone.

Parameters:

dt - DateTime object

pattern - format pattern

Returns:

formatted date.

formatUtcDate

public static java.lang.String formatUtcDate(visad.DateTime dt,
                                             java.lang.String pattern,
                                             java.util.TimeZone tz)

Return a formated date in UTC time. Uses DateTime.formatString() with the UTC (GMT) time zone.

Parameters:

dt - DateTime object

pattern - format pattern

tz - the TimeZone to use

Returns:

formatted date.

convertDateTimeToJulianDay

public static int[] convertDateTimeToJulianDay(visad.DateTime[] dates)

Convert an array of DateTime objects to an array of the Julian day of each date

Parameters:

dates - array of dates

Returns:

the corresponding Julian Days

convertDateTimeToJulianDay

public static int[] convertDateTimeToJulianDay(visad.Gridded1DSet timeSet)
                                        throws visad.VisADException

Convert the time set to an array of the Julian days of each date in the set

Parameters:

timeSet - set of dates

Returns:

the corresponding Julian Days

Throws:

visad.VisADException - set must have type of RealType.Time

createDateTime

public static visad.DateTime createDateTime(java.lang.String dateString)
                                     throws visad.VisADException

Create a DateTime object.

Parameters:

dateString - the string specifying the date

Returns:

the DateTime object

Throws:

visad.VisADException - problem decoding string or creating Data object

createDateTime

public static visad.DateTime createDateTime(java.lang.String dateString,
                                            java.lang.String pattern)
                                     throws visad.VisADException

Create a DateTime object.

Parameters:

dateString - the string specifying the date

pattern - the format pattern

Returns:

the DateTime object

Throws:

visad.VisADException - problem decoding string or creating Data object

createDateTime

public static visad.DateTime createDateTime(java.lang.String dateString,
                                            java.lang.String pattern,
                                            java.util.TimeZone tz)
                                     throws visad.VisADException

Create a DateTime object.

Parameters:

dateString - the string specifying the date

pattern - the format pattern

tz - the associated time zone

Returns:

the DateTime object

Throws:

visad.VisADException - problem decoding string or creating Data object

createDateTime

public static visad.DateTime createDateTime(java.lang.String dateString,
                                            java.lang.String pattern,
                                            java.util.TimeZone tz,
                                            ucar.nc2.time.Calendar cal)
                                     throws visad.VisADException

Create a DateTime object.

Parameters:

dateString - the string specifying the date

pattern - the format pattern

tz - the associated time zone

cal - the associated Calendar

Returns:

the DateTime object

Throws:

visad.VisADException - problem decoding string or creating Data object