public abstract class SearchParticipant extends Object
"org.eclipse.help.search.searchParticipant"
extension point. Search
participant is responsible for adding the content of documents it is responsible for into the
help system's search index. Once in the index, the document becomes searchable and can produce
search hits. There are two ways of using the participant:
Constructor and Description |
---|
SearchParticipant() |
Modifier and Type | Method and Description |
---|---|
abstract IStatus |
addDocument(IHelpSearchIndex index,
String pluginId,
String name,
URL url,
String id,
ISearchDocument doc)
Adds the document to the search index.
|
protected void |
addTitle(String title,
ISearchDocument doc)
A utility method that adds a title to the document.
|
void |
clear()
Signals to the participant that the indexing operation has finished and that cached resources
can be disposed to free up memory.
|
Set<String> |
getAllDocuments(String locale)
Returns all the documents that this participant knows about.
|
Set<String> |
getContributingPlugins()
Returns a set of identifiers of plug-ins that contribute indexable documents.
|
String |
getId()
Returns the unique identifier of this participant.
|
void |
init(String id)
Initializes the participant with the unique identifier from the registry.
|
boolean |
open(String id)
Help system does not know how to open documents outside of the system's TOC.
|
protected static String |
resolveVariables(String pluginId,
String fileName,
String locale)
A utility method that resolves a file name that contains '$'-based substitution variables.
|
public final void init(String id)
id
- the unique identifier of this participantpublic final String getId()
public abstract IStatus addDocument(IHelpSearchIndex index, String pluginId, String name, URL url, String id, ISearchDocument doc)
index
- the abstract representation of the help index that is currently running. Indexing
known file types in participants that manage documents outside the TOC can be
delegated to the index.pluginId
- the plug-in that owns the documentname
- the name of the document to indexurl
- the url of the document to indexid
- the unique id associated with this documentdoc
- the document to add searchable content toStatus.OK
.public Set<String> getAllDocuments(String locale)
locale
- the index localepublic Set<String> getContributingPlugins()
protected static String resolveVariables(String pluginId, String fileName, String locale)
pluginId
- the identifier of the originating plug-infileName
- the source file namelocale
- the locale to use when resolving nl variableprotected void addTitle(String title, ISearchDocument doc)
title
- the title stringdoc
- the documentpublic boolean open(String id)
getAllDocuments(String)
have a chance to open the document when it is part of
the search results. The default implementation returns false
indicating that
the help system should open the document. In most cases this is wrong for most of XML files
that are in some interesting way.id
- a participant-specific identifier that completely represents a search resulttrue
if the file has been opened correctly or false
to
allow the help system to try to open the document.public void clear()
dispose
).
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.