de.esprit.appsuite.gui.task

Class SwingTaskMonitor<C extends ApplicationContext>

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.appsuite.launch.AbstractApplicationObject<C>

de.esprit.appsuite.task.monitor.AbstractTaskMonitor<C>

de.esprit.appsuite.gui.task.SwingTaskMonitor<C>

All Implemented Interfaces:

ApplicationObject<C>, TaskMonitor<C>, TaskEvent.Source, SimpleLogSupport, Dumpable

public class SwingTaskMonitor<C extends ApplicationContext>
extends AbstractTaskMonitor<C>
implements TaskEvent.Source

This monitor is being notified by a running AsyncTask about it's RunState changes. It converts the asynchronous RunState change notifications to thread-safe TaskEvents which you can register for. The events can i.e. be used for driving a ZProgressBar.

Note that this monitor does nothing when it is running in a non graphics environment (headless).

Author:

Rainer Buesch

Constructor Summary

Constructors

Constructor and Description
SwingTaskMonitor(C ctx)
SwingTaskMonitor(C ctx, LogChannel logCh)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(RunState stateFlag) May be overridden to filter the RunState before actually firing a TaskEvent.
void	addTaskListener(TaskEvent.Listener l)
int	getTaskListenerCount()
protected boolean	isAutoReportError()
void	removeTaskListener(TaskEvent.Listener l)
void	setAutoReportError(boolean isAutoReportError) Tells whether a a GUI error dialog should be raised on failure.
void	setBlockingEventNotification(boolean isBlocking)
void	setTestMode(boolean isTestMode)
void	taskCancelled(RunStateFlag stateFlag) Called when the async task has discovered that it was cancelled
void	taskChildFinished(RunStateFlag stateFlag) Indicates that a child task has been finished.
void	taskChildStarted(RunStateFlag stateFlag) Indicates that a child task has been started.
void	taskChildSucceeded(RunStateFlag stateFlag, java.lang.Object result) Indicates that a child task has been succeeded with the given result.
void	taskFailed(RunStateFlag stateFlag, java.lang.Exception error) Called when the async task failed
void	taskFinished(RunStateFlag stateFlag) Called when the async task finished
void	taskProceeded(RunStateFlag stateFlag, java.lang.Object info, int step, int maxSteps, java.lang.String message) Is called on task progress.
void	taskStarted(RunStateFlag stateFlag) Called when the async task started
void	taskSucceeded(RunStateFlag stateFlag, java.lang.Object result) Called when the async task succeeded

Methods inherited from class de.esprit.appsuite.launch.AbstractApplicationObject

getApplicationContext, getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toDumpString, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esprit.appsuite.launch.ApplicationObject

getApplicationContext

Constructor Detail

SwingTaskMonitor

public SwingTaskMonitor(C ctx)

SwingTaskMonitor

public SwingTaskMonitor(C ctx,
                LogChannel logCh)

Method Detail

setTestMode

public void setTestMode(boolean isTestMode)

setBlockingEventNotification

public void setBlockingEventNotification(boolean isBlocking)

taskStarted

public void taskStarted(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Called when the async task started

Specified by:

taskStarted in interface TaskMonitor<C extends ApplicationContext>

taskSucceeded

public void taskSucceeded(RunStateFlag stateFlag,
                 java.lang.Object result)

Description copied from interface: TaskMonitor

Called when the async task succeeded

Specified by:

taskSucceeded in interface TaskMonitor<C extends ApplicationContext>

taskCancelled

public void taskCancelled(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Called when the async task has discovered that it was cancelled

Specified by:

taskCancelled in interface TaskMonitor<C extends ApplicationContext>

taskFailed

public void taskFailed(RunStateFlag stateFlag,
              java.lang.Exception error)

Description copied from interface: TaskMonitor

Called when the async task failed

Specified by:

taskFailed in interface TaskMonitor<C extends ApplicationContext>

taskFinished

public void taskFinished(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Called when the async task finished

Specified by:

taskFinished in interface TaskMonitor<C extends ApplicationContext>

taskProceeded

public void taskProceeded(RunStateFlag stateFlag,
                 java.lang.Object info,
                 int step,
                 int maxSteps,
                 java.lang.String message)

Description copied from interface: TaskMonitor

Is called on task progress.

Specified by:

taskProceeded in interface TaskMonitor<C extends ApplicationContext>

info - may be anything the running task has produced (i.e. a DBRecord)

step - the number of steps performed

maxSteps - the maximum number of steps expected (0 if not known)

taskChildStarted

public void taskChildStarted(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Indicates that a child task has been started. Note that the child's taskId will be available from the RunState's taskId by RunStateFlag.getCurrentChild();

Specified by:

taskChildStarted in interface TaskMonitor<C extends ApplicationContext>

taskChildSucceeded

public void taskChildSucceeded(RunStateFlag stateFlag,
                      java.lang.Object result)

Description copied from interface: TaskMonitor

Indicates that a child task has been succeeded with the given result.

Specified by:

taskChildSucceeded in interface TaskMonitor<C extends ApplicationContext>

taskChildFinished

public void taskChildFinished(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Indicates that a child task has been finished.

Specified by:

taskChildFinished in interface TaskMonitor<C extends ApplicationContext>

accept

public boolean accept(RunState stateFlag)

May be overridden to filter the RunState before actually firing a TaskEvent. By default firing only happens, when there are listeners.

Specified by:

accept in interface TaskMonitor<C extends ApplicationContext>

Overrides:

accept in class AbstractTaskMonitor<C extends ApplicationContext>

isAutoReportError

protected boolean isAutoReportError()

See Also:

setAutoReportError(boolean)

setAutoReportError

public void setAutoReportError(boolean isAutoReportError)

Tells whether a a GUI error dialog should be raised on failure.

Parameters:

isAutoReportError - is by default true

See Also:

isAutoReportError()

addTaskListener

public final void addTaskListener(TaskEvent.Listener l)

Specified by:

addTaskListener in interface TaskEvent.Source

removeTaskListener

public final void removeTaskListener(TaskEvent.Listener l)

Specified by:

removeTaskListener in interface TaskEvent.Source

getTaskListenerCount

public final int getTaskListenerCount()