org.archive.wayback.core

Class FastCaptureSearchResult

java.lang.Object

org.archive.wayback.core.SearchResult

org.archive.wayback.core.CaptureSearchResult

org.archive.wayback.core.FastCaptureSearchResult

All Implemented Interfaces:

Capture

Direct Known Subclasses:

AccessCheckFilter.CDXSearchResult

public class FastCaptureSearchResult
extends CaptureSearchResult

Field Summary

Fields

Modifier and Type	Field and Description
protected String	captureTimestamp
protected String	digest
static String	EMPTY_VALUE
protected String	file
protected String	httpCode
protected String	mimeType
protected String	oraclePolicy
protected String	originalUrl
protected String	redirectUrl
protected CaptureSearchResult	revisitPayload
protected String	robotFlags
protected String	urlKey

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

cachedCompressedLength, cachedDate, cachedOffset, CAPTURE_CAPTURE_TIMESTAMP, CAPTURE_CLOSEST_INDICATOR, CAPTURE_CLOSEST_VALUE, CAPTURE_COMPRESSED_LENGTH, CAPTURE_DIGEST, CAPTURE_DUPLICATE_ANNOTATION, CAPTURE_DUPLICATE_DIGEST, CAPTURE_DUPLICATE_HTTP, CAPTURE_DUPLICATE_PAYLOAD_COMPRESSED_LENGTH, CAPTURE_DUPLICATE_PAYLOAD_FILE, CAPTURE_DUPLICATE_PAYLOAD_OFFSET, CAPTURE_DUPLICATE_STORED_TS, CAPTURE_FILE, CAPTURE_HTTP_CODE, CAPTURE_MIME_TYPE, CAPTURE_OFFSET, CAPTURE_ORACLE_POLICY, CAPTURE_ORIGINAL_HOST, CAPTURE_ORIGINAL_URL, CAPTURE_REDIRECT_URL, CAPTURE_ROBOT_BLOCKED, CAPTURE_ROBOT_FLAGS, CAPTURE_ROBOT_IGNORE, CAPTURE_ROBOT_NOARCHIVE, CAPTURE_ROBOT_NOFOLLOW, CAPTURE_ROBOT_NOINDEX, CAPTURE_URL_KEY

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

CUSTOM_HEADER_PREFIX, data, RESULT_TRUE_VALUE

Constructor Summary

Constructors

Constructor and Description
FastCaptureSearchResult()

Method Summary

Methods

Modifier and Type	Method and Description
void	flagDuplicateDigest()
void	flagDuplicateDigest(CaptureSearchResult payload) Mark this capture as a revisit of previous capture payload, identified by content digest.
void	flagDuplicateDigest(Date storedDate)
void	flagDuplicateDigest(String storedTS)
void	flagDuplicateHTTP(Date storedDate)
void	flagDuplicateHTTP(String storedTS)
Date	getCaptureDate()
String	getCaptureTimestamp() return time of capture.
long	getCompressedLength()
String	getDigest()
Date	getDuplicateDigestStoredDate()
String	getDuplicateDigestStoredTimestamp() same with CaptureSearchResult.getDuplicateDigestStoredDate(), but returns raw timestamp value.
CaptureSearchResult	getDuplicatePayload()
long	getDuplicatePayloadCompressedLength()
String	getDuplicatePayloadFile()
Long	getDuplicatePayloadOffset()
String	getFile()
String	getHttpCode()
String	getMimeType()
long	getOffset()
String	getOraclePolicy()
String	getOriginalHost()
String	getOriginalUrl() return the original URL (ordinary, non-SURT form) which resulted in the capture.
String	getRedirectUrl()
String	getRobotFlags() return robot flags field value.
String	getUrlKey() return the URL key of this capture.
boolean	isClosest()
boolean	isDuplicateHTTP() whether this capture is an archive of 304 Not Modified response from the server.
boolean	isRevisitDigest() whether this capture is a re-fetch of previously archived capture (revisit), detected by content's digest.
void	setCaptureDate(Date date)
void	setCaptureTimestamp(String captureTimestamp)
void	setClosest(boolean value)
void	setCompressedLength(long offset)
void	setDigest(String digest)
void	setFile(String file)
void	setHttpCode(String httpCode)
void	setMimeType(String mimeType)
void	setOffset(long offset)
void	setOraclePolicy(String policy)
void	setOriginalHost(String originalHost)
void	setOriginalUrl(String originalUrl)
void	setRedirectUrl(String redirectUrl)
void	setRobotFlags(String robotFlags) Set robot flags field value as a whole.
void	setUrlKey(String urlKey)

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

getDuplicateHTTPStoredDate, getDuplicateHTTPStoredTimestamp, getNextResult, getPrevResult, isDuplicateDigest, isHttpError, isHttpRedirect, isHttpSuccess, isRobotFlagSet, isRobotFlagSet, isRobotIgnore, isRobotNoArchive, isRobotNoFollow, isRobotNoIndex, removeFromList, setNextResult, setPrevResult, setRobotFlag, setRobotFlag, setRobotIgnore, setRobotNoArchive, setRobotNoFollow, setRobotNoIndex, toString

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

dateToTS, ensureMap, fromCanonicalStringMap, get, getBoolean, getCustom, put, putBoolean, putCustom, toCanonicalStringMap, tsToDate

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_VALUE

public static final String EMPTY_VALUE

See Also:

Constant Field Values

urlKey

protected String urlKey

captureTimestamp

protected String captureTimestamp

originalUrl

protected String originalUrl

mimeType

protected String mimeType

httpCode

protected String httpCode

digest

protected String digest

redirectUrl

protected String redirectUrl

file

protected String file

robotFlags

protected String robotFlags

oraclePolicy

protected String oraclePolicy

revisitPayload

protected CaptureSearchResult revisitPayload

Constructor Detail

FastCaptureSearchResult

public FastCaptureSearchResult()

Method Detail

getUrlKey

public String getUrlKey()

Description copied from interface: Capture

return the URL key of this capture.

Specified by:

getUrlKey in interface Capture

Overrides:

getUrlKey in class CaptureSearchResult

Returns:

URL key

setUrlKey

public void setUrlKey(String urlKey)

Overrides:

setUrlKey in class CaptureSearchResult

getCaptureTimestamp

public String getCaptureTimestamp()

Description copied from interface: Capture

return time of capture.

Specified by:

getCaptureTimestamp in interface Capture

Overrides:

getCaptureTimestamp in class CaptureSearchResult

Returns:

String in "YYYYmmddHHMMSS" format.

setCaptureTimestamp

public void setCaptureTimestamp(String captureTimestamp)

Overrides:

setCaptureTimestamp in class CaptureSearchResult

getOriginalUrl

public String getOriginalUrl()

Description copied from interface: Capture

return the original URL (ordinary, non-SURT form) which resulted in the capture.

Specified by:

getOriginalUrl in interface Capture

Overrides:

getOriginalUrl in class CaptureSearchResult

Returns:

the original URL

setOriginalUrl

public void setOriginalUrl(String originalUrl)

Overrides:

setOriginalUrl in class CaptureSearchResult

Parameters:

originalUrl - as close to the original URL by which this Resource was captured as is possible

getMimeType

public String getMimeType()

Overrides:

getMimeType in class CaptureSearchResult

setMimeType

public void setMimeType(String mimeType)

Overrides:

setMimeType in class CaptureSearchResult

getHttpCode

public String getHttpCode()

Overrides:

getHttpCode in class CaptureSearchResult

setHttpCode

public void setHttpCode(String httpCode)

Overrides:

setHttpCode in class CaptureSearchResult

getDigest

public String getDigest()

Overrides:

getDigest in class CaptureSearchResult

setDigest

public void setDigest(String digest)

Overrides:

setDigest in class CaptureSearchResult

getRedirectUrl

public String getRedirectUrl()

Overrides:

getRedirectUrl in class CaptureSearchResult

setRedirectUrl

public void setRedirectUrl(String redirectUrl)

Overrides:

setRedirectUrl in class CaptureSearchResult

getFile

public String getFile()

Overrides:

getFile in class CaptureSearchResult

setFile

public void setFile(String file)

Overrides:

setFile in class CaptureSearchResult

getRobotFlags

public String getRobotFlags()

Description copied from class: CaptureSearchResult

return robot flags field value.

Overrides:

getRobotFlags in class CaptureSearchResult

Returns:

setRobotFlags

public void setRobotFlags(String robotFlags)

Description copied from class: CaptureSearchResult

Set robot flags field value as a whole. For adding a flag, use CaptureSearchResult.setRobotFlag(char) or CaptureSearchResult.setRobotFlag(String).

Overrides:

setRobotFlags in class CaptureSearchResult

Parameters:

robotFlags - new field value

getOffset

public long getOffset()

Overrides:

getOffset in class CaptureSearchResult

setOffset

public void setOffset(long offset)

Overrides:

setOffset in class CaptureSearchResult

getCompressedLength

public long getCompressedLength()

Overrides:

getCompressedLength in class CaptureSearchResult

setCompressedLength

public void setCompressedLength(long offset)

Overrides:

setCompressedLength in class CaptureSearchResult

getOraclePolicy

public String getOraclePolicy()

Overrides:

getOraclePolicy in class CaptureSearchResult

setOraclePolicy

public void setOraclePolicy(String policy)

Overrides:

setOraclePolicy in class CaptureSearchResult

flagDuplicateDigest

public void flagDuplicateDigest()

Overrides:

flagDuplicateDigest in class CaptureSearchResult

isRevisitDigest

public boolean isRevisitDigest()

Description copied from class: CaptureSearchResult

whether this capture is a re-fetch of previously archived capture (revisit), detected by content's digest.

This method is meant for use by replay processing. For use in user interface / web API code, consider CaptureSearchResult.isDuplicateDigest() is more appropriate.

Overrides:

isRevisitDigest in class CaptureSearchResult

Returns:

true if revisit

flagDuplicateDigest

public void flagDuplicateDigest(CaptureSearchResult payload)

Description copied from class: CaptureSearchResult

Mark this capture as a revisit of previous capture payload, identified by content digest.

Record location information is copied from payload so that the content can be loaded from the record later.

ResourceIndex implementations should call this method before returning CaptureSearchResults to AccessPoint.

Overrides:

flagDuplicateDigest in class CaptureSearchResult

Parameters:

payload - capture being revisited

See Also:

CaptureSearchResult.getDuplicateDigestStoredTimestamp(), CaptureSearchResult.getDuplicateDigestStoredDate(), CaptureSearchResult.getDuplicatePayloadFile(), CaptureSearchResult.getDuplicatePayloadOffset(), CaptureSearchResult.getDuplicatePayloadCompressedLength()

getDuplicatePayload

public CaptureSearchResult getDuplicatePayload()

Overrides:

getDuplicatePayload in class CaptureSearchResult

getDuplicatePayloadFile

public String getDuplicatePayloadFile()

Overrides:

getDuplicatePayloadFile in class CaptureSearchResult

getDuplicatePayloadOffset

public Long getDuplicatePayloadOffset()

Overrides:

getDuplicatePayloadOffset in class CaptureSearchResult

getDuplicatePayloadCompressedLength

public long getDuplicatePayloadCompressedLength()

Overrides:

getDuplicatePayloadCompressedLength in class CaptureSearchResult

getDuplicateDigestStoredDate

public Date getDuplicateDigestStoredDate()

Overrides:

getDuplicateDigestStoredDate in class CaptureSearchResult

getDuplicateDigestStoredTimestamp

public String getDuplicateDigestStoredTimestamp()

Description copied from class: CaptureSearchResult

same with CaptureSearchResult.getDuplicateDigestStoredDate(), but returns raw timestamp value.

Overrides:

getDuplicateDigestStoredTimestamp in class CaptureSearchResult

Returns:

string representing timestamp.

getOriginalHost

public String getOriginalHost()

Overrides:

getOriginalHost in class CaptureSearchResult

setOriginalHost

public void setOriginalHost(String originalHost)

Overrides:

setOriginalHost in class CaptureSearchResult

getCaptureDate

public Date getCaptureDate()

Overrides:

getCaptureDate in class CaptureSearchResult

setCaptureDate

public void setCaptureDate(Date date)

Overrides:

setCaptureDate in class CaptureSearchResult

isClosest

public boolean isClosest()

Overrides:

isClosest in class CaptureSearchResult

setClosest

public void setClosest(boolean value)

Overrides:

setClosest in class CaptureSearchResult

flagDuplicateDigest

public void flagDuplicateDigest(Date storedDate)

Overrides:

flagDuplicateDigest in class CaptureSearchResult

flagDuplicateDigest

public void flagDuplicateDigest(String storedTS)

Overrides:

flagDuplicateDigest in class CaptureSearchResult

flagDuplicateHTTP

public void flagDuplicateHTTP(Date storedDate)

Overrides:

flagDuplicateHTTP in class CaptureSearchResult

flagDuplicateHTTP

public void flagDuplicateHTTP(String storedTS)

Overrides:

flagDuplicateHTTP in class CaptureSearchResult

isDuplicateHTTP

public boolean isDuplicateHTTP()

Description copied from class: CaptureSearchResult

whether this capture is an archive of 304 Not Modified response from the server.

Overrides:

isDuplicateHTTP in class CaptureSearchResult

Returns: