org.dizitart.no2

Interface PersistentCollection<T>

Type Parameters:

T - the type parameter

All Superinterfaces:

java.lang.AutoCloseable, ChangeAware, java.io.Closeable, MetadataAware

All Known Subinterfaces:

NitriteCollection, ObjectRepository<T>

public interface PersistentCollection<T>
extends ChangeAware, MetadataAware, java.io.Closeable

The interface Persistent collection.

Since:

1.0

See Also:

NitriteCollection, ObjectRepository

Method Summary

Modifier and Type	Method and Description
void	close() Closes the collection for further access.
void	createIndex(java.lang.String field, IndexOptions indexOptions) Creates an index on value, if not already exists.
void	drop() Drops the collection and all of its indices.
void	dropAllIndices() Drops all indices from the collection.
void	dropIndex(java.lang.String field) Drops the index on a field.
T	getById(NitriteId nitriteId) Gets a single element from the collection by its id.
java.lang.String	getName() Returns the name of the PersistentCollection.
boolean	hasIndex(java.lang.String field) Checks if a value is already indexed or not.
WriteResult	insert(T[] elements) Inserts elements into this collection.
boolean	isClosed() Returns true if the collection is closed; otherwise, false.
boolean	isDropped() Returns true if the collection is dropped; otherwise, false.
boolean	isIndexing(java.lang.String field) Checks if indexing operation is currently ongoing for a field.
java.util.Collection<Index>	listIndices() Gets a set of all indices in the collection.
void	rebuildIndex(java.lang.String field, boolean async) Rebuilds index on field if it exists.
WriteResult	remove(T element) Deletes the element from the collection.
long	size() Returns the size of the PersistentCollection.
WriteResult	update(T element) Updates element in the collection.
WriteResult	update(T element, boolean upsert) Updates element in the collection.

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

deregister, register

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

getAttributes, setAttributes

Method Detail

createIndex

void createIndex(java.lang.String field,
                 IndexOptions indexOptions)

Creates an index on value, if not already exists. If indexOptions is null, it will use default options. <p> The default indexing option is - <p> - indexOptions.setAsync(false); - indexOptions.setIndexType(IndexType.Unique); <p>

'_id' value of the document is always indexed. But full text indexing is not supported on '_id' value. Compound index is not supported. Indexing on arrays or collection is not supported Indexing on non-comparable value is not supported

Parameters:

field - the value to be indexed.

indexOptions - index options.

Throws:

IndexingException - if an index already exists on value.

See Also:

IndexOptions, IndexType

rebuildIndex

void rebuildIndex(java.lang.String field,
                  boolean async)

Rebuilds index on field if it exists.

Parameters:

field - the value to be indexed.

async - if set to true, the indexing will run in background; otherwise, in foreground.

Throws:

IndexingException - if the field is not indexed.

listIndices

java.util.Collection<Index> listIndices()

Gets a set of all indices in the collection.

Returns:

a set of all indices.

See Also:

Index

hasIndex

boolean hasIndex(java.lang.String field)

Checks if a value is already indexed or not.

Parameters:

field - the value to check.

Returns:

true if the value is indexed; otherwise, false.

isIndexing

boolean isIndexing(java.lang.String field)

Checks if indexing operation is currently ongoing for a field.

Parameters:

field - the value to check.

Returns:

true if indexing is currently running; otherwise, false.

dropIndex

void dropIndex(java.lang.String field)

Drops the index on a field.

Parameters:

field - the index of the field to drop.

Throws:

IndexingException - if indexing is currently running on the field.

IndexingException - if the field is not indexed.

dropAllIndices

void dropAllIndices()

Drops all indices from the collection.

Throws:

IndexingException - if indexing is running on any value.

insert

WriteResult insert(T[] elements)

Inserts elements into this collection. If the element has an '_id' field, then the value will be used as an unique key to identify the element in the collection. If the element does not have any '_id' field, then nitrite will generate a new NitriteId and will add it to the '_id' field. <p> If any of the value is already indexed in the collection, then after insertion the index will also be updated. <p>

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

Parameters:

elements - an array of element for batch insertion.

Returns:

the result of the write operation.

Throws:

ValidationException - if elements is null.

InvalidIdException - if the '_id' field’s value contains null.

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

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

UniqueConstraintException - if the value of '_id' field clashes with the '_id' field of another element in the repository.

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

See Also:

NitriteId, WriteResult

update

WriteResult update(T element)

Updates element in the collection. Specified element must have an id.

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

Parameters:

element - the element to update.

Returns:

the result of the update operation.

Throws:

ValidationException - if the element is null.

NotIdentifiableException - if the element does not have any id.

update

WriteResult update(T element,
                   boolean upsert)

Updates element in the collection. Specified element must have an id. If the element is not found in the collection, it will be inserted only if upsert is set to true.

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

Parameters:

element - the element to update.

upsert - if set to true, element will be inserted if not found.

Returns:

the result of the update operation.

Throws:

ValidationException - if the element is null.

NotIdentifiableException - if the element does not have any id field.

remove

WriteResult remove(T element)

Deletes the element from the collection. The element must have an id.

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

Parameters:

element - the element

Returns:

the result of the remove operation.

Throws:

NotIdentifiableException - if the element does not have any id field.

getById

T getById(NitriteId nitriteId)

Gets a single element from the collection by its id. If no element is found, it will return null.

Parameters:

nitriteId - the nitrite id

Returns:

the unique nitrite id associated with the document.

Throws:

ValidationException - if nitriteId is null.

drop

void drop()

Drops the collection and all of its indices. <p> Any further access to a dropped collection would result into a IllegalStateException. <p>

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

isDropped

boolean isDropped()

Returns true if the collection is dropped; otherwise, false.

Returns:

a boolean value indicating if the collection has been dropped or not.

isClosed

boolean isClosed()

Returns true if the collection is closed; otherwise, false.

Returns:

a boolean value indicating if the collection has been closed or not.

close

void close()

Closes the collection for further access. If a collection once closed can only be opened via Nitrite.getCollection(String) or Nitrite.getRepository(Class) operation. <p> Any access to a closed collection would result into a IllegalStateException. <p>

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

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

getName

java.lang.String getName()

Returns the name of the PersistentCollection.

Returns:

the name.

size

long size()

Returns the size of the PersistentCollection.

Returns:

the size.