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:

Serializable

public class GuideReference
extends TitledResourceReference
implements 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 String	ACKNOWLEDGEMENTS
static String	BIBLIOGRAPHY
static String	COLOPHON
static String	COPYRIGHT_PAGE
static String	COVER	the book cover(s), jacket information, etc.
static String	DEDICATION
static String	EPIGRAPH	an epigraph is a phrase, quotation, or poem that is set at the beginning of a document or component.
static String	FOREWORD
static String	GLOSSARY
static String	INDEX	back-of-book style index
static String	LOI	list of illustrations
static String	LOT	list of tables
static String	NOTES
static String	PREFACE
private static final long	serialVersionUID
static String	TEXT	A page of content (e.g.
static String	TITLE_PAGE	human-readable page with title, author, publisher, and other metadata
static String	TOC	Human-readable table of contents.
private String	type

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

resource

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getType()
void	setType(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 Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

COVER

public static String COVER

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

TITLE_PAGE

public static String TITLE_PAGE

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

TOC

public static String TOC

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

INDEX

public static String INDEX

back-of-book style index

GLOSSARY

public static String GLOSSARY

ACKNOWLEDGEMENTS

public static String ACKNOWLEDGEMENTS

BIBLIOGRAPHY

public static String BIBLIOGRAPHY

COLOPHON

public static String COLOPHON

COPYRIGHT_PAGE

public static String COPYRIGHT_PAGE

DEDICATION

public static String DEDICATION

EPIGRAPH

public static 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 String FOREWORD

LOI

public static String LOI

list of illustrations

LOT

public static String LOT

list of tables

NOTES

public static String NOTES

PREFACE

public static String PREFACE

TEXT

public static String TEXT

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

type

private String type

Constructor Details

GuideReference

public GuideReference(Resource resource)

GuideReference

public GuideReference(Resource resource,
 String title)

GuideReference

public GuideReference(Resource resource,
 String type,
 String title)

GuideReference

public GuideReference(Resource resource,
 String type,
 String title,
 String fragmentId)

Method Details

getType

public String getType()

setType

public void setType(String type)