water

Class Job<T extends Keyed>

java.lang.Object

water.Iced<T>

water.Keyed<Job>

water.Job<T>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<Job>

public final class Job<T extends Keyed>
extends Keyed<Job>

Jobs are used to do minimal tracking of long-lifetime user actions, including progress-bar updates and the ability to review in progress or completed Jobs, and cancel currently running Jobs.

Jobs are Keyed, because they need to Key to control e.g. atomic updates.

Jobs are generic on Keyed, because their primary result is a Keyed result - which is Not a Job. Obvious examples are Frames (from running Parse or CreateFrame jobs), or Models (from running ModelBuilder jobs).

Long running tasks will has-a Job, not is-a Job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.JobCancelledException

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_description User description
Key<T>	_result Result Key
int	_typeid
long	_work Total expected work.
static Key<Job>	LIST A system key for global list of Job keys.

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
Job(Key<T> key, java.lang.String clz_of_T, java.lang.String desc) Create a Job

Method Summary

Methods

Modifier and Type	Method and Description
long	end_time()
java.lang.Throwable	ex()
T	get() Blocks until the Job completes
boolean	hasEx()
static boolean	isCancelledException(java.lang.Throwable ex)
boolean	isCrashed()
boolean	isCrashing()
boolean	isDone()
boolean	isRunning()
boolean	isStopped()
boolean	isStopping()
static Job[]	jobs() The list of all Jobs, past and present.
java.lang.Class<KeyV3.JobKeyV3>	makeSchema()
long	msec() Current runtime; zero if not started.
java.lang.String	progress_msg() Returns last progress message.
float	progress() Returns a float from 0 to 1 representing progress.
void	setEx(java.lang.Throwable ex, java.lang.Class thrower_clz) Set an exception into this Job, marking it as failing and setting the _stop_requested flag.
long	start_time()
Job<T>	start(H2O.H2OCountedCompleter fjtask, long work) Start this task based on given top-level fork-join task representing job computation.
boolean	stop_requested()
void	stop()
void	update(long newworked)
static void	update(long newworked, Key<Job> jobkey)
void	update(long newworked, java.lang.String msg) Report new work done for this job
static void	update(long newworked, java.lang.String msg, Key<Job> jobkey)

Methods inherited from class water.Keyed

checksum_impl, checksum, readAll_impl, readAll, remove_impl, remove, remove, remove, remove, writeAll_impl, writeAll

Methods inherited from class water.Iced

clone, copyOver, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_result

public final Key<T extends Keyed> _result

Result Key

_typeid

public final int _typeid

_description

public final java.lang.String _description

User description

_work

public long _work

Total expected work.

LIST

public static final Key<Job> LIST

A system key for global list of Job keys.

Constructor Detail

Job

public Job(Key<T> key,
   java.lang.String clz_of_T,
   java.lang.String desc)

Create a Job

Parameters:

key - Key of the final result

clz_of_T - String class of the Keyed result

desc - String description

Method Detail

start_time

public long start_time()

end_time

public long end_time()

isRunning

public boolean isRunning()

isStopped

public boolean isStopped()

isStopping

public boolean isStopping()

isDone

public boolean isDone()

isCrashing

public boolean isCrashing()

isCrashed

public boolean isCrashed()

msec

public long msec()

Current runtime; zero if not started.

stop_requested

public boolean stop_requested()

stop

public void stop()

ex

public java.lang.Throwable ex()

hasEx

public boolean hasEx()

setEx

public void setEx(java.lang.Throwable ex,
         java.lang.Class thrower_clz)

Set an exception into this Job, marking it as failing and setting the _stop_requested flag. Only the first exception (of possibly many) is kept.

progress

public float progress()

Returns a float from 0 to 1 representing progress. Polled periodically. Can default to returning e.g. 0 always.

progress_msg

public java.lang.String progress_msg()

Returns last progress message.

update

public final void update(long newworked,
          java.lang.String msg)

Report new work done for this job

update

public final void update(long newworked)

update

public static void update(long newworked,
          Key<Job> jobkey)

update

public static void update(long newworked,
          java.lang.String msg,
          Key<Job> jobkey)

jobs

public static Job[] jobs()

The list of all Jobs, past and present.

Returns:

The list of all Jobs, past and present

start

public Job<T> start(H2O.H2OCountedCompleter fjtask,
           long work)

Start this task based on given top-level fork-join task representing job computation.

Parameters:

fjtask - top-level job computation task.

work - Amount of work to-do, for updating progress bar

Returns:

this job in isRunning() state

See Also:

H2O.H2OCountedCompleter

isCancelledException

public static boolean isCancelledException(java.lang.Throwable ex)

get

public T get()

Blocks until the Job completes

makeSchema

public java.lang.Class<KeyV3.JobKeyV3> makeSchema()

Overrides:

makeSchema in class Keyed<Job>