com.ibm.xtools.emf.index.util

Class QueryJob<T>

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

com.ibm.xtools.emf.index.util.QueryJob<T>

All Implemented Interfaces:

java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public abstract class QueryJob<T>
extends org.eclipse.core.runtime.jobs.Job

Utility class that extends the org.eclipse.core.runtime.jobs.Job class to run the queries asynchronously. This job is a user job by default.

Usage:

     Create the job:
      QueryJob job = new QueryJob("Example Query") {
          protected Collection doRun(IProgressMonitor monitor) {
              // create the index context
              IndexContext context = IndexContext.createDefaultContext(new ResourceSetImpl());
                   
              // run the query
              Collection result = Collections.EMPTY_LIST;
              result = IIndexSearchManager.INSTANCE.findEObjects(context, EXTLibraryPackage.eINSTANCE.
              .getBookOnTape(), monitor);
                   
              // return the result
              return result;
          };
      };
    
     Schedule the job:
      job.schedule();
      
     Get the results:
      job.getResults();   
 

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
QueryJob(java.lang.String name) The constructor

Method Summary

Modifier and Type	Method and Description
boolean	belongsTo(java.lang.Object family)
protected abstract java.util.Collection<T>	doRun(org.eclipse.core.runtime.IProgressMonitor monitor) Runs this query.
java.lang.String	getJobFamily() Returns the family
java.util.Collection<T>	getResults() Returns the results
protected org.eclipse.core.runtime.IStatus	run(org.eclipse.core.runtime.IProgressMonitor monitor)

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

addJobChangeListener, cancel, canceling, create, create, createSystem, createSystem, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, 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

QueryJob

public QueryJob(java.lang.String name)

The constructor

Parameters:

name - the name of the job

Method Detail

belongsTo

public final boolean belongsTo(java.lang.Object family)

Overrides:

belongsTo in class org.eclipse.core.runtime.jobs.Job

getJobFamily

public final java.lang.String getJobFamily()

Returns the family

Returns:

the family.

getResults

public final java.util.Collection<T> getResults()

Returns the results

Returns:

the results.

run

protected final org.eclipse.core.runtime.IStatus run(org.eclipse.core.runtime.IProgressMonitor monitor)

Specified by:

run in class org.eclipse.core.runtime.jobs.Job

doRun

protected abstract java.util.Collection<T> doRun(org.eclipse.core.runtime.IProgressMonitor monitor)

Runs this query. Progress should be reported to the given progress monitor. This method is usually invoked by the QueryJob's run method, which supplies the progress monitor. A request to cancel the operation should be honored and acknowledged by throwing OperationCanceledException.

Parameters:

monitor - the progress monitor to use to display progress and receive requests for cancelation

Returns:

the result set or an empty list

Throws:

org.eclipse.core.runtime.OperationCanceledException - if the operation detects a request to cancel, using IProgressMonitor.isCanceled(), it should exit by throwing OperationCanceledException