edu.buffalo.cse.jive.ui.search
Class AbstractJiveSearchQuery

java.lang.Object
  edu.buffalo.cse.jive.ui.search.AbstractJiveSearchQuery

All Implemented Interfaces:

IJiveSearchQuery, ISearchQuery

Direct Known Subclasses:

ExecutionHistorySearchQuery

public abstract class AbstractJiveSearchQuery
extends Object
implements IJiveSearchQuery

An abstract implementation of an IJiveSearchQuery. This class handles much of the common implementation details required by the ISearchQuery interface. The ISearchQuery.run(IProgressMonitor) method is implemented to call IJiveSearchQuery.performSearch(IProgressMonitor, IJiveDebugTarget) for each available target. It also handles updating the progress monitor and canceling searches.

See Also:

ISearchQuery, IJiveSearchQuery, IProgressMonitor

Constructor Summary

AbstractJiveSearchQuery()

Method Summary

boolean	canRerun()
boolean	canRunInBackground()
protected IJiveSearchResult	createSearchResult() Creates the search result to use for the query.
String	getLabel()
ISearchResult	getSearchResult()
IStatus	run(IProgressMonitor monitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.buffalo.cse.jive.ui.search.IJiveSearchQuery

getImageDescriptor, getResultLabel, getResultType, performSearch

Constructor Detail

AbstractJiveSearchQuery

public AbstractJiveSearchQuery()

Method Detail

run

public IStatus run(IProgressMonitor monitor)
            throws OperationCanceledException

Specified by:

run in interface ISearchQuery

Throws:

OperationCanceledException

canRerun

public boolean canRerun()

Specified by:

canRerun in interface ISearchQuery

canRunInBackground

public boolean canRunInBackground()

Specified by:

canRunInBackground in interface ISearchQuery

getSearchResult

public ISearchResult getSearchResult()

Specified by:

getSearchResult in interface ISearchQuery

getLabel

public String getLabel()

Specified by:

getLabel in interface ISearchQuery

createSearchResult

protected IJiveSearchResult createSearchResult()

Creates the search result to use for the query. This method is called by getSearchResult() when initializing the search result.

This method may be overridden by subclasses to provide different types of search results.

NOTE: In the future a more robust form of search results will be provided with different ways of viewing it in the Search view.

Returns:

a newly created search result.