org.tmapi.index
Interface Index

All Known Subinterfaces:

LiteralIndex, ScopedIndex, TypeInstanceIndex

public interface Index

Base interface for all indices.

Version:

$Rev: 62 $ - $Date: 2008-08-08 14:00:50 +0200 (Fr, 08 Aug 2008) $

Author:

The TMAPI Project

Method Summary

void	close() Close the index.
boolean	isAutoUpdated() Indicates whether the index is updated automatically.
boolean	isOpen() Indicates if the index is open.
void	open() Open the index.
void	reindex() Synchronizes the index with data in the topic map.

Method Detail

open

void open()

Open the index. This method must be invoked before using any other method (aside from isOpen()) exported by this interface or derived interfaces.

close

void close()

Close the index.

isOpen

boolean isOpen()

Indicates if the index is open.

Returns:

true if index is already opened, false otherwise.

isAutoUpdated

boolean isAutoUpdated()

Indicates whether the index is updated automatically.

If the value is true, then the index is automatically kept synchronized with the topic map as values are changed. If the value is false, then the reindex() method must be called to resynchronize the index with the topic map after values are changed.

Returns:

true if index is updated automatically, false otherwise.

reindex

void reindex()

Synchronizes the index with data in the topic map.