Skip navigation links

oracle.help.library
Interface Book

All Known Implementing Classes:

HelpBook, HelpSet

public interface Book

The Book interface defines a set of methods for accessing a set of Help data. Books contain the following elements:

• A title
• A set of View objects (zero or more)
• A set of WindowType objects (zero or more)
• A method of mapping topicIDs to URLs

OHJ currently supports two implementations of the Book interface (HelpBook and HelpSet). Clients could create their own implementation of the Book interface for custom help data formats. The HelpSet implementation, however, should be sufficient for most clients.

See Also:

HelpSet, oracle.help.library.helpbook.HelpBook;

Method Summary

oracle.help.common.View[]	getAllViews() Get all of the View objects defined in this book (views of all types).
oracle.help.common.AssociativeLink[]	getAssociativeLinks() Get the AssociativeLink objects defined in this book.
java.lang.String	getBookTitle() Get the title of the Book
oracle.help.common.View[]	getViewsByType(java.lang.String type) Get the View objects defined in this book of the specified type.
oracle.help.common.WindowType[]	getWindowTypes() Get the WindowType objects defined in this book.
java.net.URL	mapIDToURL(java.lang.String id) Get the URL the Book mapped to the given ID.
java.lang.String	mapURLToWindowTypeName(java.net.URL url) Get the name of the WindowType this Book has mapped to the given URL.

Method Detail

getBookTitle

java.lang.String getBookTitle()

Get the title of the Book

getViewsByType

oracle.help.common.View[] getViewsByType(java.lang.String type)

Get the View objects defined in this book of the specified type.

Parameters:

type - The type identifier of the views to retrieve

getAllViews

oracle.help.common.View[] getAllViews()

Get all of the View objects defined in this book (views of all types).

getWindowTypes

oracle.help.common.WindowType[] getWindowTypes()

Get the WindowType objects defined in this book.

getAssociativeLinks

oracle.help.common.AssociativeLink[] getAssociativeLinks()

Get the AssociativeLink objects defined in this book.

mapIDToURL

java.net.URL mapIDToURL(java.lang.String id)

Get the URL the Book mapped to the given ID. If the Book cannot map the topicID (i.e. the topicID is not in the book's map file) null will be returned.

Parameters:

id - The topicID.

mapURLToWindowTypeName

java.lang.String mapURLToWindowTypeName(java.net.URL url)

Get the name of the WindowType this Book has mapped to the given URL. If the Book cannot map the URL to a WindowType null will be returned.

Parameters:

url - The URL to map.

Skip navigation links