IndexProvider

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> tm4j >> topicmap >> [ index overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.tm4j.topicmap.index.IndexProvider

SOURCE |

Download org.tm4j.topicmap.index.IndexProvider

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.tm4j.topicmap.index
Interface IndexProvider

public interface IndexProvider

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(org.tm4j.topicmap.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

initialise

public void initialise(org.tm4j.topicmap.TopicMap tm)
                throws IndexProviderException

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. This method provides a "hook" for the IndexProvider to do any session-scope initialisation.

getIndexMeta

public IndexMeta getIndexMeta(java.lang.String interfaceName)
                       throws UnsupportedIndexException,
                              IndexProviderException

Returns an IndexMeta object providing meta data about the index which implements interfaceName

getIndex

public Index getIndex(java.lang.String interfaceName)
               throws UnsupportedIndexException,
                      IndexProviderException

Returns the Index implementation which supports the Java interface specified by interfaceName.

getIndexNames

public java.lang.String[] getIndexNames()

Returns the names of all of the indexes supported by this IndexProvider.