PamUtils

Class PamCalendar

java.lang.Object

PamUtils.PamCalendar

public class PamCalendar
extends java.lang.Object

Author:

Doug Gillespie Date and time in Pamguard are critical. It's likely that we'll be taking time from the GPS in the longer term, so for now, make sure that all calendar functions come via this

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.TimeZone	defaultTimeZone
static long	millisPerDay

Constructor Summary

Constructors

Constructor and Description
PamCalendar()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	createFileName(long fileStartTime, java.lang.String prefix, java.lang.String fileType) Creates a file name containing the time and a user defined prefix and file end
static java.lang.String	createFileName(long fileStartTime, java.lang.String directory, java.lang.String prefix, java.lang.String fileType) Create a file name based on a time and other information
static java.lang.String	createFileName(java.lang.String directory, java.lang.String prefix, java.lang.String fileType) Create a file name that doesn't contain a time
static java.lang.String	createFileNameMillis(long fileStartTime, java.lang.String prefix, java.lang.String fileType) Like createFileName but the time now also includes milliseconds.
static java.lang.String	createFileNameMillis(long fileStartTime, java.lang.String directory, java.lang.String prefix, java.lang.String fileType) Create a file name based on a time and other information
static java.util.Date	dateFromDateString(java.lang.String dateString) Read a date string and turn it into a Date
static long	dateNumtoMillis(double datenum) Convert MATLAB datenum to millis;
static long	excelSerialtoMillis(double excelSerial) Converts excel Serial date number (Jan 1900 format) to millis.
static java.lang.String	formatCompactDate(long timeMillis) Format date in format "yyyyMMdd" using GMT as the time zone
static java.lang.String	formatDate(long timeInMillis) Format the data in the dd MMMM yyyy format
static java.lang.String	formatDate2(long timeInMillis) Format the data in the ddMMyy format
static java.lang.String	formatDateTime(java.util.Date date) Get a formatted date and time string.
static java.lang.String	formatDateTime(long timeInMillis) Formats the time and data in a long format
static java.lang.String	formatDateTime2(long timeInMillis) Formats the time and data in a long format but without the GMT label at the end.
static java.lang.String	formatDBDate(long timeInMillis) Formats the date and time in the correct format for database output.
static java.lang.String	formatDBDateTime(long timeInMillis) Formats the date and time in the correct format for database output.
static java.lang.String	formatDBDateTimeQueryString(long timeMillis) Get a formatted string in the correct format to include in database queries
static java.lang.String	formatDuration(long timeInMillis) Format a time in milliseconds as a number of days / seconds, etc.
static java.lang.String	formatDuration(long timeInMillis, java.lang.String middleString)
static java.lang.String	formatDuration(long timeInMillis, java.lang.String middleString1, java.lang.String middleString2)
static java.lang.String	formatFileDate(long timeMillis) Format date in format "yyyyMMdd" but using a time zone based on UTC or a local time depending on global PAMGuard options.
static java.lang.String	formatFileDateTime(long timeMillis) Format date and time in format "yyyyMMdd_HHmmss"
static java.lang.String	formatLocalDateTime(java.util.Date date) Get a formatted local date and time string.
static java.lang.String	formatLocalDateTime(long timeInMillis) Formats the local time and data in a long format
static java.lang.String	formatLocalTime(long timeMillis, boolean showMillis) Format a time string optionally showing the milliseconds with a given precision for UTC time zone
static java.lang.String	formatTime(long timeMillis) Format a time string in the format HH:MM:SS
static java.lang.String	formatTime(long timeMillis, boolean showMillis) Format a time string optionally showing the milliseconds with a given precision for UTC time zone
static java.lang.String	formatTime(long timeMillis, int millisDigits) Format a time string optionally showing the milliseconds with a given precision.
static java.lang.String	formatTime2(long timeMillis, int millisDigits) Format a time string optionally showing the milliseconds with a given precision.
static java.util.Calendar	getCalendarDate() Get the current date
static java.util.Calendar	getCalendarDate(long timeInMillis) Get the date for a given time
static java.lang.String	getDate()
static java.sql.Timestamp	getLocalTimeStamp(long millis) Get a local timestamp using system default time zone.
static long	getSessionStartTime()
static long	getTime() a formatted time string
static long	getTimeInMillis() If files are being analysed, return the time based on the file position.
static java.sql.Timestamp	getTimeStamp(long millis) Get a GMT timestamp for output to a database
static java.lang.String	getUnpunctuatedDate()
static long	getViewEndTime()
static long	getViewPosition()
static boolean	isSameDay(long t1, long t2) Compares two times in milliseconds to see if they are on the same day or not.
static boolean	isSoundFile()
static java.lang.Long	millisFromDateString(java.lang.String dateString) Convert a date string into a millisecond time.
static long	millisFromTimeStamp(java.sql.Timestamp timestamp) convert a time stamp read from a database into milliseconds.
static double	millistoDateNum(long timeMillis) Convert millis to MATLAB datenum.
static double	millistoExcelSerial(long timeMillis) Converts millis to an excel serial data based on the Jan 1900 system.
static long	msFromDateString(java.lang.String dateString) Read a date string and turn it into a millisecond time.
static long	msFromTimeString(java.lang.String timeString) Read a time string and turn it into a millisecond time.
static void	setSessionStartTime(long sessionStartTime)
static void	setSoundFile(boolean soundFile)
static void	setSoundFileTimeInMillis(long soundFileTimeMillis)
static void	setViewPosition(long viewPosition)
static void	setViewTimes(long start, long end)
static java.util.Date	timeFromTimeString(java.lang.String timeString) Read a time string and turn it into a Date

Methods inherited from class java.lang.Object

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

Field Detail

defaultTimeZone

public static java.util.TimeZone defaultTimeZone

millisPerDay

public static final long millisPerDay

See Also:

Constant Field Values

Constructor Detail

PamCalendar

public PamCalendar()

Method Detail

getTimeInMillis

public static long getTimeInMillis()

If files are being analysed, return the time based on the file position. Otherwise just take the normal system time.

Returns:

time in milliseconds

getTime

public static long getTime()

a formatted time string

getDate

public static java.lang.String getDate()

Returns:

a formatted date string

isSameDay

public static final boolean isSameDay(long t1,
                long t2)

Compares two times in milliseconds to see if they are on the same day or not.

Parameters:

t1 - first time

t2 - second time

Returns:

true if times are on the same day

getCalendarDate

public static java.util.Calendar getCalendarDate()

Get the current date

Returns:

the date as a Calendar object (in GMT)

getCalendarDate

public static java.util.Calendar getCalendarDate(long timeInMillis)

Get the date for a given time

Parameters:

timeInMillis - time in milliseconds

Returns:

the date as a Calendar object (in GMT)

formatDateTime

public static java.lang.String formatDateTime(java.util.Date date)

Get a formatted date and time string.

Parameters:

date - Date

Returns:

formatted String

formatLocalDateTime

public static java.lang.String formatLocalDateTime(java.util.Date date)

Get a formatted local date and time string.

Parameters:

date - Date

Returns:

formatted String

formatDateTime

public static java.lang.String formatDateTime(long timeInMillis)

Formats the time and data in a long format

Parameters:

timeInMillis - time in milliseconds

Returns:

formated data and time

formatLocalDateTime

public static java.lang.String formatLocalDateTime(long timeInMillis)

Formats the local time and data in a long format

Parameters:

timeInMillis - time in milliseconds

Returns:

formated data and time

formatDateTime2

public static java.lang.String formatDateTime2(long timeInMillis)

Formats the time and data in a long format but without the GMT label at the end.

Parameters:

timeInMillis - time in milliseconds

Returns:

formated data and time

formatDBDateTime

public static java.lang.String formatDBDateTime(long timeInMillis)

Formats the date and time in the correct format for database output.

"yyyy-MM-dd HH:mm:ss"

Parameters:

timeInMillis - time in milliseconds

Returns:

formated data and time

formatDBDate

public static java.lang.String formatDBDate(long timeInMillis)

Formats the date and time in the correct format for database output.

"yyyy-MM-dd"

Parameters:

timeInMillis - time in milliseconds

Returns:

formated data and time

formatDBDateTimeQueryString

public static java.lang.String formatDBDateTimeQueryString(long timeMillis)

Get a formatted string in the correct format to include in database queries

e.g. {ts '2012-06-25 17:22:54'}

Parameters:

timeMillis - time in milliseconds

Returns:

formatted string

formatTime

public static java.lang.String formatTime(long timeMillis)

Format a time string in the format HH:MM:SS

Parameters:

timeMillis - time in milliseconds

Returns:

formatted string

formatTime

public static java.lang.String formatTime(long timeMillis,
                          boolean showMillis)

Format a time string optionally showing the milliseconds with a given precision for UTC time zone

Parameters:

timeMillis - time in milliseconds

millisDigits - number of millisecond decimal places.

Returns:

formatted time string.

formatLocalTime

public static java.lang.String formatLocalTime(long timeMillis,
                               boolean showMillis)

Format a time string optionally showing the milliseconds with a given precision for UTC time zone

Parameters:

timeMillis - time in milliseconds

millisDigits - number of millisecond decimal places.

Returns:

formatted time string.

formatTime

public static java.lang.String formatTime(long timeMillis,
                          int millisDigits)

Format a time string optionally showing the milliseconds with a given precision. The time string is formatted as HH:mm:ss.SSSSS.

Parameters:

timeMillis - time in milliseconds

millisDigits - number of millsecond decimal places.

Returns:

formatted time string.

formatTime2

public static java.lang.String formatTime2(long timeMillis,
                           int millisDigits)

Format a time string optionally showing the milliseconds with a given precision. The time string is formatted as HHmmss.SSSSS.

Parameters:

timeMillis - time in milliseconds

millisDigits - number of millsecond decimal places.

Returns:

formatted time string.

formatDuration

public static java.lang.String formatDuration(long timeInMillis)

Format a time in milliseconds as a number of days / seconds, etc.

Parameters:

timeInMillis - time in milliseconds.

Returns:

formatted time interval

formatDuration

public static java.lang.String formatDuration(long timeInMillis,
                              java.lang.String middleString)

formatDuration

public static java.lang.String formatDuration(long timeInMillis,
                              java.lang.String middleString1,
                              java.lang.String middleString2)

formatDate

public static java.lang.String formatDate(long timeInMillis)

Format the data in the dd MMMM yyyy format

Parameters:

timeInMillis - time in milliseconds

Returns:

formatted string.

formatDate2

public static java.lang.String formatDate2(long timeInMillis)

Format the data in the ddMMyy format

Parameters:

timeInMillis - time in milliseconds

Returns:

formatted string.

formatCompactDate

public static java.lang.String formatCompactDate(long timeMillis)

Format date in format "yyyyMMdd" using GMT as the time zone

Parameters:

timeMillis -

Returns:

formatFileDate

public static java.lang.String formatFileDate(long timeMillis)

Format date in format "yyyyMMdd" but using a time zone based on UTC or a local time depending on global PAMGuard options.

Parameters:

timeMillis -

Returns:

formatted date string

formatFileDateTime

public static java.lang.String formatFileDateTime(long timeMillis)

Format date and time in format "yyyyMMdd_HHmmss"

Parameters:

timeMillis -

Returns:

formatted time string

msFromDateString

public static long msFromDateString(java.lang.String dateString)

Read a date string and turn it into a millisecond time.

Parameters:

dateString -

Returns:

time in milliseconds

millisFromDateString

public static java.lang.Long millisFromDateString(java.lang.String dateString)

Convert a date string into a millisecond time. Return null if the string cannot be interpreted as a date.

Parameters:

dateString - Date string

Returns:

Millis from 1970 or null.

dateFromDateString

public static java.util.Date dateFromDateString(java.lang.String dateString)

Read a date string and turn it into a Date

Parameters:

dateString -

Returns:

time as a Date object

msFromTimeString

public static long msFromTimeString(java.lang.String timeString)

Read a time string and turn it into a millisecond time.

Parameters:

timeString -

Returns:

time in milliseconds

timeFromTimeString

public static java.util.Date timeFromTimeString(java.lang.String timeString)

Read a time string and turn it into a Date

Parameters:

timeString -

Returns:

time as a Date object

isSoundFile

public static boolean isSoundFile()

Returns:

true if the sound source is a file

setSoundFile

public static void setSoundFile(boolean soundFile)

Parameters:

soundFile - set whether the sound source is a file

getSessionStartTime

public static long getSessionStartTime()

Returns:

The time that processing started

setSessionStartTime

public static void setSessionStartTime(long sessionStartTime)

Parameters:

sessionStartTime - the time that processing started

setSoundFileTimeInMillis

public static void setSoundFileTimeInMillis(long soundFileTimeMillis)

Parameters:

soundFileTimeMillis - The start time of a sound file

createFileName

public static java.lang.String createFileName(long fileStartTime,
                              java.lang.String directory,
                              java.lang.String prefix,
                              java.lang.String fileType)

Create a file name based on a time and other information

Parameters:

fileStartTime - File time

directory - Directory / folder

prefix - file prefix (part of file name to inlcude before the time stamp)

fileType - file end

Returns:

File path and name, ending with a time stamp

createFileNameMillis

public static java.lang.String createFileNameMillis(long fileStartTime,
                                    java.lang.String directory,
                                    java.lang.String prefix,
                                    java.lang.String fileType)

Create a file name based on a time and other information

Parameters:

fileStartTime - File time

directory - Directory / folder

prefix - file prefix (part of file name to include before the time stamp)

fileType - file end

Returns:

File path and name, ending with a time stamp

createFileName

public static java.lang.String createFileName(java.lang.String directory,
                              java.lang.String prefix,
                              java.lang.String fileType)

Create a file name that doesn't contain a time

Parameters:

directory - Directory / folder

prefix - file prefix (part of file name to inlcude before the time stamp)

fileType - file end

Returns:

File path and name

createFileName

public static java.lang.String createFileName(long fileStartTime,
                              java.lang.String prefix,
                              java.lang.String fileType)

Creates a file name containing the time and a user defined prefix and file end

Parameters:

fileStartTime - time

prefix - prefix for file name

fileType - file type (with or without the '.')

Returns:

file name

createFileNameMillis

public static java.lang.String createFileNameMillis(long fileStartTime,
                                    java.lang.String prefix,
                                    java.lang.String fileType)

Like createFileName but the time now also includes milliseconds.

Parameters:

fileStartTime -

prefix -

fileType -

Returns:

getUnpunctuatedDate

public static java.lang.String getUnpunctuatedDate()

Returns:

a date string in a very compressed format (suitable for file names)

getTimeStamp

public static java.sql.Timestamp getTimeStamp(long millis)

Get a GMT timestamp for output to a database

Parameters:

millis - time in milliseconds

Returns:

GMT timestamp

getLocalTimeStamp

public static java.sql.Timestamp getLocalTimeStamp(long millis)

Get a local timestamp using system default time zone.

Parameters:

millis - time in milliseconds.

Returns:

local timestamp.

millisFromTimeStamp

public static long millisFromTimeStamp(java.sql.Timestamp timestamp)

convert a time stamp read from a database into milliseconds.

Parameters:

timestamp - GMT timestamp

Returns:

time in milliseconds.

setViewTimes

public static void setViewTimes(long start,
                long end)

getViewEndTime

public static long getViewEndTime()

getViewPosition

public static long getViewPosition()

setViewPosition

public static void setViewPosition(long viewPosition)

millistoDateNum

public static double millistoDateNum(long timeMillis)

Convert millis to MATLAB datenum.

Parameters:

timeMillis -

Returns:

MATLAB datenum.

dateNumtoMillis

public static long dateNumtoMillis(double datenum)

Convert MATLAB datenum to millis;

Parameters:

MATLAB - datenum

Returns:

timeMillis equivalent of the MATLAB datenum.

millistoExcelSerial

public static double millistoExcelSerial(long timeMillis)

Converts millis to an excel serial data based on the Jan 1900 system.

Parameters:

timeMillis -

Returns:

excel serial datenum.

excelSerialtoMillis

public static long excelSerialtoMillis(double excelSerial)

Converts excel Serial date number (Jan 1900 format) to millis.

Parameters:

excelSerial - datenum

Returns:

timeMillis equivalent of the excel datenum.