org.archive.format

Interface ArchiveFileConstants

All Known Subinterfaces:

ARCConstants, ARCConstants, ArchiveFileConstants, WARCConstants, WARCConstants

All Known Implementing Classes:

ArchiveReader, ArchiveReaderFactory, ARCMetaData, ARCMetaDataParser, ARCReader, ARCReaderFactory, ARCReaderFactory.CompressedARCReader, ARCReaderFactory.UncompressedARCReader, ARCRecord, ARCRecordMetaData, ARCResource, ARCUtils, ARCWriter, HTTPHeadersResource, WARCReader, WARCReaderFactory, WARCReaderFactory.CompressedWARCReader, WARCReaderFactory.UncompressedWARCReader, WARCRecord, WARCRecordWriter, WARCWriter, WriterPoolMember

public interface ArchiveFileConstants

Constants used by Archive files and in Archive file processing.

Version:

$Date$ $Revision$

Author:

stack

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABSOLUTE_OFFSET_KEY Key for the Archive Record absolute offset into Archive file.
static String	CDX
static String	CDX_FILE
static int	CDX_LINE_BUFFER_SIZE Size used to preallocate stringbuffer used outputting a cdx line.
static String	CRLF
static String	DATE_FIELD_KEY Key for the Archive File Creation Date field.
static String	DEFAULT_DIGEST_METHOD
static String	DOT_COMPRESSED_FILE_EXTENSION Dot plus compressed file extention.
static String	DUMP
static String	GZIP_DUMP
static String	HEADER
static String	INVALID_SUFFIX Suffix appended to 'broken' files.
static String	LENGTH_FIELD_KEY Key for the Archive File length field.
static String	MIMETYPE_FIELD_KEY Key for the Archive File mimetype field.
static String	NOHEAD
static String	OCCUPIED_SUFFIX Suffix given to files currently in use.
static String	READER_IDENTIFIER_FIELD_KEY
static String	RECORD_IDENTIFIER_FIELD_KEY Key for the Archive File record field.
static char	SINGLE_SPACE
static String	TYPE_FIELD_KEY Key for the Archive File type field.
static String	URL_FIELD_KEY Key for the Archive File URL field.
static String	VERSION_FIELD_KEY Key for the Archive File version field.

Field Detail

OCCUPIED_SUFFIX

static final String OCCUPIED_SUFFIX

Suffix given to files currently in use.

See Also:

Constant Field Values

INVALID_SUFFIX

static final String INVALID_SUFFIX

Suffix appended to 'broken' files.

See Also:

Constant Field Values

DOT_COMPRESSED_FILE_EXTENSION

static final String DOT_COMPRESSED_FILE_EXTENSION

Dot plus compressed file extention.

See Also:

Constant Field Values

VERSION_FIELD_KEY

static final String VERSION_FIELD_KEY

Key for the Archive File version field.

See Also:

Constant Field Values

LENGTH_FIELD_KEY

static final String LENGTH_FIELD_KEY

Key for the Archive File length field.

See Also:

Constant Field Values

TYPE_FIELD_KEY

static final String TYPE_FIELD_KEY

Key for the Archive File type field.

See Also:

Constant Field Values

URL_FIELD_KEY

static final String URL_FIELD_KEY

Key for the Archive File URL field.

See Also:

Constant Field Values

DATE_FIELD_KEY

static final String DATE_FIELD_KEY

Key for the Archive File Creation Date field.

See Also:

Constant Field Values

MIMETYPE_FIELD_KEY

static final String MIMETYPE_FIELD_KEY

Key for the Archive File mimetype field.

See Also:

Constant Field Values

RECORD_IDENTIFIER_FIELD_KEY

static final String RECORD_IDENTIFIER_FIELD_KEY

Key for the Archive File record field.

See Also:

Constant Field Values

ABSOLUTE_OFFSET_KEY

static final String ABSOLUTE_OFFSET_KEY

Key for the Archive Record absolute offset into Archive file.

See Also:

Constant Field Values

READER_IDENTIFIER_FIELD_KEY

static final String READER_IDENTIFIER_FIELD_KEY

See Also:

Constant Field Values

CDX_LINE_BUFFER_SIZE

static final int CDX_LINE_BUFFER_SIZE

Size used to preallocate stringbuffer used outputting a cdx line. The numbers below are guesses at sizes of each of the cdx fields. The ones in the below are spaces. Here is the legend used outputting the cdx line: CDX b e a m s c V n g. Consult cdx documentation on meaning of each of these fields.

See Also:

Constant Field Values

DEFAULT_DIGEST_METHOD

static final String DEFAULT_DIGEST_METHOD

See Also:

Constant Field Values

SINGLE_SPACE

static final char SINGLE_SPACE

See Also:

Constant Field Values

CRLF

static final String CRLF

See Also:

Constant Field Values

CDX

static final String CDX

See Also:

Constant Field Values

DUMP

static final String DUMP

See Also:

Constant Field Values

GZIP_DUMP

static final String GZIP_DUMP

See Also:

Constant Field Values

HEADER

static final String HEADER

See Also:

Constant Field Values

NOHEAD

static final String NOHEAD

See Also:

Constant Field Values

CDX_FILE

static final String CDX_FILE

See Also:

Constant Field Values