org.dizitart.no2

Interface NitriteCollection

All Superinterfaces:

ChangeAware, MetadataAware, PersistentCollection<Document>

public interface NitriteCollection
extends PersistentCollection<Document>

Represents a named document collection stored in nitrite database. It persists documents into the database. Each document is associated with an unique NitriteId in a collection.

A nitrite collection supports indexing. Every nitrite collection is also observable.

Create a collection

// create/open a database
Nitrite db = Nitrite.builder()
        .openOrCreate("user", "password");

// create/open a collection named - test
NitriteCollection collection = db.getCollection("test");

// observe any change to the collection
collection.register(new ChangeListener() {

    @Override
    public void onChange(ChangeInfo changeInfo) {
        // your logic based on action
    }
});

Document doc = createDocument("firstName", "John")
     .put("lastName", "Doe")
     .put("birthDay", new Date())
     .put("data", new byte[] {1, 2, 3})
     .put("fruits", new ArrayList<String>() {{ add("apple"); add("orange"); add("banana"); }})
     .put("note", "a quick brown fox jump over the lazy dog");

// insert a document into the collection
collection.insert(doc);

Since:

1.0

See Also:

ChangeAware, Document, NitriteId, ChangeListener, EventBus

Method Summary

Modifier and Type	Method and Description
Cursor	find() Returns a cursor to all documents in the collection.
Cursor	find(Filter filter) Applies a filter on the collection and returns a cursor to the selected documents.
Cursor	find(Filter filter, FindOptions findOptions) Applies a filter on the collection and returns a customized cursor to the selected documents.
Cursor	find(FindOptions findOptions) Returns a customized cursor to all documents in the collection.
WriteResult	insert(Document document, Document... documents) Inserts documents into a collection.
WriteResult	remove(Filter filter) Removes matching elements from the collection.
WriteResult	remove(Filter filter, RemoveOptions removeOptions) Removes document from a collection.
WriteResult	update(Filter filter, Document update) Updates documents in the collection.
WriteResult	update(Filter filter, Document update, UpdateOptions updateOptions) Updates documents in the collection.

Methods inherited from interface org.dizitart.no2.PersistentCollection

close, createIndex, drop, dropAllIndices, dropIndex, getById, getName, hasIndex, insert, isClosed, isDropped, isIndexing, listIndices, rebuildIndex, remove, size, update, update

Methods inherited from interface org.dizitart.no2.event.ChangeAware

deregister, register

Methods inherited from interface org.dizitart.no2.meta.MetadataAware

getAttributes, setAttributes

Method Detail

insert

WriteResult insert(Document document,
                   Document... documents)

Inserts documents into a collection. If the document contains a '_id' value, then the value will be used as an unique key to identify the document in the collection. If the document does not contain any '_id' value, then nitrite will generate a new NitriteId and will add it to the document.

If any of the value is already indexed in the collection, then after insertion the index will also be updated.

This operations will notify all ChangeListener instances registered to this collection with change type ChangeType.INSERT.

Parameters:

document - the document to insert

documents - other documents to insert in a batch.

Returns:

the result of the write operation.

Throws:

ValidationException - if document is null.

InvalidIdException - if the '_id' value contains null value.

InvalidIdException - if the '_id' value contains non comparable type, i.e. type that does not implement Comparable.

InvalidIdException - if the '_id' contains value which is not of the same java type as of other documents' '_id' in the collection.

UniqueConstraintException - if the value of '_id' value clashes with the id of another document in the collection.

UniqueConstraintException - if a value of the document is indexed and it violates the unique constraint in the collection(if any).

See Also:

NitriteId, WriteResult

update

WriteResult update(Filter filter,
                   Document update)

Updates documents in the collection.

If the filter is null, it will update all documents in the collection.

This operations will notify all ChangeListener instances registered to this collection with change type ChangeType.UPDATE.

Parameters:

filter - the filter to apply to select documents from the collection.

update - the modifications to apply.

Returns:

the result of the update operation.

Throws:

ValidationException - if the update document is null.

update

WriteResult update(Filter filter,
                   Document update,
                   UpdateOptions updateOptions)

Updates documents in the collection. Update operation can be customized with the help of updateOptions.

If the filter is null, it will update all documents in the collection unless justOnce is set to true in updateOptions.

This operations will notify all ChangeListener instances registered to this collection with change type ChangeType.UPDATE or ChangeType.INSERT.

Parameters:

filter - the filter to apply to select documents from the collection.

update - the modifications to apply.

updateOptions - the update optionss to customize the operation.

Returns:

the result of the update operation.

Throws:

ValidationException - if the update document is null.

ValidationException - if updateOptions is null.

See Also:

UpdateOptions

remove

WriteResult remove(Filter filter)

Removes matching elements from the collection.

If the filter is null, it will remove all objects from the collection.

This operations will notify all ChangeListener instances registered to this collection with change type ChangeType.REMOVE.

Parameters:

filter - the filter to apply to select elements from collection.

Returns:

the result of the remove operation.

remove

WriteResult remove(Filter filter,
                   RemoveOptions removeOptions)

Removes document from a collection. Remove operation can be customized by removeOptions.

If the filter is null, it will remove all documents in the collection unless justOnce is set to true in removeOptions.

This operations will notify all ChangeListener instances registered to this collection with change type ChangeType.REMOVE.

Parameters:

filter - the filter to apply to select documents from collection.

removeOptions - the remove options to customize the operations.

Returns:

the result of the remove operation.

find

Cursor find()

Returns a cursor to all documents in the collection.

Returns:

a cursor to all documents in the collection.

find

Cursor find(Filter filter)

Applies a filter on the collection and returns a cursor to the selected documents.

See Filters for all available filters.

If there is an index on the value specified in the filter, this operation will take advantage of the index.

Parameters:

filter - the filter to apply to select documents from collection.

Returns:

a cursor to all selected documents.

Throws:

ValidationException - if filter is null.

See Also:

Filters, Cursor.project(Document)

find

Cursor find(FindOptions findOptions)

Returns a customized cursor to all documents in the collection.

Parameters:

findOptions - specifies pagination, sort options for the cursor.

Returns:

a cursor to all selected documents.

Throws:

ValidationException - if findOptions is null.

See Also:

FindOptions.limit(int, int), FindOptions.sort(String, SortOrder), SortOrder, Cursor.project(Document)

find

Cursor find(Filter filter,
            FindOptions findOptions)

Applies a filter on the collection and returns a customized cursor to the selected documents.

See Filters for all available filters.

If there is an index on the value specified in the filter, this operation will take advantage of the index.

Parameters:

filter - the filter to apply to select documents from collection.

findOptions - specifies pagination, sort options for the cursor.

Returns:

a cursor to all selected documents.

Throws:

ValidationException - if filter is null.

ValidationException - if findOptions is null.

See Also:

Filters, FindOptions.limit(int, int), FindOptions.sort(String, SortOrder), SortOrder, Cursor.project(Document)