|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.help.search.SearchQuery
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.
SearchEvent,
SearchListener| 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. |
SearchEngine |
getSearchEngine()
Returns the SearchEngine associated with this SearchQuery. |
abstract boolean |
isActive()
Determines if this SearchQuery is active. |
void |
itemsFound(boolean inSearch,
java.util.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(java.lang.String searchparams,
java.util.Locale l)
Starts the search. |
void |
stop()
Stops the search. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public SearchQuery(SearchEngine hs)
| Method Detail |
public void addSearchListener(SearchListener l)
l - The listener to add.java.javahelp.SearchEngine#removeSearchListenerpublic void removeSearchListener(SearchListener l)
l - The listener to remove.java.javahelp.SearchEngine#addSearchListener
public void start(java.lang.String searchparams,
java.util.Locale l)
throws java.lang.IllegalArgumentException,
java.lang.IllegalStateException
searchparams - The search string.
java.lang.IllegalArgumentException - The parameters are not
understood by this engine.
java.lang.IllegalStateException - There is an active search in
progress in this instance.
public void stop()
throws java.lang.IllegalStateException
java.lang.IllegalStateException - The search engine is not in a state in which it can be started.public SearchEngine getSearchEngine()
public abstract boolean isActive()
public void itemsFound(boolean inSearch,
java.util.Vector docs)
docs - A vector of SearchItem.inSearch - Is the search completed?
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||