com.asakusafw.yaess.core

Class PhaseMonitor

java.lang.Object

com.asakusafw.yaess.core.PhaseMonitor

All Implemented Interfaces:

ExecutionMonitor, Closeable, AutoCloseable

Direct Known Subclasses:

FlowLogger, LoggingExecutionMonitor

public abstract class PhaseMonitor
extends Object
implements ExecutionMonitor

Receives phase execution's progress.

Since:

0.2.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhaseMonitor.JobStatus Job statuses.

Field Summary

Fields

Modifier and Type	Field and Description
static PhaseMonitor	NULL An empty implementation.

Constructor Summary

Constructors

Constructor and Description
PhaseMonitor()

Method Summary

Modifier and Type	Method and Description
void	checkCancelled() Raise InterruptedException if cancel has been requested.
ExecutionMonitor	createJobMonitor(String jobId, double childTaskSize) Creates a new child task monitor with the specified task size.
protected OutputStream	getJobOutput(String jobId) Returns an output stream for jobs.
OutputStream	getOutput() Returns output stream for extra information.
protected boolean	isCancelRequested() Returns whether this phase execution has been requested cancel.
protected void	onJobMonitorClosed(String jobId) Notifies the job was closed.
protected void	onJobMonitorOpened(String jobId) Notifies the job was opened.
abstract void	reportJobStatus(String jobId, PhaseMonitor.JobStatus status, Throwable cause) Reports job status about target job ID.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.asakusafw.yaess.core.ExecutionMonitor

close, open, progressed, setProgress

Field Detail

NULL

public static final PhaseMonitor NULL

An empty implementation.

Constructor Detail

PhaseMonitor

public PhaseMonitor()

Method Detail

checkCancelled

public void checkCancelled()
                    throws InterruptedException

Description copied from interface: ExecutionMonitor

Raise InterruptedException if cancel has been requested.

Specified by:

checkCancelled in interface ExecutionMonitor

Throws:

InterruptedException - if cencel requested

isCancelRequested

protected boolean isCancelRequested()

Returns whether this phase execution has been requested cancel. Default implementation always returns false.

Returns:

true to cancel requested, false otherwise

getOutput

public OutputStream getOutput()
                       throws IOException

Description copied from interface: ExecutionMonitor

Returns output stream for extra information. This stream must not be closed by out of the monitors, the stream will be closed automatically in the monitor.

Specified by:

getOutput in interface ExecutionMonitor

Returns:

current output stream

Throws:

IOException - if failed to prepare the output

createJobMonitor

public ExecutionMonitor createJobMonitor(String jobId,
                                         double childTaskSize)

Creates a new child task monitor with the specified task size.

Parameters:

jobId - target job ID

childTaskSize - task size in this monitor to assign to the child monitor

Returns:

the created monitor

Throws:

IllegalArgumentException - if some parameters were null

reportJobStatus

public abstract void reportJobStatus(String jobId,
                                     PhaseMonitor.JobStatus status,
                                     Throwable cause)
                              throws IOException

Reports job status about target job ID.

Parameters:

jobId - target job ID

status - the job status

cause - occurred exception (nullable)

Throws:

IllegalArgumentException - if some parameters were null

IOException - if failed to notify this event

onJobMonitorOpened

protected void onJobMonitorOpened(String jobId)
                           throws IOException

Notifies the job was opened. The default implementation does nothing.

Parameters:

jobId - target job ID

Throws:

IOException - if failed to notify this event

getJobOutput

protected OutputStream getJobOutput(String jobId)
                             throws IOException

Returns an output stream for jobs. The default implementation returns the this.getOutput().

Parameters:

jobId - target job ID

Returns:

the target stream

Throws:

IOException - if failed to obtain output

onJobMonitorClosed

protected void onJobMonitorClosed(String jobId)
                           throws IOException

Notifies the job was closed. The default implementation does nothing.

Parameters:

jobId - target job ID

Throws:

IOException - if failed to notify this event