MOA 12.03
Real Time Analytics for Data Streams
moa.tasks.StandardTaskMonitor Class Reference

Class that represents a standard task monitor. More...

Inheritance diagram for moa.tasks.StandardTaskMonitor:
Collaboration diagram for moa.tasks.StandardTaskMonitor:

List of all members.

Public Member Functions

void setCurrentActivity (String activityDescription, double fracComplete)
 Sets the description and the percentage done of the current activity.
void setCurrentActivityDescription (String activity)
 Sets the description of the current activity.
void setCurrentActivityFractionComplete (double fracComplete)
 Sets the percentage done of the current activity.
boolean taskShouldAbort ()
 Gets whether the task should abort.
String getCurrentActivityDescription ()
 Gets the description of the current activity.
double getCurrentActivityFractionComplete ()
 Gets the percentage done of the current activity.
boolean isCancelled ()
 Gets whether the task monitored is cancelled.
void requestCancel ()
 Requests the task monitored to cancel.
void requestPause ()
 Requests the task monitored to pause.
synchronized void requestResume ()
 Requests the task monitored to resume.
boolean isPaused ()
 Gets whether the task monitored is paused.
Object getLatestResultPreview ()
 Gets the current result to preview.
void requestResultPreview ()
 Requests to preview the task result.
void requestResultPreview (ResultPreviewListener toInform)
 Requests to preview the task result.
boolean resultPreviewRequested ()
 Gets whether there is a request for preview the task result.
synchronized void setLatestResultPreview (Object latestPreview)
 Sets the current result to preview.

Protected Attributes

String currentActivityDescription = ""
double currentActivityFractionComplete = -1.0
volatile boolean cancelFlag = false
volatile boolean pauseFlag = false
volatile boolean isComplete = false
volatile boolean resultPreviewRequested = false
volatile Object latestResultPreview = null
volatile ResultPreviewListener resultPreviewer = null

Detailed Description

Class that represents a standard task monitor.

Author:
Richard Kirkby (rkirkby@cs.waikato.ac.nz)
Version:
Revision:
7

Definition at line 28 of file StandardTaskMonitor.java.


Member Function Documentation

String moa.tasks.StandardTaskMonitor.getCurrentActivityDescription ( )

Gets the description of the current activity.

Returns:
the description of the current activity

Implements moa.tasks.TaskMonitor.

Definition at line 79 of file StandardTaskMonitor.java.

double moa.tasks.StandardTaskMonitor.getCurrentActivityFractionComplete ( )

Gets the percentage done of the current activity.

Returns:
the percentage done of the current activity

Implements moa.tasks.TaskMonitor.

Definition at line 84 of file StandardTaskMonitor.java.

Object moa.tasks.StandardTaskMonitor.getLatestResultPreview ( )

Gets the current result to preview.

Returns:
the result to preview

Implements moa.tasks.TaskMonitor.

Definition at line 116 of file StandardTaskMonitor.java.

boolean moa.tasks.StandardTaskMonitor.isCancelled ( )

Gets whether the task monitored is cancelled.

Returns:
true if the task is cancelled

Implements moa.tasks.TaskMonitor.

Definition at line 89 of file StandardTaskMonitor.java.

boolean moa.tasks.StandardTaskMonitor.isPaused ( )

Gets whether the task monitored is paused.

Returns:
true if the task is paused

Implements moa.tasks.TaskMonitor.

Definition at line 111 of file StandardTaskMonitor.java.

void moa.tasks.StandardTaskMonitor.requestCancel ( )

Requests the task monitored to cancel.

Implements moa.tasks.TaskMonitor.

Definition at line 94 of file StandardTaskMonitor.java.

Here is the call graph for this function:

void moa.tasks.StandardTaskMonitor.requestPause ( )

Requests the task monitored to pause.

Implements moa.tasks.TaskMonitor.

Definition at line 100 of file StandardTaskMonitor.java.

void moa.tasks.StandardTaskMonitor.requestResultPreview ( )

Requests to preview the task result.

Implements moa.tasks.TaskMonitor.

Definition at line 121 of file StandardTaskMonitor.java.

Here is the call graph for this function:

void moa.tasks.StandardTaskMonitor.requestResultPreview ( ResultPreviewListener  toInform)

Requests to preview the task result.

Parameters:
toInformthe listener of the changes in the preview of the result

Implements moa.tasks.TaskMonitor.

Definition at line 126 of file StandardTaskMonitor.java.

Here is the call graph for this function:

synchronized void moa.tasks.StandardTaskMonitor.requestResume ( )

Requests the task monitored to resume.

Implements moa.tasks.TaskMonitor.

Definition at line 105 of file StandardTaskMonitor.java.

Referenced by moa.tasks.StandardTaskMonitor.requestCancel().

Here is the caller graph for this function:

Gets whether there is a request for preview the task result.

Returns:
true if there is a request for preview the task result

Implements moa.tasks.TaskMonitor.

Definition at line 132 of file StandardTaskMonitor.java.

Referenced by moa.tasks.StandardTaskMonitor.requestResultPreview(), and moa.tasks.StandardTaskMonitor.setLatestResultPreview().

Here is the caller graph for this function:

void moa.tasks.StandardTaskMonitor.setCurrentActivity ( String  activityDescription,
double  fracComplete 
)

Sets the description and the percentage done of the current activity.

Parameters:
activitythe description of the current activity
fracCompletethe percentage done of the current activity

Implements moa.tasks.TaskMonitor.

Definition at line 47 of file StandardTaskMonitor.java.

Here is the call graph for this function:

void moa.tasks.StandardTaskMonitor.setCurrentActivityDescription ( String  activity)

Sets the description of the current activity.

Parameters:
activitythe description of the current activity

Implements moa.tasks.TaskMonitor.

Definition at line 54 of file StandardTaskMonitor.java.

Referenced by moa.tasks.StandardTaskMonitor.setCurrentActivity().

Here is the caller graph for this function:

void moa.tasks.StandardTaskMonitor.setCurrentActivityFractionComplete ( double  fracComplete)

Sets the percentage done of the current activity.

Parameters:
fracCompletethe percentage done of the current activity

Implements moa.tasks.TaskMonitor.

Definition at line 59 of file StandardTaskMonitor.java.

Referenced by moa.tasks.StandardTaskMonitor.setCurrentActivity().

Here is the caller graph for this function:

synchronized void moa.tasks.StandardTaskMonitor.setLatestResultPreview ( Object  latestPreview)

Sets the current result to preview.

Parameters:
latestPreviewthe result to preview

Implements moa.tasks.TaskMonitor.

Definition at line 137 of file StandardTaskMonitor.java.

Here is the call graph for this function:

boolean moa.tasks.StandardTaskMonitor.taskShouldAbort ( )

Gets whether the task should abort.

Returns:
true if the task should abort

Implements moa.tasks.TaskMonitor.

Definition at line 64 of file StandardTaskMonitor.java.


Member Data Documentation

volatile boolean moa.tasks.StandardTaskMonitor.isComplete = false [protected]

Definition at line 38 of file StandardTaskMonitor.java.

volatile boolean moa.tasks.StandardTaskMonitor.resultPreviewRequested = false [protected]

Definition at line 40 of file StandardTaskMonitor.java.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations