|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISearchDocument
Represents a document in the search index. This interface is used by clients which implement the search participant extension point. While the help system uses the Lucene classes internally this interface does not import anything from Lucene and enables the API for adding search participants to remain binary compatible whatever changes are made in Lucene.
Method Summary | |
---|---|
void |
addContents(Reader contents,
Reader exactContents)
Alternate way of adding contents which is closer to the API for the deprecated extension point org.eclipse.help.base.luceneSearchParticipants. |
void |
addContents(String contents)
|
void |
setHasFilters(boolean hasFilters)
Allows search participant to indicate that a document will be processed at runtime and that parts of the contents may not be displayed to the user, causing a match in the search to be shown as a potential match. |
void |
setSummary(String summary)
|
void |
setTitle(String title)
|
Method Detail |
---|
void setTitle(String title)
title
- the title which will be shown in the search results summary.
This function should be called exactly once per documentvoid setSummary(String summary)
summary
- the summary which will be used when displaying search results.
This function should be called exactly once per documentvoid addContents(String contents)
contents
- the text which will be used when performing a search. The search index
will parse the contents and store the results in a database for rapid retrieval.void addContents(Reader contents, Reader exactContents)
addContents(String)
contents
- a Reader object which provides the contentsexactContents
- a second Reader object which contains the same same contentsvoid setHasFilters(boolean hasFilters)
|
Eclipse Platform Release 3.6 |
|||||||||
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, 2010. All rights reserved.