WarcRecordData (JHOVE - JSTOR/Harvard Object Validation Environment 1.16.0 API)

java.lang.Object
- edu.harvard.hul.ois.jhove.module.warc.WarcRecordData

```
public class WarcRecordData
extends Object
```
Copied from JHOVE2 WARC module. This class is a wrapper for the information available in an WARC record. Since the WARC reader is not persistent its data must be moved to a simpler data class which can be persisted instead. Note: Some populate methods currently do not include any functionality. However they are included for backwards compatibility in case the ISO standard changes and extra properties are required.

Author:

nicl

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`bHasPayload`
`protected Boolean`	`bIsNonCompliant` Boolean indicating whether this record is compliant or not.
`protected String`	`computedBlockDigest` Computed block digest.
`protected String`	`computedBlockDigestAlgorithm` Computed block digest algorithm.
`protected String`	`computedBlockDigestEncoding` Computed block digest encoding.
`protected String`	`computedPayloadDigest` Computed payload digest, if applicable.
`protected String`	`computedPayloadDigestAlgorithm` Computed payload digest algorithm, if applicable.
`protected String`	`computedPayloadDigestEncoding` Computed payload digest encoding, if applicable.
`protected Long`	`consumed` Number of bytes consumed validating record.
`protected String`	`contentLength` Content-Length read from header.
`protected String`	`contentType` Content-type read from header.
`protected String`	`ipVersion` IP vresion of WARC-IP-Address (4 or 6).
`protected Boolean`	`isValidBlockDigest` Boolean indicating whether the block digest is valid or not.
`protected Boolean`	`isValidPayloadDigest` Boolean indicating whether the payload digest is valid or not.
`protected String`	`payloadLength` Payload length, without payload header (version block/HTTP header).
`protected String`	`protocolContentType` Content-type read from HTTP header, if present.
`protected String`	`protocolServer` Server header entry read from HTTP header, if present.
`protected String`	`protocolUserAgent` User-Agent header entry read from HTTP header, if present.
`protected String`	`protocolVersion` Protocol version read from HTTP header, if present.
`protected String`	`recordIdScheme` WARC-Record-Id scheme used.
`protected String`	`resultCode` Result-code read from HTTP header, if present.
`protected Long`	`startOffset` Start offset of record in input stream.
`protected String`	`warcBlockDigest` Block digest read from header.
`protected String`	`warcBlockDigestAlgorithm` Block digest algorithm read from header.
`protected String`	`warcBlockDigestEncoding` Block digest encoding auto-detected from digest and algorithm.
`protected List<String>`	`warcConcurrentToList` List of WARC-Concurrent-To read from header.
`protected String`	`warcDate` WARC-Date read from header.
`protected String`	`warcFilename` WARC-Filename read from header.
`protected String`	`warcIdentifiedPayloadType` WARC-Identified-Payload-Type read from header.
`protected String`	`warcIpAddress` WARC-IP-Address read from header.
`protected String`	`warcPayloadDigest` Payload digest read from header.
`protected String`	`warcPayloadDigestAlgorithm` Payload digest algorithm read from header.
`protected String`	`warcPayloadDigestEncoding` Payload digest encoding auto-detected from digest and algorithm.
`protected String`	`warcProfile` WARC-Profile read from header.
`protected String`	`warcRecordId` WARC-Record-Id read from header.
`protected String`	`warcRefersTo` WARC-Refers-To read from header.
`protected String`	`warcSegmentNumber` WARC-Segment-Number read from header.
`protected String`	`warcSegmentOriginId` WARC-Segment-Origin-ID read from header.
`protected String`	`warcSegmentTotalLength` WARC-Segment-Total-Length read from header.
`protected String`	`warcTargetUri` WARC-Target-URI read from header.
`protected String`	`warcTruncated` WARC-Truncated read from header.
`protected String`	`warcType` WARC-Type read from header.
`protected String`	`warcVersionStr` WARC version read from header.
`protected String`	`warcWarcinfoId` WARC-Warcinfo-ID read from header.

Constructor Summary

Constructors
Constructor and Description
`WarcRecordData()` Constructor required by the persistence layer.
`WarcRecordData(org.jwat.warc.WarcRecord record)` Constructs an object using the data in the `WarcRecord` object.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - startOffset
```
protected Long startOffset
```
    Start offset of record in input stream.
  - consumed
```
protected Long consumed
```
    Number of bytes consumed validating record.
  - warcVersionStr
```
protected String warcVersionStr
```
    WARC version read from header.
  - warcType
```
protected String warcType
```
    WARC-Type read from header.
  - warcFilename
```
protected String warcFilename
```
    WARC-Filename read from header.
  - warcRecordId
```
protected String warcRecordId
```
    WARC-Record-Id read from header.
  - warcDate
```
protected String warcDate
```
    WARC-Date read from header.
  - contentLength
```
protected String contentLength
```
    Content-Length read from header.
  - contentType
```
protected String contentType
```
    Content-type read from header.
  - warcTruncated
```
protected String warcTruncated
```
    WARC-Truncated read from header.
  - warcIpAddress
```
protected String warcIpAddress
```
    WARC-IP-Address read from header.
  - warcConcurrentToList
```
protected List<String> warcConcurrentToList
```
    List of WARC-Concurrent-To read from header.
  - warcRefersTo
```
protected String warcRefersTo
```
    WARC-Refers-To read from header.
  - warcTargetUri
```
protected String warcTargetUri
```
    WARC-Target-URI read from header.
  - warcWarcinfoId
```
protected String warcWarcinfoId
```
    WARC-Warcinfo-ID read from header.
  - warcIdentifiedPayloadType
```
protected String warcIdentifiedPayloadType
```
    WARC-Identified-Payload-Type read from header.
  - warcProfile
```
protected String warcProfile
```
    WARC-Profile read from header.
  - warcSegmentNumber
```
protected String warcSegmentNumber
```
    WARC-Segment-Number read from header.
  - warcSegmentOriginId
```
protected String warcSegmentOriginId
```
    WARC-Segment-Origin-ID read from header.
  - warcSegmentTotalLength
```
protected String warcSegmentTotalLength
```
    WARC-Segment-Total-Length read from header.
  - warcBlockDigest
```
protected String warcBlockDigest
```
    Block digest read from header.
  - warcBlockDigestAlgorithm
```
protected String warcBlockDigestAlgorithm
```
    Block digest algorithm read from header.
  - warcBlockDigestEncoding
```
protected String warcBlockDigestEncoding
```
    Block digest encoding auto-detected from digest and algorithm.
  - warcPayloadDigest
```
protected String warcPayloadDigest
```
    Payload digest read from header.
  - warcPayloadDigestAlgorithm
```
protected String warcPayloadDigestAlgorithm
```
    Payload digest algorithm read from header.
  - warcPayloadDigestEncoding
```
protected String warcPayloadDigestEncoding
```
    Payload digest encoding auto-detected from digest and algorithm.
  - computedBlockDigest
```
protected String computedBlockDigest
```
    Computed block digest.
  - computedBlockDigestAlgorithm
```
protected String computedBlockDigestAlgorithm
```
    Computed block digest algorithm.
  - computedBlockDigestEncoding
```
protected String computedBlockDigestEncoding
```
    Computed block digest encoding.
  - computedPayloadDigest
```
protected String computedPayloadDigest
```
    Computed payload digest, if applicable.
  - computedPayloadDigestAlgorithm
```
protected String computedPayloadDigestAlgorithm
```
    Computed payload digest algorithm, if applicable.
  - computedPayloadDigestEncoding
```
protected String computedPayloadDigestEncoding
```
    Computed payload digest encoding, if applicable.
  - recordIdScheme
```
protected String recordIdScheme
```
    WARC-Record-Id scheme used.
  - bIsNonCompliant
```
protected Boolean bIsNonCompliant
```
    Boolean indicating whether this record is compliant or not.
  - isValidBlockDigest
```
protected Boolean isValidBlockDigest
```
    Boolean indicating whether the block digest is valid or not.
  - isValidPayloadDigest
```
protected Boolean isValidPayloadDigest
```
    Boolean indicating whether the payload digest is valid or not.
  - bHasPayload
```
protected Boolean bHasPayload
```
  - payloadLength
```
protected String payloadLength
```
    Payload length, without payload header (version block/HTTP header).
  - ipVersion
```
protected String ipVersion
```
    IP vresion of WARC-IP-Address (4 or 6).
  - resultCode
```
protected String resultCode
```
    Result-code read from HTTP header, if present.
  - protocolVersion
```
protected String protocolVersion
```
    Protocol version read from HTTP header, if present.
  - protocolContentType
```
protected String protocolContentType
```
    Content-type read from HTTP header, if present.
  - protocolServer
```
protected String protocolServer
```
    Server header entry read from HTTP header, if present.
  - protocolUserAgent
```
protected String protocolUserAgent
```
    User-Agent header entry read from HTTP header, if present.
- Constructor Detail
  - WarcRecordData
```
public WarcRecordData()
```
    Constructor required by the persistence layer.
  - WarcRecordData
```
public WarcRecordData(org.jwat.warc.WarcRecord record)
```
    Constructs an object using the data in the WarcRecord object.
    
    Parameters:
    
    record - parsed WARC record

Class WarcRecordData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startOffset

consumed

warcVersionStr

warcType

warcFilename

warcRecordId

warcDate

contentLength

contentType

warcTruncated

warcIpAddress

warcConcurrentToList

warcRefersTo

warcTargetUri

warcWarcinfoId

warcIdentifiedPayloadType

warcProfile

warcSegmentNumber

warcSegmentOriginId

warcSegmentTotalLength

warcBlockDigest

warcBlockDigestAlgorithm

warcBlockDigestEncoding

warcPayloadDigest

warcPayloadDigestAlgorithm

warcPayloadDigestEncoding

computedBlockDigest

computedBlockDigestAlgorithm

computedBlockDigestEncoding

computedPayloadDigest

computedPayloadDigestAlgorithm

computedPayloadDigestEncoding

recordIdScheme

bIsNonCompliant

isValidBlockDigest

isValidPayloadDigest

bHasPayload

payloadLength

ipVersion

resultCode

protocolVersion

protocolContentType

protocolServer

protocolUserAgent

Constructor Detail

WarcRecordData

WarcRecordData