edu.buffalo.cse.jive.ui.search
Interface IJiveSearchQuery

All Superinterfaces:

ISearchQuery

All Known Implementing Classes:

AbstractJiveSearchQuery, ExceptionCaughtSearchQuery, ExecutionHistorySearchQuery, InvariantViolatedSearchQuery, LineExecutedSearchQuery, MethodCalledSearchQuery, MethodReturnedSearchQuery, ObjectCreatedSearchQuery, VariableChangedSearchQuery

public interface IJiveSearchQuery
extends ISearchQuery

An ISearchQuery used to represent a search query over an IJiveDebugTarget. Implementors should call performSearch(IProgressMonitor, IJiveDebugTarget) in ISearchQuery.run(IProgressMonitor) for each available target.

See Also:

ExecutionHistorySearchQuery

Method Summary

ImageDescriptor	getImageDescriptor() Returns an ImageDescriptor used to represent the search query's result in the Search view's 'Show Previous Searches' tool bar action.
String	getResultLabel(int matchCount) Returns a label describing the search result used in the Search view.
Class<? extends Object>	getResultType() Returns the type of search result matches collected by the search query.
IStatus	performSearch(IProgressMonitor monitor, IJiveDebugTarget target) Performs the query over the given IJiveDebugTarget using the supplied IProgressMonitor.

Methods inherited from interface org.eclipse.search.ui.ISearchQuery

canRerun, canRunInBackground, getLabel, getSearchResult, run

Method Detail

performSearch

IStatus performSearch(IProgressMonitor monitor,
                      IJiveDebugTarget target)

Performs the query over the given IJiveDebugTarget using the supplied IProgressMonitor. Implementors can call this method for each target in existence.

Parameters:

monitor - the progress monitor of the search

target - the target to search

Returns:

the status after completing the search

getResultType

Class<? extends Object> getResultType()

Returns the type of search result matches collected by the search query. This is used by the Search view to determine how to display the search result tabularly.

NOTE: This will be changed in the future. For now, return Event.class for a result containing matches of mixed event types or return the specific class literal for a result containing matches of a single event type (e.g., AssignEvent.class).

Returns:

the type of search result matches

getResultLabel

String getResultLabel(int matchCount)

Returns a label describing the search result used in the Search view. Typically, this describes what is being searched for and the number of matches, as supplied by matchCount.

Parameters:

matchCount - the number of matches thus far

Returns:

a description of what is being searched

getImageDescriptor

ImageDescriptor getImageDescriptor()

Returns an ImageDescriptor used to represent the search query's result in the Search view's 'Show Previous Searches' tool bar action.

Returns:

an image descriptor representing the result