|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndexManager
Manages the life-cycle of an Index.
The GNU Lesser General Public License for details.
Method Summary | |
---|---|
void |
closeAllIndexes()
Close all indexes associated with this Index Manager |
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. |
IndexPolicy |
getIndexPolicy()
Obtain the current IndexPolicy. |
void |
installDownloadedIndex(Book book,
URI tempDest)
We have downloaded a search index to a zip file. |
boolean |
isIndexed(Book book)
Detects if index data has been stored and is valid for this Bible. |
boolean |
needsReindexing(Book book)
Detect or checking whether this book needs reindexing. |
void |
scheduleIndexCreation(Book book)
Read from the given source version to generate ourselves. |
void |
setIndexPolicy(IndexPolicy policy)
Set the desired IndexPolicy. |
Method Detail |
---|
boolean isIndexed(Book book)
book
- the book
Index getIndex(Book book) throws BookException
book
- the book
BookException
boolean needsReindexing(Book book)
- isIndexed(Book book) - Is index valid, eg index version changed incompatibly (due to internal structure change or search engine update) -
book
- the Book
void scheduleIndexCreation(Book book)
book
- The book that should be indexedvoid installDownloadedIndex(Book book, URI tempDest) throws BookException
book
- The book that we downloaded an index fortempDest
- The URI of a zip file to install
BookException
void deleteIndex(Book book) throws BookException
book
- the book who's index should be deleted.
BookException
void closeAllIndexes()
IndexPolicy getIndexPolicy()
void setIndexPolicy(IndexPolicy policy)
policy
- the IndexPolicy to use when creating indexes.
|
Copyright ยจ 2003-2015 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |