DocumentCollectionManager (communication-document 1.0.0-b2 API)

All Superinterfaces:

AutoCloseable
```
public interface DocumentCollectionManager
extends AutoCloseable
```
Interface used to interact with the persistence context to DocumentEntity The DocumentCollectionManager API is used to create and remove persistent DocumentEntity instances, to select entities by their primary key, and to select over entities.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`close()` closes a resource
`long`	`count(String documentCollection)` Returns the number of elements from document collection
`void`	`delete(DocumentDeleteQuery query)` Deletes an entity
`DocumentEntity`	`insert(DocumentEntity entity)` Saves document collection entity
`DocumentEntity`	`insert(DocumentEntity entity, Duration ttl)` Saves document collection entity with time to live
`Iterable<DocumentEntity>`	`insert(Iterable<DocumentEntity> entities)` Saves documents collection entity, by default it's just run for each saving using `insert(DocumentEntity)`, each NoSQL vendor might replace to a more appropriate one.
`Iterable<DocumentEntity>`	`insert(Iterable<DocumentEntity> entities, Duration ttl)` Saves documents collection entity with time to live, by default it's just run for each saving using `insert(DocumentEntity, Duration)`, each NoSQL vendor might replace to a more appropriate one.
`default DocumentPreparedStatement`	`prepare(String query)` Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.
`default Stream<DocumentEntity>`	`query(String query)` Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.
`Stream<DocumentEntity>`	`select(DocumentQuery query)` Finds `DocumentEntity` from select
`default Optional<DocumentEntity>`	`singleResult(DocumentQuery query)` Returns a single entity from select
`DocumentEntity`	`update(DocumentEntity entity)` Updates a entity
`Iterable<DocumentEntity>`	`update(Iterable<DocumentEntity> entities)` Updates documents collection entity, by default it's just run for each saving using `update(DocumentEntity)`, each NoSQL vendor might replace to a more appropriate one.

- Method Detail
  - insert
```
DocumentEntity insert(DocumentEntity entity)
```
    Saves document collection entity
    
    Parameters:
    
    entity - entity to be saved
    
    Returns:
    
    the entity saved
    
    Throws:
    
    NullPointerException - when document is null
  - insert
```
DocumentEntity insert(DocumentEntity entity,
                      Duration ttl)
```
    Saves document collection entity with time to live
    
    Parameters:
    
    entity - entity to be saved
    
    ttl - the time to live
    
    Returns:
    
    the entity saved
    
    Throws:
    
    NullPointerException - when either entity or ttl are null
    
    UnsupportedOperationException - when the database does not support this feature
  - insert
```
Iterable<DocumentEntity> insert(Iterable<DocumentEntity> entities)
```
    Saves documents collection entity, by default it's just run for each saving using insert(DocumentEntity), each NoSQL vendor might replace to a more appropriate one.
    
    Parameters:
    
    entities - entities to be saved
    
    Returns:
    
    the entity saved
    
    Throws:
    
    NullPointerException - when entities is null
  - insert
```
Iterable<DocumentEntity> insert(Iterable<DocumentEntity> entities,
                                Duration ttl)
```
    Saves documents collection entity with time to live, by default it's just run for each saving using insert(DocumentEntity, Duration), each NoSQL vendor might replace to a more appropriate one.
    
    Parameters:
    
    entities - entities to be saved
    
    ttl - time to live
    
    Returns:
    
    the entity saved
    
    Throws:
    
    NullPointerException - when entities is null
    
    UnsupportedOperationException - when the database does not support this feature
  - update
```
DocumentEntity update(DocumentEntity entity)
```
    Updates a entity
    
    Parameters:
    
    entity - entity to be updated
    
    Returns:
    
    the entity updated
    
    Throws:
    
    NullPointerException - when entity is null
  - update
```
Iterable<DocumentEntity> update(Iterable<DocumentEntity> entities)
```
    Updates documents collection entity, by default it's just run for each saving using update(DocumentEntity), each NoSQL vendor might replace to a more appropriate one.
    
    Parameters:
    
    entities - entities to be saved
    
    Returns:
    
    the entity saved
    
    Throws:
    
    NullPointerException - when entities is null
  - delete
```
void delete(DocumentDeleteQuery query)
```
    Deletes an entity
    
    Parameters:
    
    query - select to delete an entity
    
    Throws:
    
    NullPointerException - when select is null
    
    UnsupportedOperationException - if the implementation does not support any operation that a query has.
  - select
```
Stream<DocumentEntity> select(DocumentQuery query)
```
    Finds DocumentEntity from select
    
    Parameters:
    
    query - - select to figure out entities
    
    Returns:
    
    entities found by select
    
    Throws:
    
    NullPointerException - when select is null
    
    UnsupportedOperationException - if the implementation does not support any operation that a query has.
  - query
```
default Stream<DocumentEntity> query(String query)
```
    Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.
    
    Parameters:
    
    query - the query as String
    
    Returns:
    
    the result of the operation if delete it will always return an empty list
    
    Throws:
    
    NullPointerException - when there is parameter null
    
    IllegalArgumentException - when the query has value parameters
    
    IllegalStateException - when there is not DocumentQueryParser
    
    QueryException - when there is error in the syntax
  - prepare
```
default DocumentPreparedStatement prepare(String query)
```
    Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.
    
    Parameters:
    
    query - the query as String
    
    Returns:
    
    a DocumentPreparedStatement instance
    
    Throws:
    
    NullPointerException - when there is parameter null
    
    IllegalStateException - when there is not DocumentQueryParser
    
    QueryException - when there is error in the syntax
  - singleResult
```
default Optional<DocumentEntity> singleResult(DocumentQuery query)
```
    Returns a single entity from select
    
    Parameters:
    
    query - - select to figure out entities
    
    Returns:
    
    an entity on Optional or Optional.empty() when the result is not found.
    
    Throws:
    
    NonUniqueResultException - when the result has more than 1 entity
    
    NullPointerException - when select is null
    
    UnsupportedOperationException - if the implementation does not support any operation that a query has.
  - count
```
long count(String documentCollection)
```
    Returns the number of elements from document collection
    
    Parameters:
    
    documentCollection - the document collection
    
    Returns:
    
    the number of elements
    
    Throws:
    
    NullPointerException - when document collection is null
    
    UnsupportedOperationException - when the database dot not have support
  - close
```
void close()
```
    closes a resource
    
    Specified by:
    
    close in interface AutoCloseable

Interface DocumentCollectionManager

Method Summary

Method Detail

insert

insert

insert

insert

update

update

delete

select

query

prepare

singleResult

count

close