net.obsearch.ambient
Interface Ambient<O extends OB,I extends Index<O>>

All Known Implementing Classes:

AbstractAmbient, AmbientBDBJe, AmbientTC

public interface Ambient<O extends OB,I extends Index<O>>

Field Summary

static String

METADATA_FILENAME The name of the file in which the meta-data is stored.

Method Summary

void	close() Close all the internally used resources.
void	freeze() Freezes the index and stores the metadata of the index (the index itself) in the DB.
OBStoreFactory	getFactory() Returns the factory (if the user wants to create some storages for personal use).
I	getIndex() Returns the index.

Field Detail

METADATA_FILENAME

static final String METADATA_FILENAME

The name of the file in which the meta-data is stored.

See Also:

Constant Field Values

Method Detail

getIndex

I getIndex()

Returns the index.

Returns:

the index.

freeze

void freeze()
            throws IOException,
                   AlreadyFrozenException,
                   IllegalIdException,
                   IllegalAccessException,
                   InstantiationException,
                   OBStorageException,
                   OutOfRangeException,
                   OBException,
                   PivotsUnavailableException

Freezes the index and stores the metadata of the index (the index itself) in the DB.

Throws:

PivotsUnavailableException

IOException

AlreadyFrozenException

IllegalIdException

IllegalAccessException

InstantiationException

OBStorageException

OutOfRangeException

OBException

See Also:

Index.freeze()

close

void close()
           throws OBException

Close all the internally used resources.

Throws:

OBException

getFactory

OBStoreFactory getFactory()

Returns the factory (if the user wants to create some storages for personal use).

Returns:

The factory used to create storage devices.