Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

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

static final 
String SEARCH_RESULT_DELIMITER
See Also:
Constant Field Values

SEARCH_RESULT_OPEN_DELIMITER

static final 
String SEARCH_RESULT_OPEN_DELIMITER
See Also:
Constant Field Values

SEARCH_RESULT_CLOSE_DELIMITER

static final 
String SEARCH_RESULT_CLOSE_DELIMITER
See Also:
Constant Field Values

SEARCH_RESULT_INDEX_DELIMITER

static final 
String SEARCH_RESULT_INDEX_DELIMITER
See Also:
Constant Field Values
Method Detail

setParent

void setParent(
Object parent)

getParent

Object getParent()

getLine

int getLine()

getMatchingSearchString

SystemSearchString getMatchingSearchString()
Gets the search string that this result matches.

Returns:
the search string.

getAbsolutePath

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

String getText()
Gets the text to display for a search result.

Returns:
the text.

getIndex

int getIndex()
Gets the index of this search result in the context of its parent.

Returns:
the index.

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.

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.

Returns:
the number of matches.

getCharStart

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

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

IHostSearchResultConfiguration getConfiguration()

RSE
Release 3.0

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

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire