icy.search

Class OnlineSearchResultProducer

java.lang.Object

icy.search.SearchResultProducer

icy.search.OnlineSearchResultProducer

All Implemented Interfaces:

java.lang.Comparable<SearchResultProducer>

Direct Known Subclasses:

OnlinePluginSearchResultProducer

public abstract class OnlineSearchResultProducer
extends SearchResultProducer

The OnlineSearchResultProducer is the basic class for SearchResult producer from online results.
It does use a single static instance to do the online search then dispatch XML result the overriding class.

Author:

Stephane Dallongeville

See Also:

SearchResultProducer

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAXIMUM_SEARCH_TIME
static long	REQUEST_INTERVAL

Constructor Summary

Constructors

Constructor and Description
OnlineSearchResultProducer()

Method Summary

Methods

Modifier and Type	Method and Description
void	doSearch(org.w3c.dom.Document doc, java.lang.String[] words, SearchResultConsumer consumer) Deprecated. Use doSearch(Document, String, SearchResultConsumer) instead
void	doSearch(org.w3c.dom.Document doc, java.lang.String text, SearchResultConsumer consumer)
void	doSearch(java.lang.String text, SearchResultConsumer consumer) Performs the search request (internal).

Methods inherited from class icy.search.SearchResultProducer

addResult, compareTo, doSearch, getName, getOrder, getResults, getTooltipText, hasWaitingSearch, isSearching, search, search, waitSearchComplete

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_INTERVAL

public static final long REQUEST_INTERVAL

See Also:

Constant Field Values

MAXIMUM_SEARCH_TIME

public static final long MAXIMUM_SEARCH_TIME

See Also:

Constant Field Values

Constructor Detail

OnlineSearchResultProducer

public OnlineSearchResultProducer()

Method Detail

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()

doSearch

@Deprecated
public void doSearch(org.w3c.dom.Document doc,
                       java.lang.String[] words,
                       SearchResultConsumer consumer)

Deprecated. Use doSearch(Document, String, SearchResultConsumer) instead

doSearch

public void doSearch(org.w3c.dom.Document doc,
            java.lang.String text,
            SearchResultConsumer consumer)