Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

org.eclipse.rse.subsystems.files.core.subsystems
Interface IRemoteSearchResult

All Superinterfaces:

IHostSearchResult, IRemoteLineReference

All Known Implementing Classes:

RemoteSearchResult

---

public interface IRemoteSearchResult
extends 
IRemoteLineReference, 
IHostSearchResult

This interface represents a handle to a search result.

---

Field Summary

 

Fields inherited from interface org.eclipse.rse.services.search. IHostSearchResult
SEARCH_RESULT_CLOSE_DELIMITER, SEARCH_RESULT_DELIMITER, SEARCH_RESULT_INDEX_DELIMITER, SEARCH_RESULT_OPEN_DELIMITER

 

Method Summary
void	addMatch (int startOffset, int endOffset)           Add a match to the result.
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.
int	getIndex ()           Gets the index of this search result in the context of its parent.
SystemSearchString	getMatchingSearchString ()           Gets the search string that this result matches.
String	getText ()           Gets the text to display for a search result.
int	numOfMatches ()           Gets the number of matches in this line.

 

Methods inherited from interface org.eclipse.rse.core.subsystems. IRemoteLineReference
getAbsolutePath, getCharEnd, getCharStart, getLine, getParent

 

Methods inherited from interface org.eclipse.rse.services.search. IHostSearchResult
getAbsolutePath, getConfiguration, getLine, getParent, setParent

 

Method Detail

getText

String getText()

Gets the text to display for a search result.

Specified by:

getText in interface IHostSearchResult

Returns:

the text.

---

getIndex

int getIndex()

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

Specified by:

getIndex in interface IHostSearchResult

Returns:

the index.

---

getMatchingSearchString

SystemSearchString getMatchingSearchString()

Gets the search string that this result matches.

Specified by:

getMatchingSearchString in interface IHostSearchResult

Returns:

the search string.

---

addMatch

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.

Specified by:

addMatch in interface IHostSearchResult

Parameters:

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

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

---

numOfMatches

int numOfMatches()

Gets the number of matches in this line.

Specified by:

numOfMatches in interface IHostSearchResult

Returns:

the number of matches.

---

getCharStart

int getCharStart(int matchIndex)

Gets the char start offset for the given match index.

Specified by:

getCharStart in interface IHostSearchResult

Parameters:

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

Returns:

the char start offset.

---

getCharEnd

int getCharEnd(int matchIndex)

Gets the char end offset for the given match index.

Specified by:

getCharEnd in interface IHostSearchResult

Parameters:

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

Returns:

the char end offset.

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.