com.cohort.util

Class ScriptCalendar2

java.lang.Object

com.cohort.util.ScriptCalendar2

public class ScriptCalendar2
extends java.lang.Object

This class makes some of the static methods in com.cohort.Calendar2 accessible to JexlScript scripts as "Calendar2.name()" methods.

The underlying Calendar2 class is Copyright (c) 2005 Robert Simons (CoHortSoftware@gmail.com). See the MIT/X-like license in com/cohort/util/LICENSE.txt.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AM_PM
static int	BC
static int	DATE 1..
static int	DAY_OF_YEAR
static int	DST_OFFSET in millis
static int	ERA These are the fields in a Calendar or GregorianCalendar object.
static int	HOUR 0..11, so rarely used
static int	HOUR_OF_DAY 0..23
static int	MILLISECOND
static int	MINUTE
static int	MONTH Jan=0, ...
static int	SECOND
static int	YEAR
static int	ZONE_OFFSET in millis

Constructor Summary

Constructors

Constructor and Description
ScriptCalendar2()

Method Summary

Modifier and Type	Method and Description
static double	clearSmallerFields(double epochSeconds, int field) This clears the fields smaller than 'field' (e.g., HOUR_OF_DAY clears MINUTE, SECOND, and MILLISECOND, but doesn't change HOUR_OF_DAY, MONTH, or YEAR).
static java.lang.String	epochSecondsToLimitedIsoStringT(java.lang.String time_precision, double seconds, java.lang.String NaNString) This is like safeEpochSecondsToIsoStringT3Z, but returns a limited precision string.
static double	epochSecondsToUnitsSince(double baseSeconds, double factorToGetSeconds, double epochSeconds) This converts an epochSeconds value into a unitsSince value.
static java.lang.String	format(double epochSeconds, java.lang.String pattern, java.lang.String zone) This formats the epochSeconds time value using the pattern.
static double[]	getTimeBaseAndFactor(java.lang.String tsUnits, java.util.TimeZone timeZone) This converts a string "[units] since [isoDate]" (e.g., "minutes since 1985-01-01") into a baseSeconds (seconds since 1970-01-01) and a factor ("minutes" returns 60).
static double	parseToEpochSeconds(java.lang.String sourceTime, java.lang.String dateTimeFormat) A variant of parseToEpochSeconds that uses the Zulu time zone.
static double	parseToEpochSeconds(java.lang.String sourceTime, java.lang.String dateTimeFormat, java.lang.String timeZoneString) This converts a sourceTime string into a double with epochSeconds.
static double	tryToEpochSeconds(java.lang.String someDateTimeString) This tries to figure out the format of someDateTimeString then parse the value and convert it to epochSeconds.
static java.lang.String	tryToIsoString(java.lang.String someDateTimeString) This tries to figure out the format of someDateTimeString then parse the value and convert to an ISO 8601 string with 'Z' at end.
static double	unitsSinceToEpochSeconds(double baseSeconds, double factorToGetSeconds, double unitsSince) This converts a unitsSince value into epochSeconds.

Methods inherited from class java.lang.Object

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

Field Detail

ERA

public static final int ERA

These are the fields in a Calendar or GregorianCalendar object.

BC

public static final int BC

YEAR

public static final int YEAR

MONTH

public static final int MONTH

Jan=0, ...

DATE

public static final int DATE

1.. of month

DAY_OF_YEAR

public static final int DAY_OF_YEAR

HOUR

public static final int HOUR

0..11, so rarely used

HOUR_OF_DAY

public static final int HOUR_OF_DAY

0..23

MINUTE

public static final int MINUTE

SECOND

public static final int SECOND

MILLISECOND

public static final int MILLISECOND

AM_PM

public static final int AM_PM

ZONE_OFFSET

public static final int ZONE_OFFSET

in millis

DST_OFFSET

public static final int DST_OFFSET

in millis

Constructor Detail

ScriptCalendar2

public ScriptCalendar2()

Method Detail

getTimeBaseAndFactor

public static double[] getTimeBaseAndFactor(java.lang.String tsUnits,
                                            java.util.TimeZone timeZone)

This converts a string "[units] since [isoDate]" (e.g., "minutes since 1985-01-01") into a baseSeconds (seconds since 1970-01-01) and a factor ("minutes" returns 60).
So simplistically, epochSeconds = storedTime * factor + baseSeconds.
Or simplistically, storedTime = (epochSeconds - baseSeconds) / factor.

WARNING: don't use the equations above. Use unitsSinceToEpochSeconds or epochSecondsToUnitsSince which correctly handle special cases.

Parameters:

tsUnits - e.g., "minutes since 1985-01-01". This may include hours, minutes, seconds, decimal, and Z or timezone offset (default=Zulu). This is lenient.

timeZone - Is a TimeZone from TimeZone.gettimeZone(id). For valid ID's, see the "TZ database names" column in the table at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones If this is null, Zulu will be used.

Returns:

double[]{baseSeconds, factorToGetSeconds}

Throws:

java.lang.RuntimeException - if trouble (tsUnits is null or invalid)

unitsSinceToEpochSeconds

public static double unitsSinceToEpochSeconds(double baseSeconds,
                                              double factorToGetSeconds,
                                              double unitsSince)

This converts a unitsSince value into epochSeconds. This properly handles 'special' factorToGetSeconds values (for month and year).

Parameters:

baseSeconds - from getTimeBaseAndFactor[0]

factorToGetSeconds - from getTimeBaseAndFactor[1]

unitsSince - a numeric time value in source units "units since baseTime"

Returns:

seconds since 1970-01-01 (or NaN if unitsSince is NaN)

epochSecondsToUnitsSince

public static double epochSecondsToUnitsSince(double baseSeconds,
                                              double factorToGetSeconds,
                                              double epochSeconds)

This converts an epochSeconds value into a unitsSince value. This properly handles 'special' factorToGetSeconds values (for month and year).

Parameters:

baseSeconds - from getTimeBaseAndFactor[0]

factorToGetSeconds - from getTimeBaseAndFactor[1]

epochSeconds - seconds since 1970-01-01 (or NaN if epochSeconds is NaN)

Returns:

a numeric time value in source units "units since baseTime"

parseToEpochSeconds

public static double parseToEpochSeconds(java.lang.String sourceTime,
                                         java.lang.String dateTimeFormat,
                                         java.lang.String timeZoneString)

This converts a sourceTime string into a double with epochSeconds.

Parameters:

sourceTime - a formatted time string

dateTimeFormat - See https://erddap.github.io/setupDatasetsXml.html#stringTimeUnits

timeZoneString - For a list of valid timezone ID's, see the "TZ database names" column in the table at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones . If this is null or "", Zulu will be used.

Returns:

the epochSeconds value or NaN if trouble

parseToEpochSeconds

public static double parseToEpochSeconds(java.lang.String sourceTime,
                                         java.lang.String dateTimeFormat)

A variant of parseToEpochSeconds that uses the Zulu time zone.

Parameters:

sourceTime - a formatted time string

dateTimeFormat - See https://erddap.github.io/setupDatasetsXml.html#stringTimeUnits

Returns:

the epochSeconds value or NaN if trouble

tryToEpochSeconds

public static double tryToEpochSeconds(java.lang.String someDateTimeString)

This tries to figure out the format of someDateTimeString then parse the value and convert it to epochSeconds.

Parameters:

someDateTimeString - a formatted time string

Returns:

epochSeconds (or Double.NaN if trouble);

tryToIsoString

public static java.lang.String tryToIsoString(java.lang.String someDateTimeString)

This tries to figure out the format of someDateTimeString then parse the value and convert to an ISO 8601 string with 'Z' at end. This is the most flexible approach to parsing/cleaning a weird date time string.

Parameters:

someDateTimeString -

Returns:

an iso8601String as a date, a dateTime with T and Z, or "" if trouble;

format

public static java.lang.String format(double epochSeconds,
                                      java.lang.String pattern,
                                      java.lang.String zone)

This formats the epochSeconds time value using the pattern.

Parameters:

epochSeconds -

pattern - see https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html If pattern is null or "", this uses the ISO TZ format with seconds precision.

zone - if null or "", Zulu is used

Returns:

the formatted time string (or "" if trouble)

epochSecondsToLimitedIsoStringT

public static java.lang.String epochSecondsToLimitedIsoStringT(java.lang.String time_precision,
                                                               double seconds,
                                                               java.lang.String NaNString)

This is like safeEpochSecondsToIsoStringT3Z, but returns a limited precision string. This won't throw an exception.

Parameters:

time_precision - can be "1970", "1970-01", "1970-01-01", "1970-01-01T00Z", "1970-01-01T00:00Z", "1970-01-01T00:00:00Z" (used if time_precision not matched), "1970-01-01T00:00:00.0Z", "1970-01-01T00:00:00.00Z", "1970-01-01T00:00:00.000Z". Or any of those without "Z". If time_precision ends in Z, the result will too. If time_precision doesn't end in Z, the result won't end in Z. Note that ERDDAP™ requires/forces/ensures any format with hours(min(sec)) to have Z.

seconds - the epochSeconds value

NaNString - the value to return if seconds is not finite or is too big.

Returns:

the formatted time string (or NaNString if trouble)

clearSmallerFields

public static double clearSmallerFields(double epochSeconds,
                                        int field)

This clears the fields smaller than 'field' (e.g., HOUR_OF_DAY clears MINUTE, SECOND, and MILLISECOND, but doesn't change HOUR_OF_DAY, MONTH, or YEAR).

Parameters:

epochSeconds -

field - e.g., HOUR_OF_DAY

Returns:

the new epochSeconds value (or NaN if trouble).