Class PhonTask

java.lang.Object

ca.phon.worker.PhonTask

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AbstractPluginEntryPoint, PhonTalkTask, ProjectArchiveTask, QueryTask, SessionMerger, VLCMediaExporter

public abstract class PhonTask
extends Object
implements Runnable

A task to be run on a worker thread which includes properties for progress and status.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PhonTask.TaskStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected Exception	err	If an exception was caught during the run method, it's stored here
static final String	PROGRESS_PROP	Task progress property Float Percentage done [0.0-1.0] or invalid input: '<' 0 if inderterminate
protected ConcurrentHashMap<String,Object>	props	Props
static final String	STATUS_PROP	Task status property.

Constructor Summary

Constructors

Constructor	Description
PhonTask()
PhonTask(String taskName)

Method Summary

Modifier and Type	Method	Description
void	addTaskListener(PhonTaskListener l)
protected void	firePropertyChange(String prop, Object oldValue, Object newValue)
protected void	fireStatusChange(PhonTask.TaskStatus oldStatus, PhonTask.TaskStatus newStatus)
Exception	getException()
String	getName()
Object	getProperty(String prop)
long	getRunTime()
long	getStartTime()
PhonTask.TaskStatus	getStatus()
boolean	isShutdown()
abstract void	performTask()	The abstract run method.
void	removeTaskListener(PhonTaskListener l)
void	run()
void	setName(String name)
protected void	setProperty(String prop, Object val)
protected void	setStatus(PhonTask.TaskStatus s)
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Details

PROGRESS_PROP

public static final String PROGRESS_PROP

Task progress property Float Percentage done [0.0-1.0] or invalid input: '<' 0 if inderterminate

See Also:

• Constant Field Values

STATUS_PROP

public static final String STATUS_PROP

Task status property. Holds current status test (optional)

See Also:

• Constant Field Values

err

protected Exception err

If an exception was caught during the run method, it's stored here

props

protected ConcurrentHashMap<String,Object> props

Props

Constructor Details

PhonTask

public PhonTask()

PhonTask

public PhonTask(String taskName)

Method Details

getStartTime

public long getStartTime()

getRunTime

public long getRunTime()

run

public void run()

Specified by:

run in interface Runnable

performTask

public abstract void performTask()

The abstract run method. This method must be implemented by all subclasses.

shutdown

public void shutdown()

isShutdown

public boolean isShutdown()

setStatus

protected void setStatus(PhonTask.TaskStatus s)

getStatus

public PhonTask.TaskStatus getStatus()

getName

public String getName()

setName

public void setName(String name)

getException

public Exception getException()

getProperty

public Object getProperty(String prop)

setProperty

protected void setProperty(String prop,
 Object val)

addTaskListener

public void addTaskListener(PhonTaskListener l)

removeTaskListener

public void removeTaskListener(PhonTaskListener l)

firePropertyChange

protected void firePropertyChange(String prop,
 Object oldValue,
 Object newValue)

fireStatusChange

protected void fireStatusChange(PhonTask.TaskStatus oldStatus,
 PhonTask.TaskStatus newStatus)