Package org.ithaka.portico.jhove.module.epub

Class JhoveRepInfoReport

java.lang.Object

com.adobe.epubcheck.api.MasterReport

org.ithaka.portico.jhove.module.epub.JhoveRepInfoReport

All Implemented Interfaces:

com.adobe.epubcheck.api.LocalizableReport, com.adobe.epubcheck.api.Report

public class JhoveRepInfoReport
extends com.adobe.epubcheck.api.MasterReport

This is a custom report to extend the EPUBCheck MasterReport. Its purpose is to collect the properties needed to producing a JHOVE RepInfo object while the EPUB is being validated.

Author:

Karen Hanson

Field Summary

Fields

Modifier and Type	Field	Description
protected long	charsCount
protected Set<String>	contributors
protected String	creationDate
protected Set<String>	creators
protected String	date
protected Set<String>	embeddedFonts
protected List<com.adobe.epubcheck.reporting.CheckMessage>	errors
protected static String	FALLBACK_FORMAT
protected List<com.adobe.epubcheck.reporting.CheckMessage>	fatalErrors
protected String	formatName
protected String	formatVersion
protected String	generationDate
protected boolean	hasAudio
protected boolean	hasEncryption
protected boolean	hasFixedLayout
protected boolean	hasScripts
protected boolean	hasSignatures
protected boolean	hasVideo
protected String	identifier
protected List<com.adobe.epubcheck.reporting.CheckMessage>	infoMsgs
protected static String	ISO_DATE_PATTERN
protected String	language
protected String	lastModifiedDate
protected Set<String>	mediaTypes
protected long	pagesCount
protected String	publisher
protected Set<String>	references
protected Set<String>	refFonts
protected Set<String>	resources
protected Set<String>	rights
protected Set<String>	subjects
protected Set<String>	titles
protected List<com.adobe.epubcheck.reporting.CheckMessage>	usageMsgs
protected List<com.adobe.epubcheck.reporting.CheckMessage>	warns

Fields inherited from class com.adobe.epubcheck.api.MasterReport

allReportedMessageIds

Constructor Summary

Constructors

Constructor	Description
JhoveRepInfoReport(String ePubName)

Method Summary

Modifier and Type	Method	Description
int	generate()
List<com.adobe.epubcheck.reporting.CheckMessage>	getAllMessages()	Get all messages generated during validation
long	getCharacterCount()	Get EPUB character count.
String[]	getContributors()	Get EPUB contributors as string array.
Date	getCreationDate()	Get EPUB file creation date
String[]	getCreators()	Get EPUB creators as string array
String	getDate()	Get EPUB publication date
Set<String>	getEmbeddedFonts()	Get EPUB embedded fonts
int	getErrorCount()
int	getFatalErrorCount()
Set<String>	getFeatures()	Get set of features identified in the EPUB
String	getFormat()	Get format of file validated (application/octet-stream if not an EPUB)
String	getIdentifier()	Get EPUB identifier.
int	getInfoCount()
String	getLanguage()	Get EPUB language.
Date	getLastModifiedDate()	Get EPUB file last modified date
String[]	getMediaTypes()	Get list of media types present in the EPUB package
long	getPageCount()	Get EPUB page count.
String	getPublisher()	Get EPUB publisher
String[]	getReferences()	Get all EPUB references - this array includes both referenced and embedded material.
Set<String>	getRefFonts()	Get EPUB referenced fonts - these fonts are not embedded
String[]	getResources()	Get a list of all EPUB resources - files that are either stored in the EPUB package or else stored outside of the EPUB but used as a key component e.g.
String[]	getRights()	Get EPUB rights statements as string array
String[]	getSubjects()	Get EPUB subject headings
String[]	getTitles()	Get EPUB titles as string array
int	getUsageCount()
String	getVersion()	Get EPUB version validated against - EPUBcheck will use the most recent minor release version for the EPUB's major version e.g.
int	getWarningCount()
void	info(String resource, com.adobe.epubcheck.util.FeatureEnum feature, String value)
void	initialize()
void	message(com.adobe.epubcheck.messages.Message message, com.adobe.epubcheck.api.EPUBLocation location, Object... args)

Methods inherited from class com.adobe.epubcheck.api.MasterReport

close, getCustomMessageFile, getDictionary, getEpubFileName, getLocale, getMessages, getReportingLevel, message, setCustomMessageFile, setEpubFileName, setLocale, setOverrideFile, setReportingLevel

Methods inherited from class java.lang.Object

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

Field Detail

generationDate

protected String generationDate

creationDate

protected String creationDate

lastModifiedDate

protected String lastModifiedDate

identifier

protected String identifier

titles

protected Set<String> titles

creators

protected Set<String> creators

contributors

protected Set<String> contributors

subjects

protected Set<String> subjects

publisher

protected String publisher

rights

protected Set<String> rights

date

protected String date

mediaTypes

protected Set<String> mediaTypes

formatName

protected String formatName

formatVersion

protected String formatVersion

pagesCount

protected long pagesCount

charsCount

protected long charsCount

language

protected String language

embeddedFonts

protected Set<String> embeddedFonts

refFonts

protected Set<String> refFonts

references

protected Set<String> references

resources

protected Set<String> resources

hasEncryption

protected boolean hasEncryption

hasSignatures

protected boolean hasSignatures

hasAudio

protected boolean hasAudio

hasVideo

protected boolean hasVideo

hasFixedLayout

protected boolean hasFixedLayout

hasScripts

protected boolean hasScripts

warns

protected List<com.adobe.epubcheck.reporting.CheckMessage> warns

errors

protected List<com.adobe.epubcheck.reporting.CheckMessage> errors

fatalErrors

protected List<com.adobe.epubcheck.reporting.CheckMessage> fatalErrors

usageMsgs

protected List<com.adobe.epubcheck.reporting.CheckMessage> usageMsgs

infoMsgs

protected List<com.adobe.epubcheck.reporting.CheckMessage> infoMsgs

ISO_DATE_PATTERN

protected static final String ISO_DATE_PATTERN

See Also:

Constant Field Values

FALLBACK_FORMAT

protected static final String FALLBACK_FORMAT

See Also:

Constant Field Values

Constructor Detail

JhoveRepInfoReport

public JhoveRepInfoReport(String ePubName)

Method Detail

message

public void message(com.adobe.epubcheck.messages.Message message,
                    com.adobe.epubcheck.api.EPUBLocation location,
                    Object... args)

info

public void info(String resource,
                 com.adobe.epubcheck.util.FeatureEnum feature,
                 String value)

getCreationDate

public Date getCreationDate()

Get EPUB file creation date

Returns:

getLastModifiedDate

public Date getLastModifiedDate()

Get EPUB file last modified date

Returns:

getFormat

public String getFormat()

Get format of file validated (application/octet-stream if not an EPUB)

Returns:

getVersion

public String getVersion()

Get EPUB version validated against - EPUBcheck will use the most recent minor release version for the EPUB's major version e.g. for EPUBCheck 4.2.0, all EPUB 2s will be validated against the 2.0.1 spec, all EPUB 3s will be validated against the EPUB 3.2 spec.

Returns:

version validated as

getAllMessages

public List<com.adobe.epubcheck.reporting.CheckMessage> getAllMessages()

Get all messages generated during validation

Returns:

getPageCount

public long getPageCount()

Get EPUB page count.

Returns:

getCharacterCount

public long getCharacterCount()

Get EPUB character count.

Returns:

getLanguage

public String getLanguage()

Get EPUB language.

Returns:

getIdentifier

public String getIdentifier()

Get EPUB identifier.

Returns:

getTitles

public String[] getTitles()

Get EPUB titles as string array

Returns:

getCreators

public String[] getCreators()

Get EPUB creators as string array

Returns:

getContributors

public String[] getContributors()

Get EPUB contributors as string array.

Returns:

getDate

public String getDate()

Get EPUB publication date

Returns:

getPublisher

public String getPublisher()

Get EPUB publisher

Returns:

getSubjects

public String[] getSubjects()

Get EPUB subject headings

Returns:

getRights

public String[] getRights()

Get EPUB rights statements as string array

Returns:

getEmbeddedFonts

public Set<String> getEmbeddedFonts()

Get EPUB embedded fonts

Returns:

getRefFonts

public Set<String> getRefFonts()

Get EPUB referenced fonts - these fonts are not embedded

Returns:

getReferences

public String[] getReferences()

Get all EPUB references - this array includes both referenced and embedded material.

Returns:

getResources

public String[] getResources()

Get a list of all EPUB resources - files that are either stored in the EPUB package or else stored outside of the EPUB but used as a key component e.g. embedded video or audio.

Returns:

getMediaTypes

public String[] getMediaTypes()

Get list of media types present in the EPUB package

Returns:

getFeatures

public Set<String> getFeatures()

Get set of features identified in the EPUB

Returns:

getErrorCount

public int getErrorCount()

Specified by:

getErrorCount in interface com.adobe.epubcheck.api.Report

Overrides:

getErrorCount in class com.adobe.epubcheck.api.MasterReport

getWarningCount

public int getWarningCount()

Specified by:

getWarningCount in interface com.adobe.epubcheck.api.Report

Overrides:

getWarningCount in class com.adobe.epubcheck.api.MasterReport

getFatalErrorCount

public int getFatalErrorCount()

Specified by:

getFatalErrorCount in interface com.adobe.epubcheck.api.Report

Overrides:

getFatalErrorCount in class com.adobe.epubcheck.api.MasterReport

getUsageCount

public int getUsageCount()

Specified by:

getUsageCount in interface com.adobe.epubcheck.api.Report

Overrides:

getUsageCount in class com.adobe.epubcheck.api.MasterReport

getInfoCount

public int getInfoCount()

Specified by:

getInfoCount in interface com.adobe.epubcheck.api.Report

Overrides:

getInfoCount in class com.adobe.epubcheck.api.MasterReport

generate

public int generate()

initialize

public void initialize()