edu.buffalo.cse.jive.ui.search.queries
Class LineExecutedSearchQuery

java.lang.Object
  edu.buffalo.cse.jive.ui.search.AbstractJiveSearchQuery
      edu.buffalo.cse.jive.ui.search.ExecutionHistorySearchQuery
          edu.buffalo.cse.jive.ui.search.queries.LineExecutedSearchQuery

All Implemented Interfaces:

SequenceModel.EventVisitor, IJiveSearchQuery, ISearchQuery

public class LineExecutedSearchQuery
extends ExecutionHistorySearchQuery

An IJiveSearchQuery that is used to check whether a line is executed. A relative path of a Java source file and a line number are required as input. The query returns a match for each time the line is executed.

Field Summary

protected int	lineNumber A line number within the source file.
protected String	sourcePath A relative path to the source file of interest.

Constructor Summary

LineExecutedSearchQuery(String sourcePath, int lineNumber)
Creates a new search query with the supplied source path and line number.

Method Summary

protected boolean	checkForMatch(EOSEvent event) Checks if the supplied event matches the query input.
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.
void	visit(EventOccurrence event) Visits an EventOccurrernce (other than a MessageSend).
void	visit(MessageSend event) Visits an occurrence of a MessageSend event.

Methods inherited from class edu.buffalo.cse.jive.ui.search.ExecutionHistorySearchQuery

addMatch, performSearch

Methods inherited from class edu.buffalo.cse.jive.ui.search.AbstractJiveSearchQuery

canRerun, canRunInBackground, createSearchResult, getLabel, getSearchResult, run

Methods inherited from class java.lang.Object

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

Field Detail

sourcePath

protected String sourcePath

A relative path to the source file of interest.

lineNumber

protected int lineNumber

A line number within the source file.

Constructor Detail

LineExecutedSearchQuery

public LineExecutedSearchQuery(String sourcePath,
                               int lineNumber)

Creates a new search query with the supplied source path and line number.

Parameters:

sourcePath - the source path of the file

lineNumber - the line number of the file

Method Detail

getResultType

public Class<? extends Object> getResultType()

Description copied from interface: IJiveSearchQuery

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).

Specified by:

getResultType in interface IJiveSearchQuery

Overrides:

getResultType in class ExecutionHistorySearchQuery

Returns:

the type of search result matches

getResultLabel

public String getResultLabel(int matchCount)

Description copied from interface: IJiveSearchQuery

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

public ImageDescriptor getImageDescriptor()

Description copied from interface: IJiveSearchQuery

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

visit

public void visit(EventOccurrence event)

Description copied from interface: SequenceModel.EventVisitor

Visits an EventOccurrernce (other than a MessageSend).

Parameters:

event - the event occurrence being visited

visit

public void visit(MessageSend event)

Description copied from interface: SequenceModel.EventVisitor

Visits an occurrence of a MessageSend event.

Parameters:

event - the message send being visited

checkForMatch

protected boolean checkForMatch(EOSEvent event)

Checks if the supplied event matches the query input.

Parameters:

event - the end-of-statement event to check

Returns:

true if the source path and line number match, false otherwise