eTextReader.AnnotationListing
Class AllPagesProvider

java.lang.Object
  eTextReader.AnnotationListing.AllPagesProvider

All Implemented Interfaces:

NotationProvider

public class AllPagesProvider
extends java.lang.Object
implements NotationProvider

Provides an implementation of the NotationProvider interface that includes all pages containing annotations

Author:

mcfall

Constructor Summary

AllPagesProvider()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllPagesProvider

public AllPagesProvider()

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

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