Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> tm4j >> topicmap >> [ index overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.tm4j.topicmap.index
Interface IndexManager  

---

public interface IndexManager

An IndexManager controls access to all of the indexes for a particular topic map. Depending upon the implementation, this manager may be responsible for initialising indexes when it is created (or initialisation may be deferred until a specific index is requested). As well as managing the Index objects, this class also manages real-time meta data about the indexes - this meta data includes whether or not the index is already initialised, whether or not an explicit runtime initialisation is required and whether or not the index automatically updates itself as the topic map contents change.

---

Method Summary
Index	getIndex(java.lang.Class ixClass)           Returns the index which implements the specified interface.
Index	getIndex(java.lang.String ixInterface)           Returns the index which implements the specified interface
IndexMeta	getIndexMeta(java.lang.Class ixClass)           Returns meta data about the specified index.
IndexMeta	getIndexMeta(java.lang.String ixInterface)           Returns meta data about the specified index.
boolean	isRegistered(java.lang.Class ixClass)           Determines whether or not an Index implementing the specified interface is registered with this IndexManager.
boolean	isRegistered(java.lang.String ixInterface)           Determines whether or not an implementation of the specified Index interface is registered with this IndexManager.
void	registerIndexProvider(IndexProvider index)           Plugin interface for index service providers.

 

Method Detail

registerIndexProvider

public void registerIndexProvider(IndexProvider index)
                           throws DuplicateIndexNameException,
                                  IndexManagerException

Plugin interface for index service providers. This method registers a new index serivce provider with the manager. The index service provider will be retrievable by the name of each interface it supports which is derived from the Index interface.

---

isRegistered

public boolean isRegistered(java.lang.String ixInterface)

Determines whether or not an implementation of the specified Index interface is registered with this IndexManager.

---

isRegistered

public boolean isRegistered(java.lang.Class ixClass)

Determines whether or not an Index implementing the specified interface is registered with this IndexManager.

---

getIndexMeta

public IndexMeta getIndexMeta(java.lang.String ixInterface)
                       throws UnsupportedIndexException

Returns meta data about the specified index.

---

getIndexMeta

public IndexMeta getIndexMeta(java.lang.Class ixClass)
                       throws java.lang.IllegalArgumentException,
                              UnsupportedIndexException

Returns meta data about the specified index.

---

getIndex

public Index getIndex(java.lang.String ixInterface)
               throws IndexManagerException

Returns the index which implements the specified interface

---

getIndex

public Index getIndex(java.lang.Class ixClass)
               throws IndexManagerException,
                      java.lang.IllegalArgumentException

Returns the index which implements the specified interface.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> tm4j >> topicmap >> [ index overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---