nl.siegmann.epublib.epub

Class NavDocument

java.lang.Object

nl.siegmann.epublib.epub.NavDocument

public class NavDocument
extends Object

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

Author:

paul

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAV_HREF
static String	NAMESPACE_EPUB
static String	NAMESPACE_NCX
static String	NCX_ITEM_ID
static String	PREFIX_DTB
static String	PREFIX_NCX

Constructor Summary

Constructors

Constructor and Description
NavDocument()

Method Summary

Modifier and Type	Method and Description
static Resource	createNavResource(Book book)
static Resource	createNavResource(List<Identifier> identifiers, String title, List<CreatorContributor> authors, TableOfContents tableOfContents)
static Resource	read(Book book, EpubReader epubReader)
static void	write(Epub2Writer epubWriter, Book book, ZipOutputStream resultStream)
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.
static void	write(org.xmlpull.v1.XmlSerializer serializer, List<Identifier> identifiers, String title, List<CreatorContributor> authors, TableOfContents tableOfContents)

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 String NAMESPACE_NCX

See Also:

Constant Field Values

NAMESPACE_EPUB

public static final String NAMESPACE_EPUB

See Also:

Constant Field Values

PREFIX_NCX

public static final String PREFIX_NCX

See Also:

Constant Field Values

NCX_ITEM_ID

public static final String NCX_ITEM_ID

See Also:

Constant Field Values

DEFAULT_NAV_HREF

public static final String DEFAULT_NAV_HREF

See Also:

Constant Field Values

PREFIX_DTB

public static final String PREFIX_DTB

See Also:

Constant Field Values

Constructor Detail

NavDocument

public NavDocument()

Method Detail

read

public static Resource read(Book book,
                            EpubReader epubReader)

write

public static void write(Epub2Writer epubWriter,
                         Book book,
                         ZipOutputStream resultStream)
                  throws IOException

Throws:

IOException

write

public static void write(org.xmlpull.v1.XmlSerializer xmlSerializer,
                         Book book)
                  throws IllegalArgumentException,
                         IllegalStateException,
                         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:

FactoryConfigurationError

IOException

IllegalStateException

IllegalArgumentException

createNavResource

public static Resource createNavResource(Book book)
                                  throws IllegalArgumentException,
                                         IllegalStateException,
                                         IOException

Throws:

IllegalArgumentException

IllegalStateException

IOException

createNavResource

public static Resource createNavResource(List<Identifier> identifiers,
                                         String title,
                                         List<CreatorContributor> authors,
                                         TableOfContents tableOfContents)
                                  throws IllegalArgumentException,
                                         IllegalStateException,
                                         IOException

Throws:

IllegalArgumentException

IllegalStateException

IOException

write

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

Throws:

IllegalArgumentException

IllegalStateException

IOException