icy.search

Class SearchResultProducer

java.lang.Object

icy.search.SearchResultProducer

All Implemented Interfaces:

java.lang.Comparable<SearchResultProducer>

Direct Known Subclasses:

KernelSearchResultProducer, LocalPluginSearchResultProducer, OnlineSearchResultProducer

public abstract class SearchResultProducer
extends java.lang.Object
implements java.lang.Comparable<SearchResultProducer>

The SearchResultProducer create SearchResult objects from given search keywords.
These SearchResult are then consumed by a SearchResultConsumer.

Author:

Stephane Dallongeville

Constructor Summary

Constructors

Constructor and Description
SearchResultProducer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addResult(SearchResult result, SearchResultConsumer consumer) Add the SearchResult to the result list.
int	compareTo(SearchResultProducer o)
void	doSearch(java.lang.String[] words, SearchResultConsumer consumer) Deprecated. Use doSearch(String, SearchResultConsumer) instead
void	doSearch(java.lang.String text, SearchResultConsumer consumer) Performs the search request (internal).
abstract java.lang.String	getName() Returns the result producer name
int	getOrder() Returns the result producer order
java.util.List<SearchResult>	getResults() Returns the result list
java.lang.String	getTooltipText() Returns the tooltip displayed on the menu (in small under the label).
boolean	hasWaitingSearch() Returns true if there is a waiting search pending.
boolean	isSearching() Returns true if the search result producer is currently processing a search request.
void	search(java.lang.String[] words, SearchResultConsumer consumer) Deprecated. Use search(String, SearchResultConsumer) instead.
void	search(java.lang.String text, SearchResultConsumer consumer) Performs the search request (asynchronous), mostly build the search result list.
void	waitSearchComplete() Wait for the search request to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultProducer

public SearchResultProducer()

Method Detail

getOrder

public int getOrder()

Returns the result producer order

getName

public abstract java.lang.String getName()

Returns the result producer name

getTooltipText

public java.lang.String getTooltipText()

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

getResults

public java.util.List<SearchResult> getResults()

Returns the result list

search

@Deprecated
public void search(java.lang.String[] words,
                     SearchResultConsumer consumer)

Deprecated. Use search(String, SearchResultConsumer) instead.

search

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

Performs the search request (asynchronous), mostly build the search result list.
Only one search request should be processed at one time so take care of waiting for previous search request completion.

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.

doSearch

@Deprecated
public void doSearch(java.lang.String[] words,
                       SearchResultConsumer consumer)

Deprecated. Use doSearch(String, SearchResultConsumer) instead

doSearch

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

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 hasWaitingSearch() returns true.

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:

hasWaitingSearch()

waitSearchComplete

public void waitSearchComplete()

Wait for the search request to complete.

isSearching

public boolean isSearching()

Returns true if the search result producer is currently processing a search request.

hasWaitingSearch

public boolean hasWaitingSearch()

Returns true if there is a waiting search pending.
This method should be called during search process to cancel it if another search is waiting.

addResult

public void addResult(SearchResult result,
             SearchResultConsumer consumer)

Add the SearchResult to the result list.

Parameters:

result - Result to add to the result list.

consumer - If not null then consumer is notified about result change

compareTo

public int compareTo(SearchResultProducer o)

Specified by:

compareTo in interface java.lang.Comparable<SearchResultProducer>