org.eaglei.search.provider
Interface MultiNodeSearchProvider

public interface MultiNodeSearchProvider

Interface for classes that can execute search requests on multiple destinations.

Author:

rfrost

Method Summary

java.util.Collection<SearchCounts>	count(SearchCountRequest request) Executes the specified search count request (potentially against multiple destinations) and returns a collection of SearchCounts as a synchronous operation.
void	init() Initializes the provider.
java.util.Collection<SearchResultSet>	query(SearchRequest request) Executes the specified search request (potentially against multiple destinations) and returns a collection of SearchResultSets as a synchronous operation.

Method Detail

init

void init()
          throws java.io.IOException

Initializes the provider. Must be called before query or getInstitutions.

Throws:

java.io.IOException - Thrown if an error is encountered initializing the provider.

query

java.util.Collection<SearchResultSet> query(SearchRequest request)
                                            throws java.io.IOException

Executes the specified search request (potentially against multiple destinations) and returns a collection of SearchResultSets as a synchronous operation. One SearchResultSet will be returned from each destination in the network.

Parameters:

request - The search request.

Returns:

Collection of SearchResultSets. Will be empty before init has been called.

Throws:

java.io.IOException - Thrown if an error is encountered executing the search.

count

java.util.Collection<SearchCounts> count(SearchCountRequest request)
                                         throws java.io.IOException

Executes the specified search count request (potentially against multiple destinations) and returns a collection of SearchCounts as a synchronous operation. One SearchCounts will be returned from each destination in the network.

Parameters:

request - The search counts request.

Returns:

Collection of SearchCounts. Will be empty before init has been called.

Throws:

java.io.IOException - Thrown if an error is encountered executing the search.