org.eclipse.rse.services.search
Interface IHostSearchResult

All Known Subinterfaces:

IRemoteSearchResult

All Known Implementing Classes:

AbstractSearchResult, RemoteSearchResult

public interface IHostSearchResult

Field Summary

static String	SEARCH_RESULT_CLOSE_DELIMITER
static String	SEARCH_RESULT_DELIMITER
static String	SEARCH_RESULT_INDEX_DELIMITER
static String	SEARCH_RESULT_OPEN_DELIMITER

Method Summary

void	addMatch(int startOffset, int endOffset) Add a match to the result.
String	getAbsolutePath() Gets the path to the file that this output references if it references any.
int	getCharEnd(int matchIndex) Gets the char end offset for the given match index.
int	getCharStart(int matchIndex) Gets the char start offset for the given match index.
IHostSearchResultConfiguration	getConfiguration()
int	getIndex() Gets the index of this search result in the context of its parent.
int	getLine()
SystemSearchString	getMatchingSearchString() Gets the search string that this result matches.
Object	getParent()
String	getText() Gets the text to display for a search result.
int	numOfMatches() Gets the number of matches in this line.
void	setParent(Object parent)

Field Detail

SEARCH_RESULT_DELIMITER

public static final String SEARCH_RESULT_DELIMITER

See Also:

Constant Field Values

SEARCH_RESULT_OPEN_DELIMITER

public static final String SEARCH_RESULT_OPEN_DELIMITER

See Also:

Constant Field Values

SEARCH_RESULT_CLOSE_DELIMITER

public static final String SEARCH_RESULT_CLOSE_DELIMITER

See Also:

Constant Field Values

SEARCH_RESULT_INDEX_DELIMITER

public static final String SEARCH_RESULT_INDEX_DELIMITER

See Also:

Constant Field Values

Method Detail

setParent

public void setParent(Object parent)

getParent

public Object getParent()

getLine

public int getLine()

getMatchingSearchString

public SystemSearchString getMatchingSearchString()

Gets the search string that this result matches.

Returns:

the search string.

getAbsolutePath

public String getAbsolutePath()

Gets the path to the file that this output references if it references any. It may return null if no such association exists. This may be used to jump to an editor from a view which displays this

Returns:

the path of the referenced file if there is one

getText

public String getText()

Gets the text to display for a search result.

Returns:

the text.

getIndex

public int getIndex()

Gets the index of this search result in the context of its parent.

Returns:

the index.

addMatch

public void addMatch(int startOffset,
                     int endOffset)

Add a match to the result. A match comprises a char start offset and a char end offset, both relative to the beginning of the file. The matches are added in order.

Parameters:

startOffset - the char start offset, from the beginning of the file.

endOffset - the char end offset, from the beginning of the file.

numOfMatches

public int numOfMatches()

Gets the number of matches in this line.

Returns:

the number of matches.

getCharStart

public int getCharStart(int matchIndex)

Gets the char start offset for the given match index.

Parameters:

matchIndex - the match index. For example, to get the start offset for the first match, specify 0.

Returns:

the char start offset.

getCharEnd

public int getCharEnd(int matchIndex)

Gets the char end offset for the given match index.

Parameters:

matchIndex - the match index. For example, to get the end offset for the first match, specify 0.

Returns:

the char end offset.

getConfiguration

public IHostSearchResultConfiguration getConfiguration()