org.eaglei.search.provider
Interface SearchProvider

All Known Subinterfaces:

CentralSearchService, InstitutionalSearchService, SearchService

public interface SearchProvider

Interface for classes that can execute search requests on a single node.

Author:

rfrost

Method Summary

SearchCounts	count(SearchCountRequest request) Retrieves counts for a specific search request and returns a SearchCounts as a synchronous operation.
void	init() Initializes the provider.
SearchResultSet	query(SearchRequest request) Executes the specified search request and returns a SearchResultSet as a synchronous operation.

Method Detail

init

void init()
          throws java.io.IOException

Initializes the provider. Must be called before query or getInstitution

Throws:

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

query

SearchResultSet query(SearchRequest request)
                      throws java.io.IOException

Executes the specified search request and returns a SearchResultSet as a synchronous operation.

Parameters:

request - The search request.

Returns:

Set of search results. Will be empty before init has been called.

Throws:

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

count

SearchCounts count(SearchCountRequest request)
                   throws java.io.IOException

Retrieves counts for a specific search request and returns a SearchCounts as a synchronous operation.

Parameters:

request - The search count request.

Returns:

SearchCounts. Will be empty before init has been called.

Throws:

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