org.rhq.server.metrics

Class DateTimeService

java.lang.Object

org.rhq.server.metrics.DateTimeService

public class DateTimeService
extends Object

Provides common DateTime utility functions.

Author:

John Sanda

Field Summary

Fields

Modifier and Type	Field and Description
protected MetricsConfiguration	configuration

Constructor Summary

Constructors

Constructor and Description
DateTimeService()

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	current24HourTimeSlice() The 24 hour time slices are fix - 00:00 to 24:00.
org.joda.time.DateTime	current6HourTimeSlice() The six hour time slices for a day are fixed - 00:00 to 06:00, 06:00 to 12:00, 12:00 to 18:00, 18:00 to 24:00.
org.joda.time.DateTime	currentHour()
org.joda.time.DateTime	get24HourTimeSlice(org.joda.time.DateTime time) This method determines the 24 hour time slice for the specified time and returns the start of that time slice.
org.joda.time.DateTime	get24HourTimeSlice(long timestamp)
org.joda.time.DateTime	get24HourTimeSliceEnd(org.joda.time.DateTime time)
org.joda.time.DateTime	get6HourTimeSlice(org.joda.time.DateTime time) This method determines the six hour time slice for the specified time and returns the start of that time slice.
org.joda.time.DateTime	get6HourTimeSlice(long timestamp)
org.joda.time.DateTime	get6HourTimeSliceEnd(org.joda.time.DateTime time)
org.joda.time.DateTime	getTimeSlice(org.joda.time.DateTime dt, org.joda.time.Duration duration)
org.joda.time.DateTime	getTimeSlice(long timestamp, org.joda.time.Duration duration)
org.joda.time.DateTime	hour0()
boolean	is24HourTimeSliceFinished(org.joda.time.DateTime time) Determines if the current 24 hour time slice for the specified time has completed.
boolean	is24HourTimeSliceFinished(long timestamp)
boolean	is6HourTimeSliceFinished(org.joda.time.DateTime time) Determines if the current six hour time slice for the specified time has completed.
boolean	is6HourTimeSliceFinished(long timestamp)
boolean	isIn1HourDataRange(org.joda.time.DateTime dateTime)
boolean	isIn24HourDataRange(org.joda.time.DateTime dateTime)
boolean	isIn6HourDataRange(org.joda.time.DateTime dateTime)
boolean	isInRawDataRange(org.joda.time.DateTime dateTime)
org.joda.time.DateTime	now() This method is preferred over DateTime.now() and System.currentTimeMillis() because it provides a hook for tests.
long	nowInMillis()
void	setConfiguration(MetricsConfiguration configuration)

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected MetricsConfiguration configuration

Constructor Detail

DateTimeService

public DateTimeService()

Method Detail

setConfiguration

public void setConfiguration(MetricsConfiguration configuration)

now

public org.joda.time.DateTime now()

This method is preferred over DateTime.now() and System.currentTimeMillis() because it provides a hook for tests.

Returns:

a DateTime object set to milliseconds.

nowInMillis

public long nowInMillis()

getTimeSlice

public org.joda.time.DateTime getTimeSlice(long timestamp,
                                  org.joda.time.Duration duration)

getTimeSlice

public org.joda.time.DateTime getTimeSlice(org.joda.time.DateTime dt,
                                  org.joda.time.Duration duration)

isInRawDataRange

public boolean isInRawDataRange(org.joda.time.DateTime dateTime)

isIn1HourDataRange

public boolean isIn1HourDataRange(org.joda.time.DateTime dateTime)

isIn6HourDataRange

public boolean isIn6HourDataRange(org.joda.time.DateTime dateTime)

isIn24HourDataRange

public boolean isIn24HourDataRange(org.joda.time.DateTime dateTime)

currentHour

public org.joda.time.DateTime currentHour()

Returns:

A DateTime object rounded down to the start of the current hour. For example, if the current time is 17:21:09, then 17:00:00 is returned.

current6HourTimeSlice

public org.joda.time.DateTime current6HourTimeSlice()

The six hour time slices for a day are fixed - 00:00 to 06:00, 06:00 to 12:00, 12:00 to 18:00, 18:00 to 24:00. This method determines the six hour time slice based on currentHour() and returns the start of the time slice.

Returns:

A DateTime object rounded down to the start of the current six hour time slice.

current24HourTimeSlice

public org.joda.time.DateTime current24HourTimeSlice()

The 24 hour time slices are fix - 00:00 to 24:00. This method determines the 24 hour time slice based on currentHour() and returns the start of the time slice.

Returns:

A DateTime object rounded down to the start of the current 24 hour time slice.

get24HourTimeSlice

public org.joda.time.DateTime get24HourTimeSlice(org.joda.time.DateTime time)

This method determines the 24 hour time slice for the specified time and returns the start of that time slice.

Parameters:

time - The DateTime to be rounded down

Returns:

A DateTime rounded down to the start of the 24 hour time slice in which the time parameter falls.

See Also:

current24HourTimeSlice()

get24HourTimeSliceEnd

public org.joda.time.DateTime get24HourTimeSliceEnd(org.joda.time.DateTime time)

get24HourTimeSlice

public org.joda.time.DateTime get24HourTimeSlice(long timestamp)

See Also:

get24HourTimeSlice(org.joda.time.DateTime)

get6HourTimeSlice

public org.joda.time.DateTime get6HourTimeSlice(org.joda.time.DateTime time)

This method determines the six hour time slice for the specified time and returns the start of that time slice.

Parameters:

time - The DateTime to be rounded down

Returns:

A DateTime rounded down to the start of the six hour time slice in which the time parameter falls.

See Also:

current6HourTimeSlice()

get6HourTimeSlice

public org.joda.time.DateTime get6HourTimeSlice(long timestamp)

See Also:

get6HourTimeSlice(org.joda.time.DateTime)

get6HourTimeSliceEnd

public org.joda.time.DateTime get6HourTimeSliceEnd(org.joda.time.DateTime time)

is6HourTimeSliceFinished

public boolean is6HourTimeSliceFinished(org.joda.time.DateTime time)

Determines if the current six hour time slice for the specified time has completed.

Suppose that the current time is 14:23 and that the specified time is 13:15:00 which falls into the 12:00 - 18:00 time slice. In this case the time slice has not yet finished.

Now suppose that the current time is 12:24 and the specified time is 11:34 which falls into the 06:00 - 12:00 time slice. In this case the time slice has finished.

Parameters:

time - The DateTime to evaluate

Returns:

true if the six hour time slice for the specified time has completed, false otherwise.

is6HourTimeSliceFinished

public boolean is6HourTimeSliceFinished(long timestamp)

See Also:

is6HourTimeSliceFinished(org.joda.time.DateTime)

is24HourTimeSliceFinished

public boolean is24HourTimeSliceFinished(org.joda.time.DateTime time)

Determines if the current 24 hour time slice for the specified time has completed.

Suppose that the current time 22:12 Monday and that the specified time is 21:48. The current time slice, i.e., Monday, has not yet finished.

Now suppose that the current time is 01:13 Tuesday and that the specified time is 23:19 Monday. The time slice for the specified time has finished.

Parameters:

time - The DateTime to evaluate

Returns:

true if the 24 hour time slice for the specified time has completed, false otherwise.

is24HourTimeSliceFinished

public boolean is24HourTimeSliceFinished(long timestamp)

See Also:

is24HourTimeSliceFinished(org.joda.time.DateTime)

hour0

public org.joda.time.DateTime hour0()