org.wattdepot.common.util.tstamp

Class Tstamp

java.lang.Object

org.wattdepot.common.util.tstamp.Tstamp

public final class Tstamp
extends Object

Utility class that facilitates Timestamp representation and processing. There are too many classes already named "Timestamp", thus the abbreviated name.

Author:

Philip Johnson

Method Summary

Methods

Modifier and Type	Method and Description
static int	daysBetween(XMLGregorianCalendar day1, XMLGregorianCalendar day2) Returns the number of days between time1 and time2.
static long	diff(XMLGregorianCalendar time1, XMLGregorianCalendar time2) Returns differences between time1 and time2 in milliseconds.
static boolean	equal(XMLGregorianCalendar time1, XMLGregorianCalendar time2) Returns true if time1 equals time2.
static List<XMLGregorianCalendar>	getNTimestampList(int n, XMLGregorianCalendar startTime, XMLGregorianCalendar endTime) Produces a list of n + 1 XMLGregorianCalendar instances that span the given time interval by dividing the interval by n.
static List<XMLGregorianCalendar>	getTimestampList(XMLGregorianCalendar startTime, XMLGregorianCalendar endTime, int intervalMinutes) Helper function that prepares a List timestamps, between the start time and end time, at the given sampling interval.
static boolean	greaterThan(String timeString1, String timeString2) Returns true if timeString1 > timeString2.
static boolean	greaterThan(XMLGregorianCalendar time1, XMLGregorianCalendar time2) Returns true if time1 > time2.
static boolean	inBetween(XMLGregorianCalendar start, XMLGregorianCalendar tstamp, XMLGregorianCalendar end) Returns true if tstamp is equal to or between start and end.
static XMLGregorianCalendar	incrementDays(XMLGregorianCalendar tstamp, int days) Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of days.
static XMLGregorianCalendar	incrementHours(XMLGregorianCalendar tstamp, int hours) Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of hours.
static XMLGregorianCalendar	incrementMilliseconds(XMLGregorianCalendar tstamp, long milliseconds) Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of milliseconds.
static XMLGregorianCalendar	incrementMinutes(XMLGregorianCalendar tstamp, int minutes) Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of minutes.
static XMLGregorianCalendar	incrementSeconds(XMLGregorianCalendar tstamp, int seconds) Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of seconds.
static boolean	isTimestamp(String lexicalRepresentation) Returns true if the passed string can be parsed into an XMLGregorianCalendar object.
static boolean	isTodayOrLater(XMLGregorianCalendar timestamp) Returns true if the passed timestamp indicates some time today or some time in the future.
static boolean	isYesterdayOrLater(XMLGregorianCalendar timestamp) Returns true if the passed timestamp indicates some time yesterday or some time in the future.
static boolean	lessThan(XMLGregorianCalendar time1, XMLGregorianCalendar time2) Returns true if time1 < time2.
static XMLGregorianCalendar	makeTimestamp() Returns an XMLGregorianCalendar corresponding to the current time.
static XMLGregorianCalendar	makeTimestamp(long timeInMillis) Converts the specified time in milliseconds into a javax.xml.datatype.XMLGregorianCalendar.
static XMLGregorianCalendar	makeTimestamp(String rep) Returns an XMLGregorianCalendar, given its string representation.
static XMLGregorianCalendar	makeTimestamp(Timestamp tstamp) Converts a javax.sql.Timestamp into a javax.xml.datatype.XMLGregorianCalendar.
static Timestamp	makeTimestamp(XMLGregorianCalendar calendar) Returns a new java.sql.Timestamp created from a javax.xml.datatype.XMLGregorianCalendar.
static List<XMLGregorianCalendar>	sort(Collection<XMLGregorianCalendar> tstamps) Returns a newly created sorted list of tstamps from the passed collection.

Methods inherited from class java.lang.Object

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

Method Detail

isTimestamp

public static boolean isTimestamp(String lexicalRepresentation)

Returns true if the passed string can be parsed into an XMLGregorianCalendar object.

Parameters:

lexicalRepresentation - The string representation.

Returns:

True if the string is a legal XMLGregorianCalendar.

makeTimestamp

public static XMLGregorianCalendar makeTimestamp(String rep)
                                          throws Exception

Returns an XMLGregorianCalendar, given its string representation. Missing hours, minutes, second, millisecond, and timezone fields are given defaults.

Parameters:

rep - The string representation.

Returns:

The timestamp.

Throws:

Exception - If the string cannot be parsed into a timestamp.

makeTimestamp

public static XMLGregorianCalendar makeTimestamp(Timestamp tstamp)

Converts a javax.sql.Timestamp into a javax.xml.datatype.XMLGregorianCalendar.

Parameters:

tstamp - The javax.sql.Timestamp

Returns:

A new instance of a javax.xml.datatype.XmlGregorianCalendar

makeTimestamp

public static XMLGregorianCalendar makeTimestamp(long timeInMillis)

Converts the specified time in milliseconds into a javax.xml.datatype.XMLGregorianCalendar.

Parameters:

timeInMillis - the specified time in milliseconds to convert.

Returns:

A new instance of a javax.xml.datatype.XmlGregorianCalendar

incrementDays

public static XMLGregorianCalendar incrementDays(XMLGregorianCalendar tstamp,
                                 int days)

Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of days.

Parameters:

tstamp - The base date and time.

days - The number of days to increment. This can be a negative number.

Returns:

A new XMLGregorianCalendar instance representing the inc'd time.

incrementHours

public static XMLGregorianCalendar incrementHours(XMLGregorianCalendar tstamp,
                                  int hours)

Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of hours.

Parameters:

tstamp - The base date and time.

hours - The number of hours to increment. This can be a negative number.

Returns:

A new XMLGregorianCalendar instance representing the inc'd time.

incrementMinutes

public static XMLGregorianCalendar incrementMinutes(XMLGregorianCalendar tstamp,
                                    int minutes)

Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of minutes.

Parameters:

tstamp - The base date and time.

minutes - The number of minutes to increment. This can be a negative number.

Returns:

A new XMLGregorianCalendar instance representing the inc'd time.

incrementSeconds

public static XMLGregorianCalendar incrementSeconds(XMLGregorianCalendar tstamp,
                                    int seconds)

Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of seconds.

Parameters:

tstamp - The base date and time.

seconds - The number of seconds to increment. This can be a negative number.

Returns:

A new XMLGregorianCalendar instance representing the inc'd time.

incrementMilliseconds

public static XMLGregorianCalendar incrementMilliseconds(XMLGregorianCalendar tstamp,
                                         long milliseconds)

Returns a new XMLGregorianCalendar corresponding to the passed tstamp incremented by the number of milliseconds.

Parameters:

tstamp - The base date and time.

milliseconds - The number of milliseconds to increment. This can be a negative number.

Returns:

A new XMLGregorianCalendar instance representing the inc'd time.

makeTimestamp

public static Timestamp makeTimestamp(XMLGregorianCalendar calendar)

Returns a new java.sql.Timestamp created from a javax.xml.datatype.XMLGregorianCalendar.

Parameters:

calendar - The XML timestamp.

Returns:

The SQL timestamp.

makeTimestamp

public static XMLGregorianCalendar makeTimestamp()

Returns an XMLGregorianCalendar corresponding to the current time.

Returns:

The timestamp.

inBetween

public static boolean inBetween(XMLGregorianCalendar start,
                XMLGregorianCalendar tstamp,
                XMLGregorianCalendar end)

Returns true if tstamp is equal to or between start and end.

Parameters:

start - The start time.

tstamp - The timestamp to test.

end - The end time.

Returns:

True if tstamp is between start and end.

greaterThan

public static boolean greaterThan(XMLGregorianCalendar time1,
                  XMLGregorianCalendar time2)

Returns true if time1 > time2.

Parameters:

time1 - The first time.

time2 - The second time.

Returns:

True if time1 > time2

daysBetween

public static int daysBetween(XMLGregorianCalendar day1,
              XMLGregorianCalendar day2)

Returns the number of days between time1 and time2. Returns a negative number if day1 is after day2. Takes into account daylight savings time issues.

Parameters:

day1 - The first day.

day2 - The second day.

Returns:

The number of days between the two days.

greaterThan

public static boolean greaterThan(String timeString1,
                  String timeString2)

Returns true if timeString1 > timeString2. Throws an unchecked IllegalArgument exception if the strings can't be converted to timestamps.

Parameters:

timeString1 - The first time.

timeString2 - The second time.

Returns:

True if time1 > time2

lessThan

public static boolean lessThan(XMLGregorianCalendar time1,
               XMLGregorianCalendar time2)

Returns true if time1 < time2.

Parameters:

time1 - The first time.

time2 - The second time.

Returns:

True if time1 < time2

equal

public static boolean equal(XMLGregorianCalendar time1,
            XMLGregorianCalendar time2)

Returns true if time1 equals time2.

Parameters:

time1 - The first time.

time2 - The second time.

Returns:

True if time1 equals time2

diff

public static long diff(XMLGregorianCalendar time1,
        XMLGregorianCalendar time2)

Returns differences between time1 and time2 in milliseconds.

Parameters:

time1 - Start.

time2 - End.

Returns:

Difference between two times in milliseconds.

isTodayOrLater

public static boolean isTodayOrLater(XMLGregorianCalendar timestamp)

Returns true if the passed timestamp indicates some time today or some time in the future.

Parameters:

timestamp - The timestamp of interest.

Returns:

True if it's today or some day in the future.

isYesterdayOrLater

public static boolean isYesterdayOrLater(XMLGregorianCalendar timestamp)

Returns true if the passed timestamp indicates some time yesterday or some time in the future. This is useful for the Commit/Churn DPDs, where the sensor typically sends data not from the current day, but from the day before.

Parameters:

timestamp - The timestamp of interest.

Returns:

True if it's today or some day in the future.

sort

public static List<XMLGregorianCalendar> sort(Collection<XMLGregorianCalendar> tstamps)

Returns a newly created sorted list of tstamps from the passed collection.

Parameters:

tstamps - The timestamps to be sorted.

Returns:

A new list of tstamps, now in sorted order.

getTimestampList

public static List<XMLGregorianCalendar> getTimestampList(XMLGregorianCalendar startTime,
                                          XMLGregorianCalendar endTime,
                                          int intervalMinutes)

Helper function that prepares a List timestamps, between the start time and end time, at the given sampling interval.

Parameters:

startTime - The start of the range requested.

endTime - The start of the range requested.

intervalMinutes - The sampling interval requested in minutes.

Returns:

The List of XMLGregorianCalendars.

getNTimestampList

public static List<XMLGregorianCalendar> getNTimestampList(int n,
                                           XMLGregorianCalendar startTime,
                                           XMLGregorianCalendar endTime)

Produces a list of n + 1 XMLGregorianCalendar instances that span the given time interval by dividing the interval by n.

Parameters:

n - The number of timestamps to generate.

startTime - The start of the interval.

endTime - The end of the interval.

Returns:

A List of size n.