org.archive.wayback

Interface QueryRenderer

All Known Implementing Classes:

Renderer

public interface QueryRenderer

QueryRenderer generates response for two types of resource index query: capture search and URL search.

REFACTORING THOUGHTS

There's no good reason two types of query should be bundled in one object. Probably we should split this interface into two interfaces, or for the better, just one interface covering the two. It'll open up a possibility of unifying ReplayRenderer and QueryRendere into one interface to simplify AccessPoint.

Author:

brad

See Also:

ReplayRenderer

Method Summary

Methods

Modifier and Type	Method and Description
void	renderCaptureResults(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResults results, ResultURIConverter uriConverter) Display matching SearchResults for the WaybackRequest to the user.
void	renderUrlResults(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse response, WaybackRequest wbRequest, UrlSearchResults results, ResultURIConverter uriConverter) Show the SearchResults of the request which may have resulted in multiple matching URLs.

Method Detail

renderCaptureResults

void renderCaptureResults(javax.servlet.http.HttpServletRequest httpRequest,
                        javax.servlet.http.HttpServletResponse httpResponse,
                        WaybackRequest wbRequest,
                        CaptureSearchResults results,
                        ResultURIConverter uriConverter)
                          throws javax.servlet.ServletException,
                                 IOException

Display matching SearchResults for the WaybackRequest to the user.

Parameters:

httpRequest - the HttpServletRequest

httpResponse - the HttpServletResponse

wbRequest - the WaybackRequest that returned the results

results - the SearchResults that the WaybackRequest matched

uriConverter - the URI converter to use to translate matching results into replayable URLs

Throws:

javax.servlet.ServletException - per usual

IOException - per usual

renderUrlResults

void renderUrlResults(javax.servlet.http.HttpServletRequest httpRequest,
                    javax.servlet.http.HttpServletResponse response,
                    WaybackRequest wbRequest,
                    UrlSearchResults results,
                    ResultURIConverter uriConverter)
                      throws javax.servlet.ServletException,
                             IOException

Show the SearchResults of the request which may have resulted in multiple matching URLs.

Parameters:

httpRequest - the HttpServletRequest

response - the HttpServletResponse

wbRequest - the WaybackRequest that returned the results

results - the SearchResults that the WaybackRequest matched

uriConverter - the URI converter to use to translate matching results into replayable URLs

Throws:

javax.servlet.ServletException - per usual

IOException - per usual