public interface ISearchEngineResult
This interface is inteded to be implemented by clients.
Modifier and Type | Method and Description |
---|---|
IHelpResource |
getCategory()
Returns a category this search result belongs to.
|
String |
getDescription()
Returns the short description of the search result.
|
boolean |
getForceExternalWindow()
Tests if the result link must be shown in an external web browser/Help
window, or it can also be shown embedded.
|
String |
getHref()
Returns the URL (as a string) associated with this help resource.
|
String |
getLabel()
Returns the label of the search result to use in the UI.
|
float |
getScore()
Returns a float number in the range between 0 and 1 that can be used to
sort the hits by relevance (1 being the perfect result).
|
String |
toAbsoluteHref(String href,
boolean frames)
Converts a relative href into absolute according to the search engine
base URL.
|
String getLabel()
String getDescription()
null
if not available.IHelpResource getCategory()
IHelpResource
allows search result UI to create a link to
the category.null
if not available.String getHref()
Valid URL of a help resource is:
float getScore()
boolean getForceExternalWindow()
Note that returning false
does not prevent the link to be
opened in the external window. Instead, it indicates that the link should
be opened using the current user preferences, which may always force
external window for URL rendering.
true
if external window must be used,
false
if the link opening mode can be chosen by
the help system.String toAbsoluteHref(String href, boolean frames)
href
- the relative href to convert into absoluteframes
- if true
, the resulting href can contain frames
in a format suitable for presentation in a standalone web
browser. Otherwise, the resulting href should be without
frames and suitable for presentation in the embedded web
browser inside the workbench.
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.