org.archive.wayback.core

Class CaptureSearchResults

java.lang.Object

org.archive.wayback.core.SearchResults

org.archive.wayback.core.CaptureSearchResults

All Implemented Interfaces:

Iterable<CaptureSearchResult>

public class CaptureSearchResults
extends SearchResults
implements Iterable<CaptureSearchResult>

Output of capture search query, an ordered sequence of CaptureSearchResult.

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

Constructors

Constructor and Description
CaptureSearchResults()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSearchResult(CaptureSearchResult result) Append a capture.
void	addSearchResult(CaptureSearchResult result, boolean append) Add a result to this results, at either the beginning or the end, depending on the append argument
CaptureSearchResult	getClosest()
Date	getFirstResultDate()
String	getFirstResultTimestamp()
Date	getLastResultDate() Similar to getLastResultTimestamp(), but return Date object.
String	getLastResultTimestamp() Return the textual timestamp of the last capture
LinkedList<CaptureSearchResult>	getResults()
boolean	isEmpty()
Iterator<CaptureSearchResult>	iterator()
void	setClosest(CaptureSearchResult closest)
int	size()

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

containsFilter, getCloseMatches, getCurPageNum, getFilter, getFilters, getFirstReturned, getMatchingCount, getNumPages, getNumRequested, getReturnedCount, putFilter, setCloseMatches, 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 String getFirstResultTimestamp()

Returns:

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

getFirstResultDate

public Date getFirstResultDate()

Returns:

Returns the firstResult Date.

getLastResultTimestamp

public String getLastResultTimestamp()

Return the textual timestamp of the last capture

Returns:

14-digit String Timestamp

getLastResultDate

public Date getLastResultDate()

Similar to getLastResultTimestamp(), but return Date object.

Returns:

new Date object

addSearchResult

public void addSearchResult(CaptureSearchResult result)

Append a capture.

Parameters:

result - a capture

addSearchResult

public void addSearchResult(CaptureSearchResult result,
                   boolean append)

Add a result to this results, at either the beginning or the end, depending on the append argument

Parameters:

result - SearchResult to add to this set

append -

isEmpty

public boolean isEmpty()

getResults

public LinkedList<CaptureSearchResult> getResults()

iterator

public Iterator<CaptureSearchResult> iterator()

Specified by:

iterator in interface Iterable<CaptureSearchResult>

size

public int size()

setClosest

public void setClosest(CaptureSearchResult closest)

Parameters:

closest - the closest to set

getClosest

public CaptureSearchResult getClosest()

Returns:

the closest