|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the SPI for new index implementations which must be supported by all implementations of indexes. An IndexProvider provides one or more indexes to the IndexManager and is responsible for managing the internal caches, database connections and so on that are used by the Indexes (although this responsibility may be delegated through to the Index implementations themselves).
Method Summary | |
Index |
getIndex(java.lang.String interfaceName)
Returns the Index implementation which supports the Java interface specified by interfaceName . |
IndexMeta |
getIndexMeta(java.lang.String interfaceName)
Returns an IndexMeta object providing meta data about the index which implements interfaceName |
java.lang.String[] |
getIndexNames()
Returns the names of all of the indexes supported by this IndexProvider. |
void |
initialise(TopicMap tm)
Called by the topic map which contains this IndexManager This method will be invoked before any calls to other methods of this interface are invoked. |
Method Detail |
public void initialise(TopicMap tm) throws IndexProviderException
tm
- The topic map which this IndexManager will be handling indexes for
IndexProviderException
- If an error prevents initialisation.public IndexMeta getIndexMeta(java.lang.String interfaceName) throws UnsupportedIndexException, IndexProviderException
interfaceName
UnsupportedIndexException
- If no index with the
specified name is supported by this provider.
IndexProviderException
- If another error occurred
while retrieving meta data about the index.public Index getIndex(java.lang.String interfaceName) throws UnsupportedIndexException, IndexProviderException
interfaceName
.
interfaceName
- The fully qualified Java class name
of the index interface to be returned.
UnsupportedIndexException
- If no index with the
specified name is supported by this provider.
IndexProviderException
- If the index cannot be
returned for some reason.public java.lang.String[] getIndexNames()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |