org.archive.wayback.core
Class CaptureSearchResult

java.lang.Object
  org.archive.wayback.core.SearchResult
      org.archive.wayback.core.CaptureSearchResult

public class CaptureSearchResult
extends SearchResult

Version:

$Date$, $Revision$

Author:

brad

Field Summary

static java.lang.String	CAPTURE_CAPTURE_TIMESTAMP Result: 14-digit timestamp when document was captured
static java.lang.String	CAPTURE_CLOSEST_INDICATOR Result: flag within a SearchResult that indicates this is the closest to a particular requested date.
static java.lang.String	CAPTURE_CLOSEST_VALUE
static java.lang.String	CAPTURE_DIGEST Result: some form of document fingerprint.
static java.lang.String	CAPTURE_DUPLICATE_ANNOTATION Result: this key being present indicates that this particular capture was not actually stored, and that other values within this SearchResult are actually values from a different record which *should* be identical to this capture, had it been stored.
static java.lang.String	CAPTURE_DUPLICATE_DIGEST flag indicates that this document was downloaded and verified as identical to a previous capture by digest.
static java.lang.String	CAPTURE_DUPLICATE_HTTP flag indicates that this document was NOT downloaded, but that the origin server indicated that the document had not changed, based on If-Modified HTTP request headers.
static java.lang.String	CAPTURE_DUPLICATE_STORED_TS Result: this key is present when the CAPTURE_DUPLICATE_ANNOTATION is also present, with the value indicating the last date that was actually stored for this duplicate.
static java.lang.String	CAPTURE_END_OFFSET Result: compressed byte offset within ARC file where this document's gzip envelope Ends.
static java.lang.String	CAPTURE_FILE Result: basename of ARC file containing this document.
static java.lang.String	CAPTURE_HTTP_CODE Result: 3-digit integer HTTP response code.
static java.lang.String	CAPTURE_MIME_TYPE Result: best-guess at mime-type of this document.
static java.lang.String	CAPTURE_OFFSET Result: compressed byte offset within ARC file where this document's gzip envelope begins.
static java.lang.String	CAPTURE_ORIGINAL_URL
static java.lang.String	CAPTURE_REDIRECT_URL Result: URL that this document redirected to, or '-' if it does not redirect
static java.lang.String	CAPTURE_URL_KEY Result: canonicalized(lookup key) form of URL of captured document

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

data, RESULT_TRUE_VALUE

Constructor Summary

CaptureSearchResult()

Method Summary

void	flagDuplicateDigest(java.util.Date storedDate)
void	flagDuplicateDigest(java.lang.String storedTS)
java.util.Date	getCaptureDate()
java.lang.String	getCaptureTimestamp()
java.lang.String	getDigest()
java.util.Date	getDuplicateDigestStoredDate()
java.lang.String	getDuplicateDigestStoredTimestamp()
java.lang.String	getFile()
java.lang.String	getHttpCode()
java.lang.String	getMimeType()
long	getOffset()
java.lang.String	getOriginalHost()
java.lang.String	getOriginalUrl()
java.lang.String	getRedirectUrl()
java.lang.String	getUrlKey()
boolean	isClosest()
boolean	isDuplicateDigest()
void	setCaptureDate(java.util.Date date)
void	setCaptureTimestamp(java.lang.String timestamp)
void	setClosest(boolean value)
void	setDigest(java.lang.String digest)
void	setFile(java.lang.String file)
void	setHttpCode(java.lang.String httpCode)
void	setMimeType(java.lang.String mimeType)
void	setOffset(long offset)
void	setOriginalUrl(java.lang.String originalUrl)
void	setRedirectUrl(java.lang.String url)
void	setUrlKey(java.lang.String urlKey)

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

dateToTS, fromCanonicalStringMap, get, getBoolean, put, putBoolean, toCanonicalStringMap, tsToDate

Methods inherited from class java.lang.Object

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

Field Detail

CAPTURE_ORIGINAL_URL

public static final java.lang.String CAPTURE_ORIGINAL_URL

See Also:

Constant Field Values

CAPTURE_URL_KEY

public static final java.lang.String CAPTURE_URL_KEY

Result: canonicalized(lookup key) form of URL of captured document

See Also:

Constant Field Values

CAPTURE_CAPTURE_TIMESTAMP

public static final java.lang.String CAPTURE_CAPTURE_TIMESTAMP

Result: 14-digit timestamp when document was captured

See Also:

Constant Field Values

CAPTURE_FILE

public static final java.lang.String CAPTURE_FILE

Result: basename of ARC file containing this document.

See Also:

Constant Field Values

CAPTURE_OFFSET

public static final java.lang.String CAPTURE_OFFSET

Result: compressed byte offset within ARC file where this document's gzip envelope begins.

See Also:

Constant Field Values

CAPTURE_END_OFFSET

public static final java.lang.String CAPTURE_END_OFFSET

Result: compressed byte offset within ARC file where this document's gzip envelope Ends.

See Also:

Constant Field Values

CAPTURE_MIME_TYPE

public static final java.lang.String CAPTURE_MIME_TYPE

Result: best-guess at mime-type of this document.

See Also:

Constant Field Values

CAPTURE_HTTP_CODE

public static final java.lang.String CAPTURE_HTTP_CODE

Result: 3-digit integer HTTP response code. may be '0' in some fringe conditions, old ARCs, bug in crawler, etc.

See Also:

Constant Field Values

CAPTURE_DIGEST

public static final java.lang.String CAPTURE_DIGEST

Result: some form of document fingerprint. This should represent the HTTP payload only for HTTP captured resources. It may represent an MD5, a SHA1, and may be a fragment of the full representation of the digest.

See Also:

Constant Field Values

CAPTURE_REDIRECT_URL

public static final java.lang.String CAPTURE_REDIRECT_URL

Result: URL that this document redirected to, or '-' if it does not redirect

See Also:

Constant Field Values

CAPTURE_CLOSEST_INDICATOR

public static final java.lang.String CAPTURE_CLOSEST_INDICATOR

Result: flag within a SearchResult that indicates this is the closest to a particular requested date.

See Also:

Constant Field Values

CAPTURE_CLOSEST_VALUE

public static final java.lang.String CAPTURE_CLOSEST_VALUE

See Also:

Constant Field Values

CAPTURE_DUPLICATE_ANNOTATION

public static final java.lang.String CAPTURE_DUPLICATE_ANNOTATION

Result: this key being present indicates that this particular capture was not actually stored, and that other values within this SearchResult are actually values from a different record which *should* be identical to this capture, had it been stored.

See Also:

Constant Field Values

CAPTURE_DUPLICATE_STORED_TS

public static final java.lang.String CAPTURE_DUPLICATE_STORED_TS

Result: this key is present when the CAPTURE_DUPLICATE_ANNOTATION is also present, with the value indicating the last date that was actually stored for this duplicate.

See Also:

Constant Field Values

CAPTURE_DUPLICATE_DIGEST

public static final java.lang.String CAPTURE_DUPLICATE_DIGEST

flag indicates that this document was downloaded and verified as identical to a previous capture by digest.

See Also:

Constant Field Values

CAPTURE_DUPLICATE_HTTP

public static final java.lang.String CAPTURE_DUPLICATE_HTTP

flag indicates that this document was NOT downloaded, but that the origin server indicated that the document had not changed, based on If-Modified HTTP request headers.

See Also:

Constant Field Values

Constructor Detail

CaptureSearchResult

public CaptureSearchResult()

Method Detail

getOriginalUrl

public java.lang.String getOriginalUrl()

setOriginalUrl

public void setOriginalUrl(java.lang.String originalUrl)

getOriginalHost

public java.lang.String getOriginalHost()

getUrlKey

public java.lang.String getUrlKey()

setUrlKey

public void setUrlKey(java.lang.String urlKey)

getCaptureDate

public java.util.Date getCaptureDate()

setCaptureDate

public void setCaptureDate(java.util.Date date)

getCaptureTimestamp

public java.lang.String getCaptureTimestamp()

setCaptureTimestamp

public void setCaptureTimestamp(java.lang.String timestamp)

getFile

public java.lang.String getFile()

setFile

public void setFile(java.lang.String file)

getOffset

public long getOffset()

setOffset

public void setOffset(long offset)

getMimeType

public java.lang.String getMimeType()

setMimeType

public void setMimeType(java.lang.String mimeType)

getHttpCode

public java.lang.String getHttpCode()

setHttpCode

public void setHttpCode(java.lang.String httpCode)

getDigest

public java.lang.String getDigest()

setDigest

public void setDigest(java.lang.String digest)

getRedirectUrl

public java.lang.String getRedirectUrl()

setRedirectUrl

public void setRedirectUrl(java.lang.String url)

isClosest

public boolean isClosest()

setClosest

public void setClosest(boolean value)

flagDuplicateDigest

public void flagDuplicateDigest(java.util.Date storedDate)

flagDuplicateDigest

public void flagDuplicateDigest(java.lang.String storedTS)

isDuplicateDigest

public boolean isDuplicateDigest()

getDuplicateDigestStoredDate

public java.util.Date getDuplicateDigestStoredDate()

getDuplicateDigestStoredTimestamp

public java.lang.String getDuplicateDigestStoredTimestamp()