org.archive.wayback

Interface ResourceIndex

All Known Implementing Classes:

AlphaPartitionedIndex, EmbeddedCDXServerIndex, LocalResourceIndex, NutchResourceIndex, RangeGroup, RangeMember, RemoteResourceIndex

public interface ResourceIndex

Transforms a WaybackRequest into a ResourceResults.

Version:

$Date$, $Revision$

Author:

Brad Tofel

Method Summary

Methods

Modifier and Type	Method and Description
SearchResults	query(WaybackRequest request) Transform a WaybackRequest into a ResourceResults.
void	shutdown() Release any resources used by this ResourceIndex cleanly

Method Detail

query

SearchResults query(WaybackRequest request)
                    throws ResourceIndexNotAvailableException,
                           ResourceNotInArchiveException,
                           BadQueryException,
                           AccessControlException

Transform a WaybackRequest into a ResourceResults.

Parameters:

request - WaybackRequest object from RequestParser

Returns:

SearchResults containing SearchResult objects matching the WaybackRequest

Throws:

ResourceIndexNotAvailableException - if the ResourceIndex is not available (remote host down, local files missing, etc)

ResourceNotInArchiveException - if the ResourceIndex could be contacted, but no SearchResult objects matched the request

BadQueryException - if the WaybackRequest is lacking information required to make a reasonable search of this ResourceIndex

AccessControlException - if SearchResult objects actually matched, but could not be returned due to AccessControl restrictions (robots.txt documents, Administrative URL blocks, etc)

shutdown

void shutdown()
              throws IOException

Release any resources used by this ResourceIndex cleanly

Throws:

IOException - for usual causes