net.ontopia.topicmaps.impl.utils

Interface IndexManagerIF

All Known Implementing Classes:

AbstractIndexManager, IndexManager, IndexManager

Deprecated.

Use the TopicMapIF.getIndex(String) method instead.

public interface IndexManagerIF

DEPRECATED: Interface implemented by objects that manage one or more indexes on a topic map.

Indexes are referred to by name, where the name is the full class name of the interface of the index that is wanted, e.g. "net.ontopia.topicmaps.core.index.ClassInstanceIndexIF". This is what is meant by an "index name" below. There is only one index with each given name.

Method Summary

Modifier and Type	Method and Description
Collection<IndexIF>	getActiveIndexes() Deprecated. DEPRECATED: Returns all the active indexes.
IndexIF	getIndex(String name) Deprecated. DEPRECATED: Gets an index by name.
Collection<String>	getSupportedIndexes() Deprecated. DEPRECATED: Returns the names of the indexes that this index manager supports.
TopicMapTransactionIF	getTransaction() Deprecated. DEPRECATED: Gets the topic map store to which this index manager belongs.
boolean	isActive(String name) Deprecated. DEPRECATED: Returns true if the index is active.

Method Detail

getTransaction

TopicMapTransactionIF getTransaction()

Deprecated.

DEPRECATED: Gets the topic map store to which this index manager belongs.

Returns:

The topic map store; an object implementing TopicMapStoreIF.

getIndex

IndexIF getIndex(String name)

Deprecated.

DEPRECATED: Gets an index by name. An index is usually named by the IndexIF subinterface that it implements.

If no such index is currently active it is created and populated automatically when this method is called. In the case when the index implementation is not dynamic it may take a while for the index to populate itself, depending on the size of the topic map.

Parameters:

name - A string; the index name, usually the IndexIF subinterface that it implements.

Throws:

OntopiaUnsupportedException - Thrown if the index is either unknown or not supported by the index manager.

getSupportedIndexes

Collection<String> getSupportedIndexes()

Deprecated.

DEPRECATED: Returns the names of the indexes that this index manager supports.

Returns:

A collection of strings which are index names.

isActive

boolean isActive(String name)

Deprecated.

DEPRECATED: Returns true if the index is active. An active index is an index that has been loaded and populated. Note that the index need not be up to date.

Parameters:

name - A string which is an index name.

Returns:

Boolean: true if the given index is populated, otherwise false.

getActiveIndexes

Collection<IndexIF> getActiveIndexes()

Deprecated.

DEPRECATED: Returns all the active indexes. An active index is an index that has been loaded and populated.

Returns:

A collection of IndexIF objects.