javax.help.search

Class SearchQuery


public abstract class SearchQuery
extends java.lang.Object

The instance of a query on a search database. It is instantiated by SearchEngine.startQuery. Subclasses of SearchQuery can perform the search or negotiate the search results with an outside agent as setup in the SearchEngine class. A server search engine is an an example of an outside agent. Search results are returned through SearchEvents to listeners that register with a SearchEngine instance.
See Also:
SearchEvent, SearchListener

Field Summary

protected SearchEngine
hs
protected Locale
l
protected EventListenerList
listenerList
protected String
searchparams

Constructor Summary

SearchQuery(SearchEngine hs)
Creates a SearchQuery.

Method Summary

void
addSearchListener(SearchListener l)
Adds a listener for the SearchEngine posted after the search has started, stopped, or search parameters have been defined.
protected void
fireItemsFound(boolean inSearch, Vector docs)
Notifies that a SearchItem has been found.
protected void
fireItemsFound(SearchEvent e)
Passs through that a SearchEvent has happened.
protected void
fireSearchFinished()
Notifies that a search has completed.
protected void
fireSearchStarted()
Notifies that a search has started.
SearchEngine
getSearchEngine()
Returns the SearchEngine associated with this SearchQuery.
abstract boolean
isActive()
Determines if this SearchQuery is active.
void
itemsFound(boolean inSearch, Vector docs)
Notifies that query of items is found in the search.
void
removeSearchListener(SearchListener l)
Removes a listener previously added with addSearchListener.
void
start(String searchparams, Locale l)
Starts the search.
void
stop()
Stops the search.

Field Details

hs

protected SearchEngine hs

l

protected Locale l

listenerList

protected EventListenerList listenerList

searchparams

protected String searchparams

Constructor Details

SearchQuery

public SearchQuery(SearchEngine hs)
Creates a SearchQuery.

Method Details

addSearchListener

public void addSearchListener(SearchListener l)
Adds a listener for the SearchEngine posted after the search has started, stopped, or search parameters have been defined.
Parameters:
l - The listener to add.
See Also:
java.javahelp.SearchEngine.removeSearchListener

fireItemsFound

protected void fireItemsFound(boolean inSearch,
                              Vector docs)
Notifies that a SearchItem has been found.
Parameters:
inSearch - Is the search completed?
docs - A vector of SearchItem.

fireItemsFound

protected void fireItemsFound(SearchEvent e)
Passs through that a SearchEvent has happened. This is useful for SearchEngine engines that encapsulate others.
Parameters:
e - The SearchEvent to pass through.

fireSearchFinished

protected void fireSearchFinished()
Notifies that a search has completed.
Parameters:

fireSearchStarted

protected void fireSearchStarted()
Notifies that a search has started.
Parameters:

getSearchEngine

public SearchEngine getSearchEngine()
Returns the SearchEngine associated with this SearchQuery.

isActive

public abstract boolean isActive()
Determines if this SearchQuery is active.

itemsFound

public void itemsFound(boolean inSearch,
                       Vector docs)
Notifies that query of items is found in the search.
Parameters:
inSearch - Is the search completed?
docs - A vector of SearchItem.

removeSearchListener

public void removeSearchListener(SearchListener l)
Removes a listener previously added with addSearchListener.
Parameters:
l - The listener to remove.
See Also:
java.javahelp.SearchEngine.addSearchListener

start

public void start(String searchparams,
                  Locale l)
            throws IllegalArgumentException,
                   IllegalStateException
Starts the search. This method invokes searchStarted on SearchListeners and stores the searchparams. Extensions of SearchQuery should fully implement this method according to the needs of the SearchQuery and its corresponding SearchEngine.
Parameters:
searchparams - The search string.

stop

public void stop()
            throws IllegalStateException
Stops the search. This method invokes searchStopped on SearchListeners. Extensions of SearchQuery should fully implement this method according to needs of the SearchQuery and its corresponding SearchEngine.