Package com.adobe.epubcheck.opf

Class OPFHandler30

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

com.adobe.epubcheck.opf.OPFHandler30

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.EntityResolver2, org.xml.sax.ext.LexicalHandler

public class OPFHandler30
extends OPFHandler

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Deque<ResourceCollection.Builder>	collectionBuilders
private ResourceCollections	collections
private ResourceCollections.Builder	collectionsBuilder
private static java.util.Set<java.lang.String>	DEFAULT_VOCAB_URIS
private java.util.Map<java.lang.String,Vocab>	itemrefVocabs
private java.util.Map<java.lang.String,Vocab>	itemVocabs
private static java.util.Map<java.lang.String,Vocab>	KNOWN_ITEM_VOCAB_URIS
private static java.util.Map<java.lang.String,Vocab>	KNOWN_ITEMREF_VOCAB_URIS
private static java.util.Map<java.lang.String,Vocab>	KNOWN_LINK_VOCAB_URIS
private static java.util.Map<java.lang.String,Vocab>	KNOWN_LINKREL_VOCAB_URIS
private static java.util.Map<java.lang.String,Vocab>	KNOWN_META_VOCAB_URIS
private static java.util.Map<java.lang.String,Vocab>	KNOWN_VOCAB_URIS
private LinkedResources	linkedResources
private java.util.Deque<LinkedResources.Builder>	linkedResourcesBuilders
private java.util.Map<java.lang.String,Vocab>	linkrelVocabs
private java.util.Map<java.lang.String,Vocab>	linkVocabs
private MetadataSet	metadata
private java.util.Deque<MetadataSet.Builder>	metadataBuilders
private java.util.Map<java.lang.String,Vocab>	metaVocabs
private static java.util.Map<java.lang.String,Vocab>	RESERVED_ITEM_VOCABS
private static java.util.Map<java.lang.String,Vocab>	RESERVED_ITEMREF_VOCABS
private static java.util.Map<java.lang.String,Vocab>	RESERVED_LINK_VOCABS
private static java.util.Map<java.lang.String,Vocab>	RESERVED_LINKREL_VOCABS
private static java.util.Map<java.lang.String,Vocab>	RESERVED_META_VOCABS
private static java.util.Map<java.lang.String,Vocab>	RESERVED_VOCABS
private static com.google.common.base.Splitter	TOKENIZER

Fields inherited from class com.adobe.epubcheck.opf.OPFHandler

itemBuilders, itemBuildersByURL, pageMapId, pageMapReferenceLocation, TEXT, uid

Fields inherited from class com.adobe.epubcheck.xml.handlers.XMLHandler

context, path, report

Constructor Summary

Constructors

Constructor	Description
OPFHandler30(ValidationContext context)

Method Summary

Modifier and Type	Method	Description
private void	checkLanguageTag(java.lang.String language)
void	endElement()
ResourceCollections	getCollections()	Returns the list of collections (as defined in collection elements) declared in the current Package Document.
LinkedResources	getLinkedResources()	Returns the list of linked resources (i.e.
MetadataSet	getMetadata()	Returns the metadata for the Rendition represented by the current Package Document.
private java.util.List<java.lang.String>	processCollectionRole(java.lang.String roleAtt)
private void	processDCElem()
private void	processItemProperties(OPFItem.Builder builder, java.lang.String property, java.lang.String mimeType)
private void	processItemrefProperties(OPFItem.Builder builder, java.lang.String property)
private void	processItemsInIndexCollection(ResourceCollection collection)
private void	processLink()
private java.util.Set<Property>	processLinkProperties(java.lang.String properties)
private java.util.Set<Property>	processLinkRel(java.lang.String rel)
private void	processMeta()
protected void	reportItem(OPFItem item)	Report features or messages for a given item.
protected void	reportMetadata()
void	startElement()

Methods inherited from class com.adobe.epubcheck.opf.OPFHandler

characters, checkUniqueIdentExists, getIdentId, getItemById, getItemByURL, getItems, getOpf12PackageFile, getOpf20PackageFile, getPath, getReference, getReferenceCount, getSpineItems, getUid

Methods inherited from class com.adobe.epubcheck.xml.handlers.XMLHandler

currentElement, endElement, registerReference, registerReference, setDocumentLocator, startElement

Methods inherited from class com.adobe.epubcheck.xml.handlers.BaseURLHandler

baseURL, checkURL

Methods inherited from class com.adobe.epubcheck.xml.handlers.LocationHandler

location, location

Methods inherited from class org.xml.sax.ext.DefaultHandler2

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

Methods inherited from class org.xml.sax.helpers.DefaultHandler

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

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_VOCABS

private static final java.util.Map<java.lang.String,Vocab> RESERVED_VOCABS

RESERVED_META_VOCABS

private static final java.util.Map<java.lang.String,Vocab> RESERVED_META_VOCABS

RESERVED_ITEM_VOCABS

private static final java.util.Map<java.lang.String,Vocab> RESERVED_ITEM_VOCABS

RESERVED_ITEMREF_VOCABS

private static final java.util.Map<java.lang.String,Vocab> RESERVED_ITEMREF_VOCABS

RESERVED_LINKREL_VOCABS

private static final java.util.Map<java.lang.String,Vocab> RESERVED_LINKREL_VOCABS

RESERVED_LINK_VOCABS

private static final java.util.Map<java.lang.String,Vocab> RESERVED_LINK_VOCABS

KNOWN_VOCAB_URIS

private static final java.util.Map<java.lang.String,Vocab> KNOWN_VOCAB_URIS

KNOWN_META_VOCAB_URIS

private static final java.util.Map<java.lang.String,Vocab> KNOWN_META_VOCAB_URIS

KNOWN_ITEM_VOCAB_URIS

private static final java.util.Map<java.lang.String,Vocab> KNOWN_ITEM_VOCAB_URIS

KNOWN_ITEMREF_VOCAB_URIS

private static final java.util.Map<java.lang.String,Vocab> KNOWN_ITEMREF_VOCAB_URIS

KNOWN_LINK_VOCAB_URIS

private static final java.util.Map<java.lang.String,Vocab> KNOWN_LINK_VOCAB_URIS

KNOWN_LINKREL_VOCAB_URIS

private static final java.util.Map<java.lang.String,Vocab> KNOWN_LINKREL_VOCAB_URIS

DEFAULT_VOCAB_URIS

private static final java.util.Set<java.lang.String> DEFAULT_VOCAB_URIS

TOKENIZER

private static final com.google.common.base.Splitter TOKENIZER

itemrefVocabs

private java.util.Map<java.lang.String,Vocab> itemrefVocabs

itemVocabs

private java.util.Map<java.lang.String,Vocab> itemVocabs

metaVocabs

private java.util.Map<java.lang.String,Vocab> metaVocabs

linkVocabs

private java.util.Map<java.lang.String,Vocab> linkVocabs

linkrelVocabs

private java.util.Map<java.lang.String,Vocab> linkrelVocabs

metadataBuilders

private final java.util.Deque<MetadataSet.Builder> metadataBuilders

metadata

private MetadataSet metadata

linkedResourcesBuilders

private final java.util.Deque<LinkedResources.Builder> linkedResourcesBuilders

linkedResources

private LinkedResources linkedResources

collectionBuilders

private final java.util.Deque<ResourceCollection.Builder> collectionBuilders

collectionsBuilder

private final ResourceCollections.Builder collectionsBuilder

collections

private ResourceCollections collections

Constructor Detail

OPFHandler30

OPFHandler30(ValidationContext context)

Method Detail

startElement

public void startElement()

Overrides:

startElement in class OPFHandler

endElement

public void endElement()

Overrides:

endElement in class OPFHandler

getMetadata

public MetadataSet getMetadata()

Returns the metadata for the Rendition represented by the current Package Document. Must be called after the parsing.

Returns:

the metadata for the Rendition represented by the current Package Document

getLinkedResources

public LinkedResources getLinkedResources()

Returns the list of linked resources (i.e. resources referenced from link elements) declared in the current Package Document at the package level (i.e. in the package metadata element). Must be called after the parsing.

Returns:

the linked resources for the Rendition represented by the current Package Document

getCollections

public ResourceCollections getCollections()

Returns the list of collections (as defined in collection elements) declared in the current Package Document. Must be called after the parsing.

Returns:

the linked resources for the Rendition represented by the current Package Document

processCollectionRole

private java.util.List<java.lang.String> processCollectionRole(java.lang.String roleAtt)

processLink

private void processLink()

processItemrefProperties

private void processItemrefProperties(OPFItem.Builder builder,
                                      java.lang.String property)

processItemProperties

private void processItemProperties(OPFItem.Builder builder,
                                   java.lang.String property,
                                   java.lang.String mimeType)

processLinkProperties

private java.util.Set<Property> processLinkProperties(java.lang.String properties)

processLinkRel

private java.util.Set<Property> processLinkRel(java.lang.String rel)

processMeta

private void processMeta()

processDCElem

private void processDCElem()

processItemsInIndexCollection

private void processItemsInIndexCollection(ResourceCollection collection)

checkLanguageTag

private void checkLanguageTag(java.lang.String language)

reportMetadata

protected void reportMetadata()

reportItem

protected void reportItem(OPFItem item)

Description copied from class: OPFHandler

Report features or messages for a given item.

Overrides:

reportItem in class OPFHandler

Parameters:

item - the item to report.