org.ithaka.portico.jhove.module

Class EpubModule

java.lang.Object

edu.harvard.hul.ois.jhove.ModuleBase

org.ithaka.portico.jhove.module.EpubModule

All Implemented Interfaces:

Module

public class EpubModule
extends ModuleBase

Module for validation and metadata extraction on EPUB files. Validation is performed by EPUBCheck https://github.com/w3c/epubcheck/ This module uses the metadata produced by EPUBCheck to produce a JHOVE report.

Author:

Karen Hanson

Field Summary

Fields

Modifier and Type	Field and Description
protected Property	_metadata
protected List<Property>	_propList
static String[]	NOTWELLFORMED_ERRCODES

Fields inherited from class edu.harvard.hul.ois.jhove.ModuleBase

_app, _bigEndian, _checksumFinished, _ckSummer, _countStream, _coverage, _crc32, _cstream, _date, _defaultParams, _dstream, _features, _format, _init, _isRandomAccess, _je, _logger, _md5, _mimeType, _name, _nByte, _note, _param, _release, _repInfoNote, _rights, _sha1, _sha256, _signature, _specification, _validityNote, _vendor, _verbosity, _wellFormedNote

Fields inherited from interface edu.harvard.hul.ois.jhove.Module

MAXIMUM_VERBOSITY, MINIMUM_VERBOSITY

Constructor Summary

Constructors

Constructor and Description
EpubModule() Instantiate a EpubModule object using default properties
EpubModule(String name, String release, int[] date, String[] format, String coverage, String[] mimetype, String wellformedNote, String validityNote, String repinfoNote, String note, String rights, boolean isRandomAccess, Agent moduleAgent) Instantiate a EpubModule object using constructor arguments

Method Summary

Modifier and Type	Method and Description
void	checkSignatures(File file, InputStream stream, RepInfo info)
protected void	initializeInstance(Agent moduleAgent) Initialize core properties - module Agent, format specification Document, and format Signature
protected void	initParse()
int	parse(InputStream stream, RepInfo info, int parseIndex) Parse the content of a purported EPUB file and store the results in RepInfo.
void	parse(RandomAccessFile file, RepInfo info)
protected void	setupDataStream(InputStream stream, RepInfo info)
static String	toUtf8(String inputString) Make sure the string contains valid UTF-8 characters

Methods inherited from class edu.harvard.hul.ois.jhove.ModuleBase

addIntegerProperty, addIntegerProperty, applyDefaultParams, calcRAChecksum, checkSignatures, checksumIfRafNotCopied, getApp, getBase, getBufferedDataStream, getCoverage, getCRC32, getDate, getDefaultParams, getFeatures, getFormat, getMimeType, getName, getNByte, getNote, getRelease, getRepInfoNote, getRights, getSignature, getSpecification, getValidityNote, getVendor, getWellFormedNote, hasFeature, init, initFeatures, initInfo, isBigEndian, isParamInDefaults, isRandomAccess, param, readByteBuf, readDouble, readDouble, readDouble, readFloat, readFloat, readSignedByte, readSignedByte, readSignedByte, readSignedInt, readSignedInt, readSignedInt, readSignedLong, readSignedRational, readSignedRational, readSignedShort, readSignedShort, readSignedShort, readUnsignedByte, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedInt, readUnsignedRational, readUnsignedRational, readUnsignedRational, readUnsignedShort, readUnsignedShort, readUnsignedShort, resetParams, setApp, setBase, setChecksums, setCRC32, setDefaultParams, setMD5, setNByte, setSHA1, setSHA256, setValidityNote, setVerbosity, show, skipBytes, skipBytes, skipDstreamToEnd, vectorToPropArray

Methods inherited from class java.lang.Object

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

Field Detail

NOTWELLFORMED_ERRCODES

public static final String[] NOTWELLFORMED_ERRCODES

_propList

protected List<Property> _propList

_metadata

protected Property _metadata

Constructor Detail

EpubModule

public EpubModule()

Instantiate a EpubModule object using default properties

EpubModule

public EpubModule(String name,
                  String release,
                  int[] date,
                  String[] format,
                  String coverage,
                  String[] mimetype,
                  String wellformedNote,
                  String validityNote,
                  String repinfoNote,
                  String note,
                  String rights,
                  boolean isRandomAccess,
                  Agent moduleAgent)

Instantiate a EpubModule object using constructor arguments

Parameters:

name -

release -

date -

format -

coverage -

mimetype -

wellformedNote -

validityNote -

repinfoNote -

note -

rights -

isRandomAccess -

moduleAgent -

Method Detail

initializeInstance

protected void initializeInstance(Agent moduleAgent)

Initialize core properties - module Agent, format specification Document, and format Signature

Parameters:

agentName -

agentType -

agentAddress -

agentTelephone -

agentEmail -

setupDataStream

protected void setupDataStream(InputStream stream,
                               RepInfo info)

Overrides:

setupDataStream in class ModuleBase

checkSignatures

public void checkSignatures(File file,
                            InputStream stream,
                            RepInfo info)
                     throws IOException

Specified by:

checkSignatures in interface Module

Overrides:

checkSignatures in class ModuleBase

Throws:

IOException

parse

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

Parse the content of a purported EPUB file and store the results in RepInfo.

Specified by:

parse in interface Module

Overrides:

parse in class ModuleBase

Parameters:

stream - An InputStream, positioned at its beginning, which is generated from the object to be parsed. If multiple calls to parse are made on the basis of a nonzero value being returned, a new InputStream must be provided each time.

info - A fresh (on the first call) RepInfo object which will be modified to reflect the results of the parsing If multiple calls to parse are made on the basis of a nonzero value being returned, the same RepInfo object should be passed with each call.

parseIndex - Must be 0 in first call to parse. If parse returns a nonzero value, it must be called again with parseIndex equal to that return value.

Returns:

Throws:

IOException

parse

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

Specified by:

parse in interface Module

Overrides:

parse in class ModuleBase

Throws:

IOException

toUtf8

public static String toUtf8(String inputString)

Make sure the string contains valid UTF-8 characters

Parameters:

inputString -

Returns:

escaped String

initParse

protected void initParse()

Overrides:

initParse in class ModuleBase