org.tmapi.index
Interface Index

All Superinterfaces:
TopicMapSystem.ConfigurableHelperObject
All Known Subinterfaces:
AssociationRolesIndex, AssociationsIndex, OccurrencesIndex, ScopedObjectsIndex, TopicMapObjectsIndex, TopicNamesIndex, TopicsIndex, VariantsIndex

public interface Index
extends TopicMapSystem.ConfigurableHelperObject

Abstract representation of a topic map index. This is the base interface that must be implemented by all indexes.

Since:
1.0

Method Summary
 void close()
          Close the index.
 IndexFlags getFlags()
          Retrieve the IndexFlag instance that represents the static meta data for this Index.
 boolean isOpen()
          Return the state of this Index.
 void open()
          Open the index.
 void reindex()
          Resynchronize this Index with the data in the TopicMap
 
Methods inherited from interface org.tmapi.core.TopicMapSystem.ConfigurableHelperObject
configure
 

Method Detail

open

public void open()
          throws TMAPIIndexException
Open the index. This method must be invoked before using any other method exported by this interface or derived interfaces.

Throws:
TMAPIIndexException

close

public void close()
           throws TMAPIIndexException
Close the index.

Throws:
TMAPIIndexException

isOpen

public boolean isOpen()
               throws TMAPIIndexException
Return the state of this Index.

Returns:
true if the Index is currently open, false otherwise.
Throws:
TMAPIIndexException

reindex

public void reindex()
             throws TMAPIIndexException
Resynchronize this Index with the data in the TopicMap

Throws:
TMAPIIndexException

getFlags

public IndexFlags getFlags()
                    throws TMAPIIndexException
Retrieve the IndexFlag instance that represents the static meta data for this Index.

Returns:
the IndexFlag instance that represents the static meta data for this Index.
Throws:
TMAPIIndexException