org.lenskit.util.monitor

Class TrackedJob

java.lang.Object

org.lenskit.util.monitor.TrackedJob

public class TrackedJob
extends java.lang.Object

A job graph node used for tracking the status of work.

Constructor Summary

Constructors

Constructor and Description
TrackedJob(java.lang.String type) Create a new tracked job.
TrackedJob(java.lang.String type, java.lang.String desc) Create a new tracked job.

Method Summary

Modifier and Type	Method and Description
void	fail(java.lang.Throwable th) Record the job as being failed.
void	finish() Record the job as being finished.
void	finishStep() Mark a step as finished.
void	finishSteps(int n) Mark steps as finished.
int	getChildCount() Get the number of children.
int	getChildrenFinished() Get the number of finished children.
int	getChildrenRunning() Get the number of running children.
java.lang.String	getDescription()
EventBus	getEventBus()
java.lang.Throwable	getException() Get the exception with which this job failed.
int	getExpectedSteps() Get the estimated number of steps.
TrackedJob	getParent() Get the parent job.
int	getReportingInterval() Get the reporting interval for firing progress update messages.
int	getStepsFinished() Get the number of finished steps.
Stopwatch	getTimer() Get the timer for this job.
java.lang.String	getType()
java.util.UUID	getUUID()
TrackedJob	makeChild(java.lang.String type) Create a child job.
TrackedJob	makeChild(java.lang.String type, java.lang.String description) Create a child job.
void	setReportingInterval(int iv) Set the reporting interval for firing progress update messages.
void	start() Start the job.
void	start(int steps) Start the job with an estimated number of steps.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackedJob

public TrackedJob(java.lang.String type)

Create a new tracked job.

Parameters:

type - The job type code.

TrackedJob

public TrackedJob(java.lang.String type,
                  java.lang.String desc)

Create a new tracked job.

Parameters:

type - The job type code.

desc - The description.

Method Detail

getEventBus

@Nonnull
public EventBus getEventBus()

getUUID

public java.util.UUID getUUID()

getParent

@Nullable
public TrackedJob getParent()

Get the parent job.

Returns:

The parent job.

makeChild

public TrackedJob makeChild(@Nonnull
                            java.lang.String type)

Create a child job.

Parameters:

type - The job type.

Returns:

The child job.

makeChild

public TrackedJob makeChild(@Nonnull
                            java.lang.String type,
                            @Nullable
                            java.lang.String description)

Create a child job.

Parameters:

type - The job type.

description - The job description.

Returns:

The child job.

getType

@Nonnull
public java.lang.String getType()

getDescription

@Nullable
public java.lang.String getDescription()

getExpectedSteps

public int getExpectedSteps()

Get the estimated number of steps. This does not include children.

Returns:

The estimated number of steps, or -1 if no estimate is available.

getStepsFinished

public int getStepsFinished()

Get the number of finished steps.

Returns:

The finished steps.

getChildCount

public int getChildCount()

Get the number of children.

Returns:

The number of children.

getChildrenRunning

public int getChildrenRunning()

Get the number of running children.

Returns:

The number of running children.

getChildrenFinished

public int getChildrenFinished()

Get the number of finished children.

Returns:

The number of finished children.

getReportingInterval

public int getReportingInterval()

Get the reporting interval for firing progress update messages.

Returns:

The reporting interval.

setReportingInterval

public void setReportingInterval(int iv)

Set the reporting interval for firing progress update messages.

Parameters:

iv - The reporting interval.

finishStep

public void finishStep()

Mark a step as finished.

finishSteps

public void finishSteps(int n)

Mark steps as finished.

Parameters:

n - The number of additional steps that have been finished.

start

public void start()

Start the job.

start

public void start(int steps)

Start the job with an estimated number of steps.

Parameters:

steps - The estimated number of steps.

finish

public void finish()

Record the job as being finished.

fail

public void fail(@Nullable
                 java.lang.Throwable th)

Record the job as being failed.

Parameters:

th - The error that is causing the job to fail.

getException

@Nullable
public java.lang.Throwable getException()

Get the exception with which this job failed.

Returns:

The exception for this job, if there is one.

getTimer

public Stopwatch getTimer()

Get the timer for this job.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object