org.dizitart.no2.store

Interface NitriteStore

All Known Implementing Classes:

NitriteMVStore

public interface NitriteStore

Represents a persistent storage for Nitrite database.

Since:

1.0

See Also:

NitriteMVStore

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file and the store.
void	closeImmediately() Closes the file and the store, without writing anything.
void	commit() Commits the changes.
void	compact() Compacts the store by moving all chunks next to each other.
java.util.Set<java.lang.String>	getMapNames() Gets the set of all map names.
boolean	hasMap(java.lang.String mapName) Checks whether a given map exists in the store.
boolean	hasUnsavedChanges() Checks whether there are any unsaved changes.
boolean	isClosed() Checks whether this store is closed for further modification.
NitriteMap<java.lang.String,Attributes>	metaMap() Gets the metadata of all NitriteMaps.
<Key,Value> NitriteMap<Key,Value>	openMap(java.lang.String mapName) Opens a NitriteMap with the default settings.
<Key,Value> void	removeMap(NitriteMap<Key,Value> nitriteMap) Removes a map from the store.

Method Detail

getMapNames

java.util.Set<java.lang.String> getMapNames()

Gets the set of all map names.

Returns:

the set of names.

hasUnsavedChanges

boolean hasUnsavedChanges()

Checks whether there are any unsaved changes.

Returns:

true if there are any changes; false otherwise.

isClosed

boolean isClosed()

Checks whether this store is closed for further modification.

Returns:

true if closed; false otherwise.

compact

void compact()

Compacts the store by moving all chunks next to each other.

commit

void commit()

Commits the changes. For persistent stores, it also writes changes to disk. It does nothing if there are no unsaved changes.

close

void close()

Closes the file and the store. Unsaved changes are written to disk first.

closeImmediately

void closeImmediately()

Closes the file and the store, without writing anything. This method ignores all errors.

hasMap

boolean hasMap(java.lang.String mapName)

Checks whether a given map exists in the store.

Parameters:

mapName - the map name

Returns:

true if it exists; false otherwise.

openMap

<Key,Value> NitriteMap<Key,Value> openMap(java.lang.String mapName)

Opens a NitriteMap with the default settings. The map is automatically create if it does not yet exist. If a map with this name is already open, this map is returned.

Type Parameters:

Key - the key type

Value - the value type

Parameters:

mapName - the map name

Returns:

the map.

removeMap

<Key,Value> void removeMap(NitriteMap<Key,Value> nitriteMap)

Removes a map from the store.

Type Parameters:

Key - the key type

Value - the value type

Parameters:

nitriteMap - the map to remove.

metaMap

NitriteMap<java.lang.String,Attributes> metaMap()

Gets the metadata of all NitriteMaps.

Returns:

meta data of all maps.