info.textgrid.lab.collatex.process

Class CollateJob

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

info.textgrid.lab.collatex.process.CollateJob

All Implemented Interfaces:

Comparable, IAdaptable

public class CollateJob
extends Job

Performs the actual collation including all the long-running operations that are required for this. Clients instantiate this class with the model information required to perform the collation and schedule it when the user wants to perform the collation. They should register a IJobChangeListener and retrieve the status and collation results when the collation has finished. The job reports progress and supports cancellation, but especially for large collation sets it may take a while until it reacts to a cancel operation.

Field Summary

Fields inherited from class org.eclipse.core.runtime.jobs.Job

ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING

Fields inherited from class org.eclipse.core.internal.jobs.InternalJob

manager

Constructor Summary

Constructors

Constructor and Description
CollateJob(String name, CollationSet collationSet)

Method Summary

Methods

Modifier and Type	Method and Description
CollationResults	getCollationResults()
CollationSet	getCollationSet()
VariantGraph	getVariantGraph() Returns the VariantGraph created by the collation process, or null if the job has not started yet.
protected IStatus	run(IProgressMonitor monitor)

Methods inherited from class org.eclipse.core.runtime.jobs.Job

addJobChangeListener, belongsTo, cancel, canceling, done, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule

Methods inherited from class org.eclipse.core.internal.jobs.InternalJob

compareTo

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Constructor Detail

CollateJob

public CollateJob(String name,
          CollationSet collationSet)

Method Detail

getCollationResults

public CollationResults getCollationResults()

run

protected IStatus run(IProgressMonitor monitor)

Specified by:

run in class Job

getCollationSet

public CollationSet getCollationSet()

getVariantGraph

public VariantGraph getVariantGraph()

Returns the VariantGraph created by the collation process, or null if the job has not started yet. Warning: It is possible to retrieve a VariantGraph while the job is still running, but results may be undefined. I.e. you don't want to do that.