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

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.help.search
Interface ISearchEngine

All Known Subinterfaces:
ISearchEngine2

public interface ISearchEngine

A search engine that is a participant in the help search. All engines selected by the user to run are executed as background jobs using the same search expression. Engine is expected to accept the expression and the scope object. The results should be passed to the result collector object, and the search progress should be tracked by the progress monitor.

Search engines that have API access to the search server can provide a list of individual search results. Search engines for which only the URL is known are expected to return one search result containing a URL that is sufficient to open a web browser and see the search results there.

Search engine must be cancelable.

This interface is intended to be implemented by clients.

Since:
3.1

Method Summary
 void run ( String query, ISearchScope scope, ISearchEngineResultCollector collector, IProgressMonitor monitor)
           
 

Method Detail

run

void run(
String query,
         
ISearchScope scope,
         
ISearchEngineResultCollector collector,
         
IProgressMonitor monitor)
         throws 
CoreException
Parameters:
query - the search expression
scope - the engine-specific scope object that is used to narrow the search or null if the default scope is assumed.
collector - the search result collector handles results as they arrive
monitor - progress monitor to track the search progress
Throws:
CoreException - when there are problems in the engine

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


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