org.archive.wayback.core
Class SearchResults

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

Direct Known Subclasses:

CaptureSearchResults, UrlSearchResults

public abstract class SearchResults
extends Object

Version:

$Date: 2010-09-29 05:28:38 +0700 (Wed, 29 Sep 2010) $, $Revision: 3262 $

Author:

brad

Field Summary

static String	RESULTS_FIRST_RETURNED Results: int first record of all matching returned, 1-based
static String	RESULTS_NUM_RESULTS Results: int total number of records matching, not all necc.
static String	RESULTS_NUM_RETURNED Results: int total number of records *returned* in results
static String	RESULTS_REQUESTED Results: int number of results requested
static String	RESULTS_TYPE Results: type of results: "Capture" or "Url"
static String	RESULTS_TYPE_CAPTURE Results: indicates SearchResult objects within the SearchResults are of type CaptureSearchResults.
static String	RESULTS_TYPE_URL Results: indicates SearchResult objects within the SearchResults are of type UrlSearchResults.

Constructor Summary

SearchResults()
Constructor

Method Summary

boolean	containsFilter(String key)
List<String>	getCloseMatches()
int	getCurPageNum()
String	getFilter(String key)
Map<String,String>	getFilters()
long	getFirstReturned()
long	getMatchingCount()
int	getNumPages()
long	getNumRequested()
long	getReturnedCount()
String	putFilter(String key, String value)
void	setCloseMatches(List<String> closeMatches)
void	setFirstReturned(long firstReturned)
void	setMatchingCount(long matchingCount)
void	setNumRequested(long numRequested)
void	setReturnedCount(long returnedCount)

Methods inherited from class java.lang.Object

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

Field Detail

RESULTS_NUM_RESULTS

public static final String RESULTS_NUM_RESULTS

Results: int total number of records matching, not all necc. returned.

See Also:

Constant Field Values

RESULTS_FIRST_RETURNED

public static final String RESULTS_FIRST_RETURNED

Results: int first record of all matching returned, 1-based

See Also:

Constant Field Values

RESULTS_NUM_RETURNED

public static final String RESULTS_NUM_RETURNED

Results: int total number of records *returned* in results

See Also:

Constant Field Values

RESULTS_REQUESTED

public static final String RESULTS_REQUESTED

Results: int number of results requested

See Also:

Constant Field Values

RESULTS_TYPE_URL

public static final String RESULTS_TYPE_URL

Results: indicates SearchResult objects within the SearchResults are of type UrlSearchResults.

See Also:

Constant Field Values

RESULTS_TYPE_CAPTURE

public static final String RESULTS_TYPE_CAPTURE

Results: indicates SearchResult objects within the SearchResults are of type CaptureSearchResults.

See Also:

Constant Field Values

RESULTS_TYPE

public static final String RESULTS_TYPE

Results: type of results: "Capture" or "Url"

See Also:

Constant Field Values

Constructor Detail

SearchResults

public SearchResults()

Constructor

Method Detail

containsFilter

public boolean containsFilter(String key)

Parameters:

key -

Returns:

boolean, true if key 'key' exists in filters

getFilter

public String getFilter(String key)

Parameters:

key -

Returns:

value of key 'key' in filters

putFilter

public String putFilter(String key,
                        String value)

Parameters:

key -

value -

Returns:

previous String value of key 'key' or null if there was none

getFilters

public Map<String,String> getFilters()

Returns:

Returns the filters.

getReturnedCount

public long getReturnedCount()

setReturnedCount

public void setReturnedCount(long returnedCount)

getFirstReturned

public long getFirstReturned()

setFirstReturned

public void setFirstReturned(long firstReturned)

getMatchingCount

public long getMatchingCount()

setMatchingCount

public void setMatchingCount(long matchingCount)

getNumRequested

public long getNumRequested()

setNumRequested

public void setNumRequested(long numRequested)

getNumPages

public int getNumPages()

getCurPageNum

public int getCurPageNum()

getCloseMatches

public List<String> getCloseMatches()

setCloseMatches

public void setCloseMatches(List<String> closeMatches)