|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The basic interface which must be supported by all index implementations.
A typical implementation will support this interface plus additional operations
to access the index itself. For example a TopicTypesIndex would implement this
interface plus getTopicByType(Topic t)
or something similar.
This interface simply provides methods to open and close the index and to force it to rebuild itself (unless it is an index which automatically stays in-sync with the topic map data.
Method Summary | |
void |
close()
This method may cause the index to be dropped and any memory used to be freed. |
boolean |
isOpen()
Determines whether or not the index is accessible. |
void |
open()
This method may cause the index to be initialised. |
void |
reindex()
This method may cause the index to be regenerated. |
Method Detail |
public void open() throws IndexException
IndexException
- If some internal error prevents
the index from being opened.public boolean isOpen()
public void reindex() throws IndexException
IndexException
- If some internal error prevents
the index from being regenerated.
java.lang.UnsupportedOperationException
- If the index does
not support reindexing.public void close() throws IndexException
IndexException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |