eTextReader.AnnotationListing
Class TextbookProvider

java.lang.Object
  eTextReader.AnnotationListing.TextbookProvider

All Implemented Interfaces:

NotationProvider

public class TextbookProvider
extends java.lang.Object
implements NotationProvider

A NotationProvider implementation that includes all pages contained in a specific book

Author:

mcfall

Field Summary

(package private) OEBPackageFile

book

Constructor Summary

TextbookProvider(OEBPackageFile book)

Method Summary

java.util.Set<java.lang.String>	getCandidateURLs(java.lang.String userName) Determines a list of pages that contain may annotations for the specific user
java.lang.String	getDescription() Returns a description of this provider's scope.
void	setBook(OEBPackageFile currentBook) Sets the current book associated with this textbook provider to currentBook.

Methods inherited from class java.lang.Object

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

Field Detail

book

OEBPackageFile book

Constructor Detail

TextbookProvider

public TextbookProvider(OEBPackageFile book)

Method Detail

getCandidateURLs

public java.util.Set<java.lang.String> getCandidateURLs(java.lang.String userName)

Description copied from interface: NotationProvider

Determines a list of pages that contain may annotations for the specific user

Specified by:

getCandidateURLs in interface NotationProvider

Parameters:

userName - the name of the user to check for annotations

Returns:

a (possibly empty) set containing String versions of URLs representing pages that contain annotations viewable by the specified user

setBook

public void setBook(OEBPackageFile currentBook)

Sets the current book associated with this textbook provider to currentBook.

Parameters:

currentBook - the book to be used by this provider

getDescription

public java.lang.String getDescription()

Description copied from interface: NotationProvider

Returns a description of this provider's scope. Examples include

• all pages
• pages in the current book

Since this will usually be at the end of a phrase, the description should start with a lower case letter

Specified by:

getDescription in interface NotationProvider

Returns:

a string describing the provider's scope