icy.search

Class SearchEngine

java.lang.Object

icy.search.SearchEngine

All Implemented Interfaces:

PluginLoader.PluginLoaderListener, SearchResultConsumer, java.util.EventListener

public class SearchEngine
extends java.lang.Object
implements SearchResultConsumer, PluginLoader.PluginLoaderListener

SearchEngine for Icy.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchEngine.SearchEngineListener

Constructor Summary

Constructors

Constructor and Description
SearchEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(SearchEngine.SearchEngineListener listener)
void	cancelSearch() Cancel the previous search request
java.lang.String	getLastSearch() Returns the last search text.
java.util.List<SearchEngine.SearchEngineListener>	getListeners()
SearchResult	getResult(int index) Returns SearchResult at specified index.
java.util.List<SearchResult>	getResults() Return all current results from all SearchResultProducer.
int	getSearchingProducerCount() Returns the number of currently producer processing a search request.
java.util.List<SearchResultProducer>	getSearchResultProducers() Returns SearchResultProducer attached to the search engine.
boolean	isSearching() Returns true if the search engine is currently processing a search request.
void	pluginLoaderChanged(PluginLoader.PluginLoaderEvent e)
void	removeListener(SearchEngine.SearchEngineListener listener)
void	resultChanged(SearchResultProducer producer, SearchResult result) Notify consumer than a single result has just been modified.
void	resultsChanged(SearchResultProducer producer) Notify consumer than results list changed.
void	search(java.lang.String text) Performs the search request, mostly build the search result list.
void	searchCompleted(SearchResultProducer producer) Notify consumer than search request completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEngine

public SearchEngine()

Method Detail

cancelSearch

public void cancelSearch()

Cancel the previous search request

search

public void search(java.lang.String text)

Performs the search request, mostly build the search result list.
Previous search is automatically canceled and replaced by the new one.

Parameters:

text - Text used for the search request, 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

See Also:

cancelSearch()

getSearchResultProducers

public java.util.List<SearchResultProducer> getSearchResultProducers()

Returns SearchResultProducer attached to the search engine.

getSearchingProducerCount

public int getSearchingProducerCount()

Returns the number of currently producer processing a search request.

isSearching

public boolean isSearching()

Returns true if the search engine is currently processing a search request.

getLastSearch

public java.lang.String getLastSearch()

Returns the last search text.

getResult

public SearchResult getResult(int index)

Returns SearchResult at specified index.

getResults

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

Return all current results from all SearchResultProducer.

pluginLoaderChanged

public void pluginLoaderChanged(PluginLoader.PluginLoaderEvent e)

Specified by:

pluginLoaderChanged in interface PluginLoader.PluginLoaderListener

resultChanged

public void resultChanged(SearchResultProducer producer,
                 SearchResult result)

Description copied from interface: SearchResultConsumer

Notify consumer than a single result has just been modified.

Specified by:

resultChanged in interface SearchResultConsumer

resultsChanged

public void resultsChanged(SearchResultProducer producer)

Description copied from interface: SearchResultConsumer

Notify consumer than results list changed.

Specified by:

resultsChanged in interface SearchResultConsumer

searchCompleted

public void searchCompleted(SearchResultProducer producer)

Description copied from interface: SearchResultConsumer

Notify consumer than search request completed.

Specified by:

searchCompleted in interface SearchResultConsumer

getListeners

public java.util.List<SearchEngine.SearchEngineListener> getListeners()

addListener

public void addListener(SearchEngine.SearchEngineListener listener)

removeListener

public void removeListener(SearchEngine.SearchEngineListener listener)