org.archive.wayback.core
Class CaptureSearchResults

java.lang.Object
  org.archive.wayback.core.SearchResults
      org.archive.wayback.core.CaptureSearchResults

public class CaptureSearchResults
extends SearchResults

Version:

$Date$, $Revision$

Author:

brad

Field Summary

Fields inherited from class org.archive.wayback.core.SearchResults

RESULTS_FIRST_RETURNED, RESULTS_NUM_RESULTS, RESULTS_NUM_RETURNED, RESULTS_REQUESTED, RESULTS_TYPE, RESULTS_TYPE_CAPTURE, RESULTS_TYPE_URL

Constructor Summary

CaptureSearchResults()

Method Summary

void	addSearchResult(CaptureSearchResult result) append a result
void	addSearchResult(CaptureSearchResult result, boolean append) add a result to this results, at either the begginning or at the end, depending on the append argument
CaptureSearchResult	getClosest(WaybackRequest wbRequest)
CaptureSearchResult	getClosest(WaybackRequest wbRequest, boolean useAnchor)
java.util.Date	getFirstResultDate()
java.lang.String	getFirstResultTimestamp()
java.util.Date	getLastResultDate()
java.lang.String	getLastResultTimestamp()
boolean	isEmpty()
java.util.Iterator<CaptureSearchResult>	iterator()
void	markClosest(WaybackRequest wbRequest)
int	size()

Methods inherited from class org.archive.wayback.core.SearchResults

containsFilter, getCurPageNum, getFilter, getFilters, getFirstReturned, getMatchingCount, getNumPages, getNumRequested, getReturnedCount, putFilter, setFirstReturned, setMatchingCount, setNumRequested, setReturnedCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CaptureSearchResults

public CaptureSearchResults()

Method Detail

getFirstResultTimestamp

public java.lang.String getFirstResultTimestamp()

Returns:

Returns the 14-digit String Timestamp of the first Capture in this set of SearchResult objects

getFirstResultDate

public java.util.Date getFirstResultDate()

Returns:

Returns the firstResult Date.

getLastResultTimestamp

public java.lang.String getLastResultTimestamp()

Returns:

Returns the 14-digit String Timestamp of the last Capture in this set of SearchResult objects

getLastResultDate

public java.util.Date getLastResultDate()

markClosest

public void markClosest(WaybackRequest wbRequest)

getClosest

public CaptureSearchResult getClosest(WaybackRequest wbRequest)

Parameters:

wbRequest -

Returns:

The closest CaptureSearchResult to the request.

getClosest

public CaptureSearchResult getClosest(WaybackRequest wbRequest,
                                      boolean useAnchor)
                               throws AnchorWindowTooSmallException

Parameters:

wbRequest -

useAnchor - if true, then check Request Anchor Window and Date, throwing exception if no Result is within the Window.

Returns:

The closest CaptureSearchResult to the request.

Throws:

AnchorWindowTooSmallException

addSearchResult

public void addSearchResult(CaptureSearchResult result)

append a result

Parameters:

result -

addSearchResult

public void addSearchResult(CaptureSearchResult result,
                            boolean append)

add a result to this results, at either the begginning or at the end, depending on the append argument

Parameters:

result - SearchResult to add to this set

append -

isEmpty

public boolean isEmpty()

iterator

public java.util.Iterator<CaptureSearchResult> iterator()

size

public int size()