Skip navigation links

oracle.help.common.search
Class QueryHandler

java.lang.Object
oracle.help.common.search.QueryHandler

public abstract class QueryHandler

extends java.lang.Object

QueryHandler is an abstract class that defines methods for executing a full text search. The IndexFileQueryHandler is a concrete implementation of QueryHandler that is provided with Oracle Help Technologies. Clients can create their own concrete implementations of QueryHandler (for custom search views in a helpset).

Constructor Summary

QueryHandler()

Method Summary

abstract java.util.List	executeQuery(SearchExpression expression, java.util.Set selectedSources) Executes the given search query and returns the results (a List of QueryResult objects)
java.util.List	executeQuery(java.lang.String[] words, boolean allWords, boolean caseSensitive, java.util.Set selectedSources) Executes the given search query and returns the results (a List of QueryResult objects)
abstract java.util.Set	getSupportedSources() Returns the Set of source identifiers supported by this QueryHandler.
abstract void	stopSearch() Called to notify the query handler that it should suspend executing the current query and return an empty result list
abstract boolean	supportsCaseSensitiveSearches() Returns true if the query handler implementation supports case-sensitive searches, and false otherwise

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryHandler

public QueryHandler()

Method Detail

executeQuery

public java.util.List executeQuery(java.lang.String[] words,
                                   boolean allWords,
                                   boolean caseSensitive,
                                   java.util.Set selectedSources)
                            throws SearchException

Executes the given search query and returns the results (a List of QueryResult objects)

Parameters:

words - the words to search for

allWords - true if all words are required, and false otherwise

caseSensitive - true if a case sensitive search should be performed

selectedSources - a Set of String objects that identify the sources within this QueryHandler to consider during this search (null or an empty set means that all available sources within this QueryHandler should be searched)

Throws:

SearchException

executeQuery

public abstract java.util.List executeQuery(SearchExpression expression,
                                            java.util.Set selectedSources)
                                     throws SearchException

Executes the given search query and returns the results (a List of QueryResult objects)

Parameters:

expression - the search query to execute

selectedSources - a Set of String objects that identify the sources within this QueryHandler to consider during this search (null or an empty set means that all available sources within this QueryHandler should be searched)

Throws:

SearchException

stopSearch

public abstract void stopSearch()

Called to notify the query handler that it should suspend executing the current query and return an empty result list

supportsCaseSensitiveSearches

public abstract boolean supportsCaseSensitiveSearches()

Returns true if the query handler implementation supports case-sensitive searches, and false otherwise

getSupportedSources

public abstract java.util.Set getSupportedSources()

Returns the Set of source identifiers supported by this QueryHandler. A source identifier is a string that identifies a particular subset of the documents indexed by this QueryHandler. Clients of the executeQuery API can optionally limit their Query to a selected set of sources. If the QueryHandler does not support sources, it will return an empty Set.

Skip navigation links