|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Installer
An interface that allows us to download from a specific source of Bible data. It is important that implementor of this interface define equals() and hashCode() properly.
To start with I only envisage that we use Sword sourced Bible data however the rest of the system is designed to be able to use data from e-Sword, OLB, etc.
The GNU Lesser General Public License for details.
Method Summary | |
---|---|
void |
close()
remove the cached book list to clear memory |
void |
downloadSearchIndex(Book book,
URI tempDest)
Download a search index for the given Book. |
Book |
getBook(String book)
Get a Book matching the name from the local cache. |
List<Book> |
getBooks()
Get a list of BookMetaData objects that represent downloadable books. |
String |
getInstallerDefinition()
Accessor for the URI |
int |
getSize(Book book)
Return true if the book is not installed or there is a newer version to install. |
String |
getType()
Get the type of the Installer. |
void |
install(Book book)
Download and install a book locally. |
boolean |
isNewer(Book book)
Return true if the book is not installed or there is a newer version to install. |
void |
reloadBookList()
Re-fetch a list of names from the remote source. |
URI |
toRemoteURI(Book book)
|
Methods inherited from interface org.crosswire.jsword.book.BookList |
---|
addBooksListener, getBooks, removeBooksListener |
Method Detail |
---|
String getType()
String getInstallerDefinition()
URI toRemoteURI(Book book)
book
- The book meta-data to get a URI from.
List<Book> getBooks()
getBooks
in interface BookList
reloadBookList()
Book getBook(String book)
book
- the book name
int getSize(Book book)
book
- The book meta-data to check on.
boolean isNewer(Book book)
book
- The book meta-data to check on.
void reloadBookList() throws InstallException
InstallException
void install(Book book) throws InstallException
book
- The book to install
InstallException
void downloadSearchIndex(Book book, URI tempDest) throws InstallException
book
- The book to download a search index for.tempDest
- A temporary URI for downloading to. Passed to the BookIndexer
for installation.
InstallException
void close()
|
Copyright ยจ 2003-2015 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |