Package org.eclipse.help.search
Class AbstractSearchProcessor
- java.lang.Object
-
- org.eclipse.help.search.AbstractSearchProcessor
-
public abstract class AbstractSearchProcessor extends Object
This class is responsible for handling any pre or post search processing events, including query manipulation and output to the search frame.- Since:
- 3.6
-
-
Constructor Summary
Constructors Constructor Description AbstractSearchProcessor()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract ISearchResult[]
postSearch(String query, ISearchResult[] results)
This method is called after the search is performed.abstract SearchProcessorInfo
preSearch(String query)
This method is called before the search is performed.
-
-
-
Method Detail
-
preSearch
public abstract SearchProcessorInfo preSearch(String query)
This method is called before the search is performed. SeeSearchProcessorInfo
for types of information that can be used by the search display.- Returns:
SearchProcessorInfo
, ornull
for no changes.
-
postSearch
public abstract ISearchResult[] postSearch(String query, ISearchResult[] results)
This method is called after the search is performed. Results are stored as an array of ISearchResult containing all available data. This method can be used to return a modified result set. For example, one can change the result score of an item, add new results to the top of the list, or remove results.- Returns:
, orISearchResult
[]null
for no changes.
-
-