Package com.adobe.epubcheck.reporting

Class CheckingReport

java.lang.Object

com.adobe.epubcheck.api.MasterReport

com.adobe.epubcheck.reporting.CheckingReport

All Implemented Interfaces:

LocalizableReport, Report

public class CheckingReport
extends MasterReport

Field Summary

Fields

Modifier and Type	Field	Description
(package private) CheckerMetadata	checker
(package private) java.util.Map<java.lang.String,ItemMetadata>	itemIndex
(package private) java.util.List<ItemMetadata>	items
(package private) java.util.List<CheckMessage>	messages
(package private) java.io.PrintWriter	out
(package private) PublicationMetadata	publication

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

allReportedMessageIds

Constructor Summary

Constructors

Constructor	Description
CheckingReport(java.io.PrintWriter out, java.lang.String epubName)

Method Summary

Modifier and Type	Method	Description
int	generate()	Called to create a report after the checks have been made
(package private) java.util.Map<java.lang.String,ItemMetadata>	getItemIndex()
(package private) java.util.List<ItemMetadata>	getItems()
(package private) void	getJsonReport()
(package private) long	getProcessDuration()
void	info(java.lang.String resource, FeatureEnum feature, java.lang.String value)	Called when when a feature is found in epub.
void	initialize()	Called when a report if first created
void	message(Message message, EPUBLocation location, java.lang.Object... args)	Called when a violation of the standard is found in epub.
(package private) void	setParameters()
(package private) void	setStartDate()
(package private) void	setStopDate()
(package private) void	sortCollections()

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

close, getCustomMessageFile, getDictionary, getEpubFileName, getErrorCount, getFatalErrorCount, getInfoCount, getLocale, getMessages, getReportingLevel, getUsageCount, getWarningCount, 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

checker

final CheckerMetadata checker

publication

final PublicationMetadata publication

itemIndex

java.util.Map<java.lang.String,ItemMetadata> itemIndex

items

java.util.List<ItemMetadata> items

messages

final java.util.List<CheckMessage> messages

out

final java.io.PrintWriter out

Constructor Detail

CheckingReport

public CheckingReport(java.io.PrintWriter out,
                      java.lang.String epubName)

Method Detail

setParameters

void setParameters()

generate

public int generate()

Description copied from interface: Report

Called to create a report after the checks have been made

initialize

public void initialize()

Description copied from interface: Report

Called when a report if first created

getJsonReport

void getJsonReport()
            throws java.io.IOException

Throws:

java.io.IOException

sortCollections

void sortCollections()

getProcessDuration

long getProcessDuration()

setStartDate

void setStartDate()

setStopDate

void setStopDate()

message

public void message(Message message,
                    EPUBLocation location,
                    java.lang.Object... args)

Description copied from interface: Report

Called when a violation of the standard is found in epub.

Parameters:

message - The message being reported

location - location information for the message

args - Arguments referenced by the format string for the message.

info

public void info(java.lang.String resource,
                 FeatureEnum feature,
                 java.lang.String value)

Description copied from interface: Report

Called when when a feature is found in epub.

Parameters:

resource - name of the resource in the epub zip container that has this feature or null if the feature is on the container level.

feature - a keyword to know what kind of feature has been found

value - value found

getItems

java.util.List<ItemMetadata> getItems()

getItemIndex

java.util.Map<java.lang.String,ItemMetadata> getItemIndex()