com.asakusafw.yaess.basic

Class LoggingExecutionMonitor

java.lang.Object

com.asakusafw.yaess.core.PhaseMonitor

com.asakusafw.yaess.basic.LoggingExecutionMonitor

All Implemented Interfaces:

ExecutionMonitor, Closeable, AutoCloseable

public class LoggingExecutionMonitor
extends PhaseMonitor

An implementation of ExecutionMonitor using default logger.

Since:

0.2.3

Nested Class Summary

Nested classes/interfaces inherited from class com.asakusafw.yaess.core.PhaseMonitor

PhaseMonitor.JobStatus

Field Summary

Fields inherited from class com.asakusafw.yaess.core.PhaseMonitor

NULL

Constructor Summary

Constructors

Constructor and Description
LoggingExecutionMonitor(ExecutionContext context, double stepUnit) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close() Ends the current task and notify this event to the corresponding receiver.
protected void	onJobMonitorClosed(String jobId) Notifies the job was closed.
protected void	onJobMonitorOpened(String jobId) Notifies the job was opened.
void	open(double taskSize) Begins a task and notify this event to the corresponding receiver.
void	progressed(double deltaSize) Progresses the current task and notify this event to the corresponding receiver.
void	reportJobStatus(String jobId, PhaseMonitor.JobStatus status, Throwable cause) Reports job status about target job ID.
void	setProgress(double workedSize) Sets the progress of current task and notify this event to the corresponding receiver.

Methods inherited from class com.asakusafw.yaess.core.PhaseMonitor

checkCancelled, createJobMonitor, getJobOutput, getOutput, isCancelRequested

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingExecutionMonitor

public LoggingExecutionMonitor(ExecutionContext context,
                               double stepUnit)

Creates a new instance.

Parameters:

context - current context

stepUnit - report unit for each progress size (0.0~1.0)

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

open

public void open(double taskSize)

Description copied from interface: ExecutionMonitor

Begins a task and notify this event to the corresponding receiver. This method can be invoked once for each object.

Parameters:

taskSize - the total task size

progressed

public void progressed(double deltaSize)

Description copied from interface: ExecutionMonitor

Progresses the current task and notify this event to the corresponding receiver.

Parameters:

deltaSize - the difference of progressed task size

setProgress

public void setProgress(double workedSize)

Description copied from interface: ExecutionMonitor

Sets the progress of current task and notify this event to the corresponding receiver.

Parameters:

workedSize - the absolute progressed task size

onJobMonitorOpened

protected void onJobMonitorOpened(String jobId)

Description copied from class: PhaseMonitor

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

Overrides:

onJobMonitorOpened in class PhaseMonitor

Parameters:

jobId - target job ID

onJobMonitorClosed

protected void onJobMonitorClosed(String jobId)

Description copied from class: PhaseMonitor

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

Overrides:

onJobMonitorClosed in class PhaseMonitor

Parameters:

jobId - target job ID

reportJobStatus

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

Description copied from class: PhaseMonitor

Reports job status about target job ID.

Specified by:

reportJobStatus in class PhaseMonitor

Parameters:

jobId - target job ID

status - the job status

cause - occurred exception (nullable)

Throws:

IOException - if failed to notify this event

close

public void close()

Description copied from interface: ExecutionMonitor

Ends the current task and notify this event to the corresponding receiver.