Class OPFHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.xml.sax.ext.DefaultHandler2

com.adobe.epubcheck.xml.handlers.LocationHandler

com.adobe.epubcheck.xml.handlers.BaseURLHandler

com.adobe.epubcheck.xml.handlers.XMLHandler

com.adobe.epubcheck.opf.OPFHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

Direct Known Subclasses:

OPFHandler30

public class OPFHandler
extends XMLHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String, OPFItem.Builder>	itemBuilders
protected final Map<io.mola.galimatias.URL, OPFItem.Builder>	itemBuildersByURL
private OPFItems	items
private boolean	opf12PackageFile
protected String	pageMapId
protected EPUBLocation	pageMapReferenceLocation
private final Vector<OPFReference>	refs
private final List<String>	spineIDs
private int	spineItemCounter
protected static final String	TEXT
(package private) String	uid
private String	uniqueIdent
private boolean	uniqueIdentExists
private static final HashSet<String>	validRoles

Fields inherited from class XMLHandler

context, path, report

Constructor Summary

Constructors

Constructor	Description
OPFHandler(ValidationContext context)

Method Summary

Modifier and Type	Method	Description
private void	buildItems()
void	characters(char[] chars, int start, int len)
boolean	checkUniqueIdentExists()	Checks to see if the unique-identifier attribute of the package element references an existing DC metadata identifier element's id attribute
void	endElement()
String	getIdentId()
com.google.common.base.Optional<OPFItem>	getItemById(String id)	Search the list of item by ID.
com.google.common.base.Optional<OPFItem>	getItemByURL(io.mola.galimatias.URL url)	Search the list of item by URL.
List<OPFItem>	getItems()	Returns an immutable list of all the items in the OPF, in document order, including those represented by link elements pointing to local resources.
boolean	getOpf12PackageFile()
boolean	getOpf20PackageFile()
String	getPath()
OPFReference	getReference(int index)
int	getReferenceCount()
List<OPFItem>	getSpineItems()	Returns an immutable list of the items in the spine.
String	getUid()
private static boolean	isValidRole(String role)
protected void	reportItem(OPFItem item)	Report features or messages for a given item.
void	startElement()

Methods inherited from class XMLHandler

currentElement, endElement, registerReference, registerReference, setDocumentLocator, startElement

Methods inherited from class BaseURLHandler

baseURL, checkURL

Methods inherited from class LocationHandler

location, location

Methods inherited from class DefaultHandler2

attributeDecl, comment, elementDecl, endCDATA, endDTD, endEntity, externalEntityDecl, getExternalSubset, internalEntityDecl, resolveEntity, resolveEntity, startCDATA, startDTD, startEntity

Methods inherited from class DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

TEXT

protected static final String TEXT

See Also:

• Constant Field Values

pageMapId

protected String pageMapId

pageMapReferenceLocation

protected EPUBLocation pageMapReferenceLocation

itemBuilders

protected final Map<String, OPFItem.Builder> itemBuilders

itemBuildersByURL

protected final Map<io.mola.galimatias.URL, OPFItem.Builder> itemBuildersByURL

spineIDs

private final List<String> spineIDs

items

private OPFItems items

refs

private final Vector<OPFReference> refs

validRoles

private static final HashSet<String> validRoles

uniqueIdent

private String uniqueIdent

uniqueIdentExists

private boolean uniqueIdentExists

uid

String uid

opf12PackageFile

private boolean opf12PackageFile

spineItemCounter

private int spineItemCounter

Constructor Details

OPFHandler

public OPFHandler(ValidationContext context)

Method Details

getPath

public String getPath()

getOpf12PackageFile

public boolean getOpf12PackageFile()

getOpf20PackageFile

public boolean getOpf20PackageFile()

getItemById

public com.google.common.base.Optional<OPFItem> getItemById(String id)

Search the list of item by ID.

Parameters:

id - the ID of the item to search

Returns:

an Optional containing the item of the given ID if found, or Optional.absent()

getItemByURL

public com.google.common.base.Optional<OPFItem> getItemByURL(io.mola.galimatias.URL url)

Search the list of item by URL.

Parameters:

id - the URL of the item to search

Returns:

an Optional containing the item of the given URL if found, or Optional.absent()

getSpineItems

public List<OPFItem> getSpineItems()

Returns an immutable list of the items in the spine. May contain duplicates if several itemref elements point to the same item.

Returns the empty list if the items have not been parsed yet.

Returns:

the list of items in the spine, guaranteed non-null.

getItems

public List<OPFItem> getItems()

Returns an immutable list of all the items in the OPF, in document order, including those represented by link elements pointing to local resources.

Returns the empty list if the items have not been parsed yet.

Returns:

the list of all items, guaranteed non-null.

getReferenceCount

public int getReferenceCount()

getReference

public OPFReference getReference(int index)

checkUniqueIdentExists

public boolean checkUniqueIdentExists()

Checks to see if the unique-identifier attribute of the package element references an existing DC metadata identifier element's id attribute

Returns:

true if there is an identifier with an id attribute that matches the value of the unique-identifier attribute of the package element. False otherwise.

getUid

public String getUid()

isValidRole

private static boolean isValidRole(String role)

startElement

public void startElement()

Overrides:

startElement in class XMLHandler

getIdentId

public String getIdentId()

endElement

public void endElement()

Overrides:

endElement in class XMLHandler

characters

public void characters(char[] chars,
 int start,
 int len)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

buildItems

private void buildItems()

reportItem

protected void reportItem(OPFItem item)

Report features or messages for a given item.

Parameters:

item - the item to report.