Package nl.siegmann.epublib.epub

Class NCXDocument

java.lang.Object

nl.siegmann.epublib.epub.NCXDocument

public class NCXDocument
extends java.lang.Object

Writes the ncx document as defined by namespace http://www.daisy.org/z3986/2005/ncx/

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	NCXDocument.NCXAttributes
private static interface	NCXDocument.NCXAttributeValues
private static interface	NCXDocument.NCXTags

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_NCX_HREF
private static org.slf4j.Logger	log
static java.lang.String	NAMESPACE_NCX
static java.lang.String	NCX_ITEM_ID
static java.lang.String	PREFIX_DTB
static java.lang.String	PREFIX_NCX

Constructor Summary

Constructors

Constructor	Description
NCXDocument()

Method Summary

Modifier and Type	Method	Description
static Resource	createNCXResource(java.util.List<Identifier> identifiers, java.lang.String title, java.util.List<Author> authors, TableOfContents tableOfContents)
static Resource	createNCXResource(Book book)
static Resource	read(Book book, EpubReader epubReader)
private static java.lang.String	readNavLabel(org.w3c.dom.Element navpointElement)
private static java.lang.String	readNavReference(org.w3c.dom.Element navpointElement)
(package private) static TOCReference	readTOCReference(org.w3c.dom.Element navpointElement, Book book)
private static java.util.List<TOCReference>	readTOCReferences(org.w3c.dom.NodeList navpoints, Book book)
static void	write(EpubWriter epubWriter, Book book, java.util.zip.ZipOutputStream resultStream)
static void	write(org.xmlpull.v1.XmlSerializer serializer, java.util.List<Identifier> identifiers, java.lang.String title, java.util.List<Author> authors, TableOfContents tableOfContents)
static void	write(org.xmlpull.v1.XmlSerializer xmlSerializer, Book book)	Generates a resource containing an xml document containing the table of contents of the book in ncx format.
private static void	writeMetaElement(java.lang.String dtbName, java.lang.String content, org.xmlpull.v1.XmlSerializer serializer)
private static void	writeNavPointEnd(TOCReference tocReference, org.xmlpull.v1.XmlSerializer serializer)
private static int	writeNavPoints(java.util.List<TOCReference> tocReferences, int playOrder, org.xmlpull.v1.XmlSerializer serializer)
private static void	writeNavPointStart(TOCReference tocReference, int playOrder, org.xmlpull.v1.XmlSerializer serializer)

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_NCX

public static final java.lang.String NAMESPACE_NCX

See Also:

Constant Field Values

PREFIX_NCX

public static final java.lang.String PREFIX_NCX

See Also:

Constant Field Values

NCX_ITEM_ID

public static final java.lang.String NCX_ITEM_ID

See Also:

Constant Field Values

DEFAULT_NCX_HREF

public static final java.lang.String DEFAULT_NCX_HREF

See Also:

Constant Field Values

PREFIX_DTB

public static final java.lang.String PREFIX_DTB

See Also:

Constant Field Values

log

private static final org.slf4j.Logger log

Constructor Detail

NCXDocument

public NCXDocument()

Method Detail

read

public static Resource read(Book book,
                            EpubReader epubReader)

readTOCReferences

private static java.util.List<TOCReference> readTOCReferences(org.w3c.dom.NodeList navpoints,
                                                              Book book)

readTOCReference

static TOCReference readTOCReference(org.w3c.dom.Element navpointElement,
                                     Book book)

readNavReference

private static java.lang.String readNavReference(org.w3c.dom.Element navpointElement)

readNavLabel

private static java.lang.String readNavLabel(org.w3c.dom.Element navpointElement)

write

public static void write(EpubWriter epubWriter,
                         Book book,
                         java.util.zip.ZipOutputStream resultStream)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(org.xmlpull.v1.XmlSerializer xmlSerializer,
                         Book book)
                  throws java.lang.IllegalArgumentException,
                         java.lang.IllegalStateException,
                         java.io.IOException

Generates a resource containing an xml document containing the table of contents of the book in ncx format.

Parameters:

xmlSerializer - the serializer used

book - the book to serialize

Throws:

javax.xml.stream.FactoryConfigurationError

java.io.IOException

java.lang.IllegalStateException

java.lang.IllegalArgumentException

createNCXResource

public static Resource createNCXResource(Book book)
                                  throws java.lang.IllegalArgumentException,
                                         java.lang.IllegalStateException,
                                         java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException

createNCXResource

public static Resource createNCXResource(java.util.List<Identifier> identifiers,
                                         java.lang.String title,
                                         java.util.List<Author> authors,
                                         TableOfContents tableOfContents)
                                  throws java.lang.IllegalArgumentException,
                                         java.lang.IllegalStateException,
                                         java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException

write

public static void write(org.xmlpull.v1.XmlSerializer serializer,
                         java.util.List<Identifier> identifiers,
                         java.lang.String title,
                         java.util.List<Author> authors,
                         TableOfContents tableOfContents)
                  throws java.lang.IllegalArgumentException,
                         java.lang.IllegalStateException,
                         java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException

writeMetaElement

private static void writeMetaElement(java.lang.String dtbName,
                                     java.lang.String content,
                                     org.xmlpull.v1.XmlSerializer serializer)
                              throws java.lang.IllegalArgumentException,
                                     java.lang.IllegalStateException,
                                     java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException

writeNavPoints

private static int writeNavPoints(java.util.List<TOCReference> tocReferences,
                                  int playOrder,
                                  org.xmlpull.v1.XmlSerializer serializer)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IllegalStateException,
                                  java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException

writeNavPointStart

private static void writeNavPointStart(TOCReference tocReference,
                                       int playOrder,
                                       org.xmlpull.v1.XmlSerializer serializer)
                                throws java.lang.IllegalArgumentException,
                                       java.lang.IllegalStateException,
                                       java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException

writeNavPointEnd

private static void writeNavPointEnd(TOCReference tocReference,
                                     org.xmlpull.v1.XmlSerializer serializer)
                              throws java.lang.IllegalArgumentException,
                                     java.lang.IllegalStateException,
                                     java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

java.io.IOException