org.dizitart.no2

Class Nitrite

java.lang.Object

org.dizitart.no2.Nitrite

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Nitrite
extends java.lang.Object
implements java.io.Closeable

Nitrite

An in-memory, single-file based embedded nosql persistent document store. The store can contains multiple named document collections.

It supports following features:

• Embedded key-value/document and object store

• In-memory or single data file

• Very fast and lightweight MongoDB like API

• Indexing

• Full text search capability

• Full Android compatibility

• Observable store

• Both way replication via Nitrite DataGate server

It does not support ACID transactions. Use NitriteBuilder to create a db instance.

Since:

1.0

See Also:

NitriteBuilder

Method Summary

Modifier and Type	Method and Description
static NitriteBuilder	builder() Provides a builder utility to create a Nitrite database instance.
void	close() Closes the database.
void	commit() Commits the changes.
void	compact() Compacts store by moving all chunks next to each other.
NitriteCollection	getCollection(java.lang.String name) Opens a named collection from the store.
NitriteContext	getContext() Provides contextual information for the nitrite database instance.
<T> ObjectRepository<T>	getRepository(java.lang.Class<T> type) Opens a type-safe object repository from the store.
<T> ObjectRepository<T>	getRepository(java.lang.String key, java.lang.Class<T> type) Opens a type-safe object repository with a key identifier from the store.
boolean	hasCollection(java.lang.String name) Checks whether a particular NitriteCollection exists in the store.
<T> boolean	hasRepository(java.lang.Class<T> type) Checks whether a particular ObjectRepository exists in the store.
<T> boolean	hasRepository(java.lang.String key, java.lang.Class<T> type) Checks whether a particular ObjectRepository and key combination exists in the store.
boolean	hasUnsavedChanges() Checks whether the store has any unsaved changes.
boolean	isClosed() Checks whether the store is closed.
java.util.Set<java.lang.String>	listCollectionNames() Gets the set of all NitriteCollections' names saved in the store.
java.util.Set<java.lang.String>	listRepositories() Gets the set of all fully qualified class names corresponding to all ObjectRepositorys in the store.
boolean	validateUser(java.lang.String userId, java.lang.String password) Checks if a specific username and password combination is valid to access the database.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static NitriteBuilder builder()

Provides a builder utility to create a Nitrite database instance.

Returns:

a NitriteBuilder instance.

getCollection

public NitriteCollection getCollection(java.lang.String name)

Opens a named collection from the store. If the collections does not exist it will be created automatically and returned. If a collection is already opened, it is returned as is. Returned collection is thread-safe for concurrent use.

The name can not contain below reserved strings: Constants.INTERNAL_NAME_SEPARATOR Constants.USER_MAP Constants.INDEX_META_PREFIX Constants.INDEX_PREFIX Constants.OBJECT_STORE_NAME_SEPARATOR

Parameters:

name - the name of the collection

Returns:

the collection

See Also:

NitriteCollection

getRepository

public <T> ObjectRepository<T> getRepository(java.lang.Class<T> type)

Opens a type-safe object repository from the store. If the repository does not exist it will be created automatically and returned. If a repository is already opened, it is returned as is.

Returned repository is thread-safe for concurrent use.

Type Parameters:

T - the type parameter

Parameters:

type - the type of the object

Returns:

the repository containing objects of type T.

See Also:

ObjectRepository

getRepository

public <T> ObjectRepository<T> getRepository(java.lang.String key,
                                             java.lang.Class<T> type)

Opens a type-safe object repository with a key identifier from the store. If the repository does not exist it will be created automatically and returned. If a repository is already opened, it is returned as is.

Returned repository is thread-safe for concurrent use.

Type Parameters:

T - the type parameter

Parameters:

key - the key that will be appended to the repositories name

type - the type of the object

Returns:

the repository containing objects of type T.

See Also:

ObjectRepository

listCollectionNames

public java.util.Set<java.lang.String> listCollectionNames()

Gets the set of all NitriteCollections' names saved in the store.

Returns:

the set of all collections' names.

listRepositories

public java.util.Set<java.lang.String> listRepositories()

Gets the set of all fully qualified class names corresponding to all ObjectRepositorys in the store.

Returns:

the set of all registered classes' names.

hasCollection

public boolean hasCollection(java.lang.String name)

Checks whether a particular NitriteCollection exists in the store.

Parameters:

name - the name of the collection.

Returns:

true if the collection exists; otherwise false.

hasRepository

public <T> boolean hasRepository(java.lang.Class<T> type)

Checks whether a particular ObjectRepository exists in the store.

Type Parameters:

T - the type parameter

Parameters:

type - the type of the object

Returns:

true if the repository exists; otherwise false.

hasRepository

public <T> boolean hasRepository(java.lang.String key,
                                 java.lang.Class<T> type)

Checks whether a particular ObjectRepository and key combination exists in the store.

Type Parameters:

T - the type parameter

Parameters:

key - the key that will be appended to the repositories name

type - the type of the object

Returns:

true if the repository exists; otherwise false.

hasUnsavedChanges

public boolean hasUnsavedChanges()

Checks whether the store has any unsaved changes.

Returns:

true if there are unsaved changes; otherwise false.

compact

public void compact()

Compacts store by moving all chunks next to each other.

commit

public void commit()

Commits the changes. For file based store, it saves the changes to disk if there are any unsaved changes.

No need to call it after every change, if auto-commit is not disabled while opening the db. However, it may still be called to flush all changes to disk.

close

public void close()

Closes the database. Unsaved changes are written to disk and compacted first for a file based store.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isClosed

public boolean isClosed()

Checks whether the store is closed.

Returns:

true if closed; otherwise false.

validateUser

public boolean validateUser(java.lang.String userId,
                            java.lang.String password)

Checks if a specific username and password combination is valid to access the database.

Parameters:

userId - the user id

password - the password

Returns:

true if valid; otherwise false.

getContext

@Generated(value="lombok")
public NitriteContext getContext()

Provides contextual information for the nitrite database instance.