|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.archive.io.arc.ARCRecordMetaData
public class ARCRecordMetaData
An immutable class to hold an ARC record meta data.
| Field Summary | |
|---|---|
protected java.util.Map |
headerFields
Map of record header fields. |
| Fields inherited from interface org.archive.io.ArchiveFileConstants |
|---|
ABSOLUTE_OFFSET_KEY, CDX, CDX_FILE, CDX_LINE_BUFFER_SIZE, COMPRESSED_FILE_EXTENSION, CRLF, DATE_FIELD_KEY, DEFAULT_DIGEST_METHOD, DUMP, GZIP_DUMP, HEADER, INVALID_SUFFIX, LENGTH_FIELD_KEY, MIMETYPE_FIELD_KEY, NOHEAD, OCCUPIED_SUFFIX, READER_IDENTIFIER_FIELD_KEY, RECORD_IDENTIFIER_FIELD_KEY, SINGLE_SPACE, TYPE_FIELD_KEY, URL_FIELD_KEY, VERSION_FIELD_KEY |
| Constructor Summary | |
|---|---|
protected |
ARCRecordMetaData()
Shut down the default constructor. |
|
ARCRecordMetaData(java.lang.String arc,
java.util.Map headerFields)
Constructor. |
| Method Summary | |
|---|---|
java.lang.String |
getArc()
|
java.io.File |
getArcFile()
|
int |
getContentBegin()
Offset at which the content begins. |
java.lang.String |
getDate()
Get the time when the record was harvested. |
java.lang.String |
getDigest()
|
java.util.Set |
getHeaderFieldKeys()
|
java.util.Map |
getHeaderFields()
|
java.lang.Object |
getHeaderValue(java.lang.String key)
|
java.lang.String |
getIp()
|
long |
getLength()
|
java.lang.String |
getMimetype()
|
long |
getOffset()
|
java.lang.String |
getReaderIdentifier()
|
java.lang.String |
getRecordIdentifier()
|
java.lang.String |
getStatusCode()
|
java.lang.String |
getUrl()
|
java.lang.String |
getVersion()
|
(package private) void |
setContentBegin(int offset)
|
void |
setDigest(java.lang.String d)
|
void |
setStatusCode(java.lang.String statusCode)
|
protected void |
testRequiredField(java.util.Map fields,
java.lang.String requiredField)
Test required field is present in hash. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected java.util.Map headerFields
Keys are lowercase.
| Constructor Detail |
|---|
protected ARCRecordMetaData()
public ARCRecordMetaData(java.lang.String arc,
java.util.Map headerFields)
throws java.io.IOException
arc - The arc file this metadata came out of.headerFields - Hash of meta fields.
java.io.IOException| Method Detail |
|---|
protected void testRequiredField(java.util.Map fields,
java.lang.String requiredField)
throws java.io.IOException
fields - Map of fields.requiredField - Field to test for.
java.io.IOException - If required field is not present.public java.lang.String getDate()
Returns the date in Heritrix 14 digit time format (UTC). See the
ArchiveUtils class for converting to Java
dates.
getDate in interface ArchiveRecordHeaderArchiveUtils.parse14DigitDate(String)public long getLength()
getLength in interface ArchiveRecordHeaderpublic java.lang.String getUrl()
getUrl in interface ArchiveRecordHeaderpublic java.lang.String getIp()
public java.lang.String getMimetype()
getMimetype in interface ArchiveRecordHeaderpublic java.lang.String getVersion()
getVersion in interface ArchiveRecordHeaderpublic long getOffset()
getOffset in interface ArchiveRecordHeaderpublic java.lang.Object getHeaderValue(java.lang.String key)
getHeaderValue in interface ArchiveRecordHeaderkey - Key to use looking up field value.
public java.util.Set getHeaderFieldKeys()
getHeaderFieldKeys in interface ArchiveRecordHeaderpublic java.util.Map getHeaderFields()
getHeaderFields in interface ArchiveRecordHeaderpublic java.lang.String getArc()
public java.io.File getArcFile()
public java.lang.String getDigest()
getDigest in interface ArchiveRecordHeaderpublic void setDigest(java.lang.String d)
d - The digest to set.public java.lang.String getStatusCode()
public void setStatusCode(java.lang.String statusCode)
statusCode - The statusCode to set.public java.lang.String toString()
toString in interface ArchiveRecordHeadertoString in class java.lang.Objectpublic java.lang.String getReaderIdentifier()
getReaderIdentifier in interface ArchiveRecordHeaderpublic java.lang.String getRecordIdentifier()
getRecordIdentifier in interface ArchiveRecordHeaderpublic int getContentBegin()
ArchiveRecordHeader
getContentBegin in interface ArchiveRecordHeadervoid setContentBegin(int offset)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||