org.archive.wayback.replay

Interface ClosestResultSelector

All Known Implementing Classes:

ArchivalUrlDateRedirectingClosestResultSelector, DateRedirectingClosestResultSelector, DefaultClosestResultSelector

public interface ClosestResultSelector

New interface component on Replay to allow customized selection of the "best" particular search result from a set to return for a particular request. Also allows specific Replay instances to optionally bounce the user to a better URL, via a BetterRequestException.

REFACTORING NOTE: now closest capture is located by ResourceIndex, and ClosestResultSelector implementation simply returns it. This class will be removed unless we find a good use case for it.

Author:

brad

Method Summary

Methods

Modifier and Type	Method and Description
CaptureSearchResult	getClosest(WaybackRequest wbRequest, CaptureSearchResults results) Locate and return the best matching search result from a set for a given request.

Method Detail

getClosest

CaptureSearchResult getClosest(WaybackRequest wbRequest,
                             CaptureSearchResults results)

Locate and return the best matching search result from a set for a given request.

INTERFACE CHANGE: 1.8.1 2014-07-2 now getClosest() is not allowed to throw BetterRequestException, as it can cause redirect loop triggered by revisits resolution. See ARI-3934.

Parameters:

wbRequest - The WaybackRequest being handled

results - the CaptureSeachResults found matching the request

Returns:

the best CaptureSearchResult, which should be replayed to the user.