Package pulse.tasks.logs

Class Log

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.tasks.logs.Log

All Implemented Interfaces:

Serializable, Descriptive

public class Log
extends Group

A Log is used to track changes for a specific SearchTask, such as changes of status and/or data collection events.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Log(SearchTask task)	Creates a Log for this task that will automatically store TaskStatEvents and a list of DataLogEntries in thread-safe collections.

Method Summary

Modifier and Type	Method	Description
void	addListener(LogEntryListener l)
LocalTime	getEnd()	This is the time after the creation of the Log when a change of status to DONE happened.
Identifier	getIdentifier()
List<LogEntryListener>	getListeners()
List<LogEntry>	getLogEntries()
LocalTime	getStart()	This is the time after the creation of the Log when a change of status to IN_PROGRESS happened.
void	initListeners()
boolean	isFinished()
static boolean	isGraphicalLog()	Checks whether this Log is verbose.
boolean	isStarted()	Checks whether this Log has observed a TaskStateEvent triggered by a change of status of its respective SearchTask to IN_PROGRESS.
LogEntry	lastEntry()	Finds the last recorded entry in this Log.
static void	setGraphicalLog(boolean verbose)	Sets the verbose flag to verbose
long[]	timeTaken()	Time taken where the first array element contains seconds [0] and the second contains milliseconds [1].
String	toString()	Outputs all log entries consecutively.

Methods inherited from class pulse.util.Group

access, children, contents, getDescriptor, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, describe, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Log

public Log(SearchTask task)

Creates a Log for this task that will automatically store TaskStatEvents and a list of DataLogEntries in thread-safe collections. This is done by adding a TaskListener and a StatusChangeListener to the task object.

Parameters:

task - the task to be logged.

Method Detail

initListeners

public void initListeners()

Overrides:

initListeners in class UpwardsNavigable

getListeners

public final List<LogEntryListener> getListeners()

addListener

public final void addListener(LogEntryListener l)

getIdentifier

public final Identifier getIdentifier()

isStarted

public boolean isStarted()

Checks whether this Log has observed a TaskStateEvent triggered by a change of status of its respective SearchTask to IN_PROGRESS.

Returns:

true if the start time is not null

isFinished

public boolean isFinished()

toString

public String toString()

Outputs all log entries consecutively.

Overrides:

toString in class Object

getLogEntries

public List<LogEntry> getLogEntries()

getStart

public LocalTime getStart()

This is the time after the creation of the Log when a change of status to IN_PROGRESS happened.

Returns:

the start time

getEnd

public LocalTime getEnd()

This is the time after the creation of the Log when a change of status to DONE happened.

Returns:

the start time

lastEntry

public LogEntry lastEntry()

Finds the last recorded entry in this Log.

Returns:

last recorded entry.

isGraphicalLog

public static boolean isGraphicalLog()

Checks whether this Log is verbose. Verbose logs stores all data entries and outputs them on request. This is useful to get an idea of how the search method works, how many iterations are taken to reach a converged value, etc.

Returns:

true if the verbose flag is on

setGraphicalLog

public static void setGraphicalLog(boolean verbose)

Sets the verbose flag to verbose

Parameters:

verbose - the new value of the flag

See Also:

isGraphicalLog()

timeTaken

public long[] timeTaken()

Time taken where the first array element contains seconds [0] and the second contains milliseconds [1].

Returns:

an array of long values that sum um to the time taken to process a task