plugins.kernel.searchprovider

Class LocalPluginSearchResultProducer

java.lang.Object

icy.search.SearchResultProducer

plugins.kernel.searchprovider.LocalPluginSearchResultProducer

All Implemented Interfaces:

java.lang.Comparable<SearchResultProducer>

public class LocalPluginSearchResultProducer
extends SearchResultProducer

This class is used to provide installed plugin elements to the search engine.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalPluginSearchResultProducer.LocalPluginResult

Constructor Summary

Constructors

Constructor and Description
LocalPluginSearchResultProducer()

Method Summary

Methods

Modifier and Type	Method and Description
void	doSearch(java.lang.String text, SearchResultConsumer consumer) Performs the search request (internal).
java.lang.String	getName() Returns the result producer name
int	getOrder() Returns the result producer order
java.lang.String	getTooltipText() Returns the tooltip displayed on the menu (in small under the label).

Methods inherited from class icy.search.SearchResultProducer

addResult, compareTo, doSearch, getResults, hasWaitingSearch, isSearching, search, search, waitSearchComplete

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalPluginSearchResultProducer

public LocalPluginSearchResultProducer()

Method Detail

getOrder

public int getOrder()

Description copied from class: SearchResultProducer

Returns the result producer order

Overrides:

getOrder in class SearchResultProducer

getName

public java.lang.String getName()

Description copied from class: SearchResultProducer

Returns the result producer name

Specified by:

getName in class SearchResultProducer

getTooltipText

public java.lang.String getTooltipText()

Description copied from class: SearchResultProducer

Returns the tooltip displayed on the menu (in small under the label).

Overrides:

getTooltipText in class SearchResultProducer

doSearch

public void doSearch(java.lang.String text,
            SearchResultConsumer consumer)

Description copied from class: SearchResultProducer

Performs the search request (internal).
The method is responsible for filling the results list :
- If no result correspond to the requested search then results should be cleared.
- otherwise it should contains the founds results.
results variable access should be synchronized as it can be externally accessed.
The method could return earlier if SearchResultProducer.hasWaitingSearch() returns true.

Overrides:

doSearch in class SearchResultProducer

Parameters:

text - Search text, it can contains several words and use operators.
Examples:

spot detector : any of word should be present

+spot +detector : both words should be present

"spot detector" : the exact expression should be present

+"spot detector" -tracking : spot detector should be present and tracking absent

consumer - Search result consumer for this search request.
The consumer should be notified of new results by using the SearchResultConsumer.resultsChanged(SearchResultProducer) method.

See Also:

SearchResultProducer.hasWaitingSearch()