org.crosswire.jsword.index
Interface IndexManager

All Known Implementing Classes:
LuceneIndexManager

public interface IndexManager

A way of managing a way of creating a search index for a book.

Author:
Joe Walker [joe at eireneh dot com]
See Also:
for license details. The copyright to this program is held by it's authors.

Method Summary
 void deleteIndex(Book book)
          Tidy up after yourself and remove all the files that make up any indexes you created.
 Index getIndex(Book book)
          Create a new Searcher.
 void installDownloadedIndex(Book book, URL tempDest)
          We have downloaded a search index to a zip file.
 boolean isIndexed(Book book)
          Detects if index data has been stored for this Bible already
 void scheduleIndexCreation(Book book)
          Read from the given source version to generate ourselves.
 

Method Detail

isIndexed

boolean isIndexed(Book book)
Detects if index data has been stored for this Bible already


getIndex

Index getIndex(Book book)
               throws BookException
Create a new Searcher.

Throws:
BookException

scheduleIndexCreation

void scheduleIndexCreation(Book book)
Read from the given source version to generate ourselves. On completion of this method the index should be usable.


installDownloadedIndex

void installDownloadedIndex(Book book,
                            URL tempDest)
                            throws BookException
We have downloaded a search index to a zip file. It should be installed from here.

Parameters:
book - The book that we downloaded an index for
tempDest - The URL of a zip file to install
Throws:
BookException

deleteIndex

void deleteIndex(Book book)
                 throws BookException
Tidy up after yourself and remove all the files that make up any indexes you created.

Throws:
BookException

Copyright ยจ 2003-2006