Package nl.siegmann.epublib.domain

Class GuideReference

java.lang.Object

nl.siegmann.epublib.domain.ResourceReference

nl.siegmann.epublib.domain.TitledResourceReference

nl.siegmann.epublib.domain.GuideReference

All Implemented Interfaces:

java.io.Serializable

public class GuideReference
extends TitledResourceReference
implements java.io.Serializable

These are references to elements of the book's guide.

See Also:

Guide, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACKNOWLEDGEMENTS
static java.lang.String	BIBLIOGRAPHY
static java.lang.String	COLOPHON
static java.lang.String	COPYRIGHT_PAGE
static java.lang.String	COVER	the book cover(s), jacket information, etc.
static java.lang.String	DEDICATION
static java.lang.String	EPIGRAPH	an epigraph is a phrase, quotation, or poem that is set at the beginning of a document or component.
static java.lang.String	FOREWORD
static java.lang.String	GLOSSARY
static java.lang.String	INDEX	back-of-book style index
static java.lang.String	LOI	list of illustrations
static java.lang.String	LOT	list of tables
static java.lang.String	NOTES
static java.lang.String	PREFACE
private static long	serialVersionUID
static java.lang.String	TEXT	A page of content (e.g.
static java.lang.String	TITLE_PAGE	human-readable page with title, author, publisher, and other metadata
static java.lang.String	TOC	Human-readable table of contents.
private java.lang.String	type

Fields inherited from class nl.siegmann.epublib.domain.ResourceReference

resource

Constructor Summary

Constructors

Constructor	Description
GuideReference(Resource resource)
GuideReference(Resource resource, java.lang.String title)
GuideReference(Resource resource, java.lang.String type, java.lang.String title)
GuideReference(Resource resource, java.lang.String type, java.lang.String title, java.lang.String fragmentId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getType()
void	setType(java.lang.String type)

Methods inherited from class nl.siegmann.epublib.domain.TitledResourceReference

getCompleteHref, getFragmentId, getTitle, setFragmentId, setResource, setResource, setTitle

Methods inherited from class nl.siegmann.epublib.domain.ResourceReference

getResource, getResourceId

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

COVER

public static java.lang.String COVER

the book cover(s), jacket information, etc.

TITLE_PAGE

public static java.lang.String TITLE_PAGE

human-readable page with title, author, publisher, and other metadata

TOC

public static java.lang.String TOC

Human-readable table of contents. Not to be confused the epub file table of contents

INDEX

public static java.lang.String INDEX

back-of-book style index

GLOSSARY

public static java.lang.String GLOSSARY

ACKNOWLEDGEMENTS

public static java.lang.String ACKNOWLEDGEMENTS

BIBLIOGRAPHY

public static java.lang.String BIBLIOGRAPHY

COLOPHON

public static java.lang.String COLOPHON

COPYRIGHT_PAGE

public static java.lang.String COPYRIGHT_PAGE

DEDICATION

public static java.lang.String DEDICATION

EPIGRAPH

public static java.lang.String EPIGRAPH

an epigraph is a phrase, quotation, or poem that is set at the beginning of a document or component. source: http://en.wikipedia.org/wiki/Epigraph_%28literature%29

FOREWORD

public static java.lang.String FOREWORD

LOI

public static java.lang.String LOI

list of illustrations

LOT

public static java.lang.String LOT

list of tables

NOTES

public static java.lang.String NOTES

PREFACE

public static java.lang.String PREFACE

TEXT

public static java.lang.String TEXT

A page of content (e.g. "Chapter 1")

type

private java.lang.String type

Constructor Detail

GuideReference

public GuideReference(Resource resource)

GuideReference

public GuideReference(Resource resource,
                      java.lang.String title)

GuideReference

public GuideReference(Resource resource,
                      java.lang.String type,
                      java.lang.String title)

GuideReference

public GuideReference(Resource resource,
                      java.lang.String type,
                      java.lang.String title,
                      java.lang.String fragmentId)

Method Detail

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)