info.textgrid.lab.search

Class AbstractRequest

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

info.textgrid.lab.search.AbstractRequest

All Implemented Interfaces:

Comparable, IAdaptable

public abstract class AbstractRequest
extends Job

A single request to TG-search. You should derive from this abstract class and then initialize the request with a field and a query string and then #Request.schedule() it. At any time, you can retrieve the current results filtered for a given substring with getResultsFor(String). You should Job.cancel() a job that you need no longer.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	field
protected String	query

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
AbstractRequest(String field, String query) Create a new request.

Method Summary

Modifier and Type	Method and Description
protected void	addAllProposals(Collection<String> proposals)
protected void	addProposal(String proposal)
Iterable<String>	getResultsFor(String query) returns the currently available results of this job filtered for the new query given as an argument.
boolean	isApplicableFor(String query) returns true if this job is applicable for the given query, i.e.
protected abstract IStatus	run(IProgressMonitor monitor)

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

addJobChangeListener, belongsTo, cancel, canceling, create, 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

Field Detail

query

protected final String query

field

protected final String field

Constructor Detail

AbstractRequest

public AbstractRequest(String field,
                       String query)

Create a new request. You need to Job.schedule() it to let it run.

Parameters:

field - the field to query

query - the substring to search for

Method Detail

isApplicableFor

public boolean isApplicableFor(String query)

returns true if this job is applicable for the given query, i.e. if getResultsFor(query) will return meaningful results.

getResultsFor

public Iterable<String> getResultsFor(String query)

returns the currently available results of this job filtered for the new query given as an argument.

See Also:

isApplicableFor(String)

addProposal

protected void addProposal(String proposal)

addAllProposals

protected void addAllProposals(Collection<String> proposals)

run

protected abstract IStatus run(IProgressMonitor monitor)

Specified by:

run in class Job