|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IHelpSearchIndex
Represents a Lucene index for one locale. The interface is used to allow participants to delegate indexing of documents outside of the TOC using the same algorithms as those in TOC.
| Method Summary | |
|---|---|
IStatus |
addSearchableDocument(String pluginId,
String name,
URL url,
String id,
ISearchDocument doc)
Adds a document to the search index database by parsing it using one of the file-based search participants, or the default HTML search participant. |
String |
getLocale()
A search index is created for each locale. |
| Method Detail |
|---|
IStatus addSearchableDocument(String pluginId,
String name,
URL url,
String id,
ISearchDocument doc)
pluginId - the id of the contributing plug-inname - the name of the documenturl - the URL of the document using format '/pluginId/href'id - the unique id of this document as defined in the participantdoc - the document to be added
String getLocale()
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.