net.ontopia.topicmaps.impl.basic.index

Class IndexManager

java.lang.Object

net.ontopia.topicmaps.impl.utils.AbstractIndexManager

net.ontopia.topicmaps.impl.basic.index.IndexManager

All Implemented Interfaces:

Serializable, IndexManagerIF

public class IndexManager
extends AbstractIndexManager
implements Serializable

INTERNAL: The basic index manager implementation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,IndexIF>	indexes
protected TopicMapTransactionIF	transaction

Constructor Summary

Constructors

Constructor and Description
IndexManager(TopicMapTransactionIF transaction, CollectionFactoryIF cfactory, EventManagerIF emanager, ObjectTreeManager otree, SubjectIdentityCache sicache)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

transaction

protected TopicMapTransactionIF transaction

indexes

protected Map<String,IndexIF> indexes

Constructor Detail

IndexManager

public IndexManager(TopicMapTransactionIF transaction,
                    CollectionFactoryIF cfactory,
                    EventManagerIF emanager,
                    ObjectTreeManager otree,
                    SubjectIdentityCache sicache)

Method Detail

getTransaction

public TopicMapTransactionIF getTransaction()

Description copied from interface: IndexManagerIF

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

Specified by:

getTransaction in interface IndexManagerIF

Returns:

The topic map store; an object implementing TopicMapStoreIF.

getIndex

public IndexIF getIndex(String name)

Description copied from interface: IndexManagerIF

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.

Specified by:

getIndex in interface IndexManagerIF

Parameters:

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

getSupportedIndexes

public Collection<String> getSupportedIndexes()

Description copied from interface: IndexManagerIF

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

Specified by:

getSupportedIndexes in interface IndexManagerIF

Returns:

A collection of strings which are index names.

getActiveIndexes

public Collection<IndexIF> getActiveIndexes()

Description copied from interface: IndexManagerIF

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

Specified by:

getActiveIndexes in interface IndexManagerIF

Returns:

A collection of IndexIF objects.

isActive

public boolean isActive(String name)

Description copied from interface: IndexManagerIF

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.

Specified by:

isActive in interface IndexManagerIF

Parameters:

name - A string which is an index name.

Returns:

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

registerIndex

public void registerIndex(String name,
                          IndexIF index)

Description copied from class: AbstractIndexManager

INTERNAL: Register the specified index with the index manager.

Specified by:

registerIndex in class AbstractIndexManager

Parameters:

name - The to register the index with name.

index - The index to register.