org.grobid.core.utilities.counters

Class GrobidTimer

java.lang.Object

org.grobid.core.utilities.counters.GrobidTimer

public class GrobidTimer
extends java.lang.Object

GrobidTimer is a timer that can memorize multiple stop times.
Example of use: GrobidTimer timer= new GrobidTimer(); timer.start(); timer.stop("Time1"); timer.stop("Time2"); System.out.println("The elapsed time between start and Time1 is "+timer.getElapsedTimeFromStart("Time1")); System.out.println("The elapsed time between Time1 and Time2 is "+timer.getElapsedTime("Time1","Time2"));

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	START The tag under which the start time is saved.
static java.lang.String	STOP The tag end.

Constructor Summary

Constructors

Constructor and Description
GrobidTimer() Constructor.
GrobidTimer(boolean pStartNow) Constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatTime(java.lang.Long pTime) Format a time from Long to String using the following format: MIN_SEC_MILI.
java.util.Map<java.lang.String,java.lang.Long>	getAllSavedTimes() Return the complete Map of all stored times.
java.lang.Long	getElapsedTime(java.lang.String pTagStart, java.lang.String pTagStop) Compute the time elapsed between pTagStart and pTagStop.
java.lang.String	getElapsedTimeFormated(java.lang.String pTagStart, java.lang.String pTagStop) Compute the time elapsed between pTagStart and pTagStop.
java.lang.Long	getElapsedTimeFromStart(java.lang.String pTag) Compute the time elapsed between the start of the timer and the stop time.
java.lang.String	getElapsedTimeFromStartFormated(java.lang.String pTag) Compute the time elapsed between the start of the timer and the stop time. Return the time formatted: MIN_SEC_MILI.
java.lang.Long	getTime(java.lang.String pTag) Get all the time saved in the timer.
java.lang.String	getTimeFormated(java.lang.String pTag) Get all the time saved in the timer.
void	pauseTimer() Stop time count.
void	restartTimer() Restart the timer when it has been paused by pauseTimer().
void	start() Start the timer.
void	stop(java.lang.String pTag) Store the current time with the name pTag.

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final java.lang.String START

The tag under which the start time is saved.

See Also:

Constant Field Values

STOP

public static final java.lang.String STOP

The tag end.

See Also:

Constant Field Values

Constructor Detail

GrobidTimer

public GrobidTimer()

Constructor.

GrobidTimer

public GrobidTimer(boolean pStartNow)

Constructor.

Parameters:

pStartNow - if true the timer will be started from now, else the start method will have to be called.

Method Detail

start

public void start()

Start the timer.

stop

public void stop(java.lang.String pTag)

Store the current time with the name pTag.

Parameters:

pTag - the name under which the current time will be saved.

getElapsedTimeFromStart

public java.lang.Long getElapsedTimeFromStart(java.lang.String pTag)

Compute the time elapsed between the start of the timer and the stop time.

Parameters:

pTag - the tag of the stop time.

Returns:

the time elapsed from start to stop.

getElapsedTime

public java.lang.Long getElapsedTime(java.lang.String pTagStart,
                                     java.lang.String pTagStop)

Compute the time elapsed between pTagStart and pTagStop.

Parameters:

pTagStart - the tag of the start time.

pTagStop - the tag of the stop time.

Returns:

the time elapsed from start to stop.

getTime

public java.lang.Long getTime(java.lang.String pTag)

Get all the time saved in the timer.
The start tag is START.

Returns:

the time corresponding to the tag.

getElapsedTimeFromStartFormated

public java.lang.String getElapsedTimeFromStartFormated(java.lang.String pTag)

Compute the time elapsed between the start of the timer and the stop time.
Return the time formatted: MIN_SEC_MILI.

Parameters:

pTag - the tag of the stop time.

Returns:

the time elapsed from start to stop.

getElapsedTimeFormated

public java.lang.String getElapsedTimeFormated(java.lang.String pTagStart,
                                               java.lang.String pTagStop)

Compute the time elapsed between pTagStart and pTagStop.
Return the time formatted: MIN_SEC_MILI.

Parameters:

pTagStart - the tag of the start time.

pTagStop - the tag of the stop time.

Returns:

the time elapsed from start to stop.

getTimeFormated

public java.lang.String getTimeFormated(java.lang.String pTag)

Get all the time saved in the timer.
The start tag is START.
Return the time formatted: MIN_SEC_MILI.

Returns:

the time corresponding to the tag.

pauseTimer

public void pauseTimer()

Stop time count. To restart the timer: restartTimer().

restartTimer

public void restartTimer()

Restart the timer when it has been paused by pauseTimer().

getAllSavedTimes

public java.util.Map<java.lang.String,java.lang.Long> getAllSavedTimes()

Return the complete Map of all stored times.

Returns:

Map

formatTime

public static java.lang.String formatTime(java.lang.Long pTime)

Format a time from Long to String using the following format: MIN_SEC_MILI.

Parameters:

pTime - the time to format.

Returns:

formatted time.