org.archive.io.warc

Class WARCReaderFactory.CompressedWARCReader

java.lang.Object

org.archive.io.ArchiveReader

org.archive.io.warc.WARCReader

org.archive.io.warc.WARCReaderFactory.CompressedWARCReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ArchiveRecord>, ArchiveFileConstants, WARCConstants

Enclosing class:

WARCReaderFactory

public class WARCReaderFactory.CompressedWARCReader
extends WARCReader

Compressed WARC file reader.

Author:

stack

Nested Class Summary

Nested classes/interfaces inherited from class org.archive.io.ArchiveReader

ArchiveReader.ArchiveRecordIterator

Nested classes/interfaces inherited from interface org.archive.format.warc.WARCConstants

WARCConstants.WARCRecordType

Field Summary

Fields inherited from class org.archive.io.ArchiveReader

in, MAX_ALLOWED_RECOVERABLES

Fields inherited from interface org.archive.format.warc.WARCConstants

COLON_SPACE, COMPRESSED_WARC_FILE_EXTENSION, CONTENT_DESCRIPTION, CONTENT_LENGTH, CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_MAX_WARC_FILE_SIZE, DOT_COMPRESSED_WARC_FILE_EXTENSION, DOT_WARC_FILE_EXTENSION, FTP_CONTROL_CONVERSATION_MIMETYPE, HEADER_FIELD_SEPARATOR, HEADER_KEY_BLOCK_DIGEST, HEADER_KEY_CONCURRENT_TO, HEADER_KEY_DATE, HEADER_KEY_ETAG, HEADER_KEY_FILENAME, HEADER_KEY_ID, HEADER_KEY_IP, HEADER_KEY_LAST_MODIFIED, HEADER_KEY_PAYLOAD_DIGEST, HEADER_KEY_PROFILE, HEADER_KEY_REFERS_TO, HEADER_KEY_REFERS_TO_DATE, HEADER_KEY_REFERS_TO_FILE_OFFSET, HEADER_KEY_REFERS_TO_FILENAME, HEADER_KEY_REFERS_TO_TARGET_URI, HEADER_KEY_TRUNCATED, HEADER_KEY_TYPE, HEADER_KEY_URI, HEADER_LINE_ENCODING, HTTP_REQUEST_MIMETYPE, HTTP_RESPONSE_MIMETYPE, MAX_LINE_LENGTH, MAX_WARC_HEADER_LINE_LENGTH, NAMED_FIELD_CHECKSUM_LABEL, NAMED_FIELD_DESCRIPTION, NAMED_FIELD_FILEDESC, NAMED_FIELD_IP_LABEL, NAMED_FIELD_RELATED_LABEL, NAMED_FIELD_TRUNCATED, NAMED_FIELD_TRUNCATED_VALUE_HEAD, NAMED_FIELD_TRUNCATED_VALUE_LENGTH, NAMED_FIELD_TRUNCATED_VALUE_TIME, NAMED_FIELD_TRUNCATED_VALUE_UNSPECIFIED, NAMED_FIELD_WARCFILENAME, PLACEHOLDER_RECORD_LENGTH_STRING, PROFILE_REVISIT_IDENTICAL_DIGEST, PROFILE_REVISIT_NOT_MODIFIED, PROFILE_REVISIT_URI_AGNOSTIC_IDENTICAL_DIGEST, TRUNCATED_VALUE_UNSPECIFIED, TYPE, WARC_FIELDS_TYPE, WARC_FILE_EXTENSION, WARC_HEADER_ENCODING, WARC_ID, WARC_MAGIC, WARC_VERSION, WSP

Fields inherited from interface org.archive.format.ArchiveFileConstants

ABSOLUTE_OFFSET_KEY, CDX, CDX_FILE, CDX_LINE_BUFFER_SIZE, CRLF, DATE_FIELD_KEY, DEFAULT_DIGEST_METHOD, DOT_COMPRESSED_FILE_EXTENSION, 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

Constructors

Constructor and Description
WARCReaderFactory.CompressedWARCReader(File f) Constructor.
WARCReaderFactory.CompressedWARCReader(File f, long offset) Constructor.
WARCReaderFactory.CompressedWARCReader(String f, InputStream is, boolean atFirstRecord) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
WARCRecord	get(long offset) Get record at passed offset.
protected void	gotoEOR(ArchiveRecord rec) Skip over any trailing new lines at end of the record so we're lined up ready to read the next.
Iterator<ArchiveRecord>	iterator() Returns an ArchiveRecord iterator.

Methods inherited from class org.archive.io.warc.WARCReader

createArchiveRecord, createCDXIndexFile, dump, getDeleteFileOnCloseReader, getDotFileExtension, getFileExtension, initialize, main, output, readExpectedChar

Methods inherited from class org.archive.io.ArchiveReader

cdxOutput, cleanupCurrentRecord, close, currentRecord, get, getCurrentRecord, getFileName, getIn, getInputStream, getLogger, getOptions, getReaderIdentifier, getStrippedFileName, getStrippedFileName, getTrueOrFalse, getVersion, isCompressed, isDigest, isStrict, isValid, logStdErr, output, outputRecord, outputRecord, positionForRecord, setCompressed, setDigest, setIn, setReaderIdentifier, setStrict, setVersion, stripExtension, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

WARCReaderFactory.CompressedWARCReader

public WARCReaderFactory.CompressedWARCReader(File f)
                                       throws IOException

Constructor.

Parameters:

f - Compressed file to read.

Throws:

IOException

WARCReaderFactory.CompressedWARCReader

public WARCReaderFactory.CompressedWARCReader(File f,
                                      long offset)
                                       throws IOException

Constructor.

Parameters:

f - Compressed arcfile to read.

offset - Position at where to start reading file.

Throws:

IOException

WARCReaderFactory.CompressedWARCReader

public WARCReaderFactory.CompressedWARCReader(String f,
                                      InputStream is,
                                      boolean atFirstRecord)
                                       throws IOException

Constructor.

Parameters:

f - Compressed arcfile.

is - InputStream to use.

atFirstRecord -

Throws:

IOException

Method Detail

get

public WARCRecord get(long offset)
               throws IOException

Get record at passed offset.

Overrides:

get in class ArchiveReader

Parameters:

offset - Byte index into file at which a record starts.

Returns:

A WARCRecord reference.

Throws:

IOException

iterator

public Iterator<ArchiveRecord> iterator()

Description copied from class: ArchiveReader

Returns an ArchiveRecord iterator. Of note, on IOException, especially if ZipException reading compressed ARCs, rather than fail the iteration, try moving to the next record. If ArchiveReader.strict is not set, this will usually succeed.

Specified by:

iterator in interface Iterable<ArchiveRecord>

Overrides:

iterator in class ArchiveReader

Returns:

An iterator over ARC records.

gotoEOR

protected void gotoEOR(ArchiveRecord rec)
                throws IOException

Description copied from class: WARCReader

Skip over any trailing new lines at end of the record so we're lined up ready to read the next.

Overrides:

gotoEOR in class WARCReader

Throws:

IOException