com.rapidminer.tools
Class TimeFormat

java.lang.Object
  com.rapidminer.tools.TimeFormat

public class TimeFormat
extends java.lang.Object

This class provides some utility functions useful to format elapsed time (usually given in milliseconds).

Author:

Christian Bockermann

Field Summary

static long	DAY_MS
static long	HOUR_MS
static long	MIN_MS
static long	SEC_MS
static long	WEEK_MS

Constructor Summary

TimeFormat()
Creates a new TimeFormat instance.

TimeFormat(java.text.NumberFormat numberFormat)
Create a new time formatter object which uses the given NumberFormat to display the number of seconds.

Method Summary

java.lang.String

format(long timeInMilliseconds) This method takes the given number of milliseconds, time, and creates a new String containing a description of the time by means of days, hours, minutes and seconds.

Methods inherited from class java.lang.Object

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

Field Detail

SEC_MS

public static final long SEC_MS

See Also:

Constant Field Values

MIN_MS

public static final long MIN_MS

See Also:

Constant Field Values

HOUR_MS

public static final long HOUR_MS

See Also:

Constant Field Values

DAY_MS

public static final long DAY_MS

See Also:

Constant Field Values

WEEK_MS

public static final long WEEK_MS

See Also:

Constant Field Values

Constructor Detail

TimeFormat

public TimeFormat()

Creates a new TimeFormat instance.

TimeFormat

public TimeFormat(java.text.NumberFormat numberFormat)

Create a new time formatter object which uses the given NumberFormat to display the number of seconds. This can be used to support a fine granulated display of seconds.

Method Detail

format

public java.lang.String format(long timeInMilliseconds)

This method takes the given number of milliseconds, time, and creates a new String containing a description of the time by means of days, hours, minutes and seconds. If time is less than any of the mentioned properties, then this field will not be printed, e.g.

• calling format( 1000 ) will result in the string "1s"
• calling format( 90000 * 1000 ), i.e. milliseconds of one day + 1 hour, will result in "1 day 1h".

Parameters:

timeInMilliseconds - The time as an amount of milliseconds.

Returns:

The time formatted as printable string.