com.reportmill.base

Class RMActivity

java.lang.Object

com.reportmill.base.RMListenerList

com.reportmill.base.RMObject

com.reportmill.base.RMActivity

All Implemented Interfaces:

RMPropertyChanger, RMUtils.ProgressListener, java.lang.Cloneable, java.lang.Runnable

Direct Known Subclasses:

RMActivityList

public abstract class RMActivity
extends RMObject
implements java.lang.Runnable, RMUtils.ProgressListener

This class represents an activity to be performed in a background thread with the ability to monitor progress, cancel, log information and respond to problems.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RMActivity.Status

Constructor Summary

Constructors

Constructor and Description
RMActivity()

Method Summary

Methods

Modifier and Type	Method and Description
RMLogger	createLogger() Creates the default activity logger.
java.lang.Throwable	getError() Returns the error (throwable) if one was generated from last run.
java.lang.StringBuffer	getLog() Returns the activity log.
RMLogger	getLogger() Returns the activity logger.
java.lang.String	getLogString() Returns the activity log string.
float	getMaxProgress() Returns the max progress value.
java.lang.String	getName() Returns the activity name.
float	getProgress() Returns the current progress value.
RMActivity.Status	getStatus() Returns the activity status.
java.lang.String	getTaskName() Returns the current task name.
java.lang.Thread	getThread() Returns the thread associated with this activity.
void	interrupt() Interrupts the activity thread.
boolean	isIndeterminant() Returns whether activity progress is indeterminant (max progres is zero).
void	println(java.lang.String aString) Called when activity has something to say (forwards to listeners).
abstract void	run() This is the primary run method which should contain only the custom run tasks.
void	runActivity() This method runs the activity, in the current thread.
void	setError(java.lang.Throwable anError) Sets the error (throwable) if one was generated from last run.
void	setLogger(RMLogger aLogger) Sets the activity logger.
void	setMaxProgress(float aValue) Sets the maximum progress value.
void	setName(java.lang.String aName) Sets the activity name.
void	setProgress(float aValue) Sets the current progress value.
void	setStatus(RMActivity.Status aStatus) Sets the activity status.
void	setTaskName(java.lang.String aName) Sets the current task name.
void	start() Starts the activity in a separate thread.

Methods inherited from class com.reportmill.base.RMObject

addPropertyChangeListener, animUpdate, removePropertyChangeListener, toString

Methods inherited from class com.reportmill.base.RMListenerList

addListener, clone, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMActivity

public RMActivity()

Method Detail

getName

public java.lang.String getName()

Returns the activity name.

setName

public void setName(java.lang.String aName)

Sets the activity name.

getStatus

public RMActivity.Status getStatus()

Returns the activity status.

setStatus

public void setStatus(RMActivity.Status aStatus)

Sets the activity status.

getTaskName

public java.lang.String getTaskName()

Returns the current task name.

setTaskName

public void setTaskName(java.lang.String aName)

Sets the current task name.

getProgress

public float getProgress()

Returns the current progress value.

Specified by:

getProgress in interface RMUtils.ProgressListener

setProgress

public void setProgress(float aValue)

Sets the current progress value.

Specified by:

setProgress in interface RMUtils.ProgressListener

getMaxProgress

public float getMaxProgress()

Returns the max progress value.

Specified by:

getMaxProgress in interface RMUtils.ProgressListener

setMaxProgress

public void setMaxProgress(float aValue)

Sets the maximum progress value.

Specified by:

setMaxProgress in interface RMUtils.ProgressListener

isIndeterminant

public boolean isIndeterminant()

Returns whether activity progress is indeterminant (max progres is zero).

getLogger

public RMLogger getLogger()

Returns the activity logger.

setLogger

public void setLogger(RMLogger aLogger)

Sets the activity logger.

createLogger

public RMLogger createLogger()

Creates the default activity logger.

getLog

public java.lang.StringBuffer getLog()

Returns the activity log.

getLogString

public java.lang.String getLogString()

Returns the activity log string.

getThread

public java.lang.Thread getThread()

Returns the thread associated with this activity.

getError

public java.lang.Throwable getError()

Returns the error (throwable) if one was generated from last run.

setError

public void setError(java.lang.Throwable anError)

Sets the error (throwable) if one was generated from last run.

runActivity

public void runActivity()

This method runs the activity, in the current thread.

run

public abstract void run()

This is the primary run method which should contain only the custom run tasks.

Specified by:

run in interface java.lang.Runnable

start

public void start()

Starts the activity in a separate thread.

interrupt

public void interrupt()

Interrupts the activity thread.

println

public void println(java.lang.String aString)

Called when activity has something to say (forwards to listeners).