Package javax.help.search
Class SearchQuery
java.lang.Object
javax.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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected SearchEngine
protected Locale
protected EventListenerList
protected String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
Passs through that a SearchEvent has happened.protected void
Notifies that a search has completed.protected void
Notifies that a search has started.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
Removes a listener previously added with addSearchListener.void
Starts the search.void
stop()
Stops the search.
-
Field Details
-
listenerList
-
hs
-
searchparams
-
l
-
-
Constructor Details
-
SearchQuery
Creates a SearchQuery.
-
-
Method Details
-
addSearchListener
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
-
removeSearchListener
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.locale
- The locale of the search string.- Throws:
IllegalArgumentException
- The parameters are not understood by this engine.IllegalStateException
- There is an active search in progress in this instance.
-
stop
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.- Throws:
IllegalStateException
- The search engine is not in a state in which it can be started.
-
getSearchEngine
Returns the SearchEngine associated with this SearchQuery. -
isActive
public abstract boolean isActive()Determines if this SearchQuery is active. -
itemsFound
Notifies that query of items is found in the search.- Parameters:
docs
- A vector of SearchItem.inSearch
- Is the search completed?
-
fireItemsFound
Notifies that a SearchItem has been found.- Parameters:
params
- The parameters to the search.inSearch
- Is the search completed?docs
- A vector of SearchItem.- See Also:
-
fireItemsFound
Passs through that a SearchEvent has happened. This is useful for SearchEngine engines that encapsulate others.- Parameters:
e
- The SearchEvent to pass through.
-
fireSearchStarted
protected void fireSearchStarted()Notifies that a search has started.- Parameters:
params
- The parameters to the search.
-
fireSearchFinished
protected void fireSearchFinished()Notifies that a search has completed.- Parameters:
params
- The parameters to the search.
-