edu.harvard.hul.ois.jhove.module

Class WarcModule

java.lang.Object

ModuleBase

edu.harvard.hul.ois.jhove.module.WarcModule

public class WarcModule
extends ModuleBase

JHOVE module for identifying, validating and characterizing WARC files. Ported from the JHOVE2 WARC module and based on the JWAT-tool, both created by nicl@kb.dk (nclarkekb@git). This is a non-recursive validation. It only validates the WARC file format and WARC headers, not the actual payload of the WARC records.

Author:

jolf@kb.dk

Constructor Summary

Constructors

Constructor and Description
WarcModule() Constructor.

Method Summary

Modifier and Type	Method and Description
int	parse(InputStream stream, RepInfo info, int parseIndex)
void	parse(RandomAccessFile file, RepInfo info)
protected void	parseRecords(WarcReader reader) Parse WARC records.
protected void	processRecord(WarcRecord record) Process a WARC record.
void	resetParams() Reset parameter settings.
protected void	setReaderOptions(WarcReader reader) Set digest options for WARC reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

WarcModule

public WarcModule()

Constructor.

Method Detail

resetParams

public void resetParams()
                 throws Exception

Reset parameter settings. Returns to a default state without any parameters.

Throws:

Exception

parse

public void parse(RandomAccessFile file,
                  RepInfo info)
           throws IOException

Throws:

IOException

parse

public int parse(InputStream stream,
                 RepInfo info,
                 int parseIndex)
          throws IOException

Throws:

IOException

setReaderOptions

protected void setReaderOptions(WarcReader reader)
                         throws JhoveException

Set digest options for WARC reader.

Parameters:

reader - WARC reader instance

Throws:

JhoveException

parseRecords

protected void parseRecords(WarcReader reader)
                     throws IOException,
                            JhoveException

Parse WARC records. Parsing should be straight forward with all records accessible through the same source.

Parameters:

reader - WARC reader used to parse records

Throws:

EOFException - if EOF occurs prematurely

IOException - if an IO error occurs while processing

JhoveException - if a serious problem needs to be reported

processRecord

protected void processRecord(WarcRecord record)
                      throws IOException,
                             JhoveException

Process a WARC record. Does not characterize the record payload.

Parameters:

record - WARC record from WARC reader

Throws:

EOFException - if EOF occurs prematurely

IOException - if an IO error occurs while processing

JhoveException - if a serious problem needs to be reported