org.jnosql.artemis.document

Interface DocumentTemplateAsync

All Known Implementing Classes:

AbstractDocumentTemplateAsync

public interface DocumentTemplateAsync

This interface that represents the common operation between an entity and DocumentCollectionEntity.

See Also:

DocumentCollectionManagerAsync

Method Summary

Modifier and Type	Method and Description
<T> void	count(Class<T> entityClass, Consumer<Long> callback) Returns the number of elements from document collection
void	count(String documentCollection, Consumer<Long> callback) Returns the number of elements from document collection
<T,ID> void	delete(Class<T> entityClass, ID id) Deletes by Id.
<T,ID> void	delete(Class<T> entityClass, ID id, Consumer<Void> callBack) Deletes by Id.
void	delete(org.jnosql.diana.api.document.DocumentDeleteQuery query) Deletes an entity asynchronously
void	delete(org.jnosql.diana.api.document.DocumentDeleteQuery query, Consumer<Void> callback) Deletes an entity asynchronously
<T,ID> void	find(Class<T> entityClass, ID id, Consumer<Optional<T>> callBack) Finds by Id.
default <T> void	insert(Iterable<T> entities) Saves entities asynchronously, by default it's just run for each saving using insert(Object), each NoSQL vendor might replace to a more appropriate one.
default <T> void	insert(Iterable<T> entities, Duration ttl) Saves entities asynchronously with time to live, by default it's just run for each saving using insert(Object) (Object, Duration)}, each NoSQL vendor might replace to a more appropriate one.
<T> void	insert(T entity) Saves an entity asynchronously
<T> void	insert(T entity, Consumer<T> callBack) Saves an entity asynchronously
<T> void	insert(T entity, Duration ttl) Saves an entity asynchronously with time to live
<T> void	insert(T entity, Duration ttl, Consumer<T> callBack) Saves an entity asynchronously with time to live
PreparedStatementAsync	prepare(String query) Creates a PreparedStatementAsync from the query
<T> void	query(String query, Consumer<List<T>> callback) Executes a query then bring the result as a List
<T> void	select(org.jnosql.diana.api.document.DocumentQuery query, Consumer<List<T>> callback) Finds entities from query asynchronously
default <T> void	singleResult(org.jnosql.diana.api.document.DocumentQuery query, Consumer<Optional<T>> callBack) Execute a query to consume an unique result
<T> void	singleResult(String query, Consumer<Optional<T>> callback) Executes a query then bring the result as a unique result
default <T> void	update(Iterable<T> entities) Updates entities asynchronously, by default it's just run for each saving using DocumentTemplate.update(Object), each NoSQL vendor might replace to a more appropriate one.
<T> void	update(T entity) Updates an entity asynchronously
<T> void	update(T entity, Consumer<T> callBack) Updates an entity asynchronously

Method Detail

insert

<T> void insert(T entity)

Saves an entity asynchronously

Type Parameters:

T - the instance type

Parameters:

entity - entity to be saved

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when entity are null

insert

<T> void insert(T entity,
                Duration ttl)

Saves an entity asynchronously with time to live

Type Parameters:

T - the instance type

Parameters:

entity - entity to be saved

ttl - the time to live

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either entity or ttl are null

insert

default <T> void insert(Iterable<T> entities)

Saves entities asynchronously, by default it's just run for each saving using insert(Object), each NoSQL vendor might replace to a more appropriate one.

Type Parameters:

T - the instance type

Parameters:

entities - entities to be saved

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when entities is null

insert

default <T> void insert(Iterable<T> entities,
                        Duration ttl)

Saves entities asynchronously with time to live, by default it's just run for each saving using insert(Object) (Object, Duration)}, each NoSQL vendor might replace to a more appropriate one.

Type Parameters:

T - the instance type

Parameters:

entities - entities to be saved

ttl - time to live

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either entities or ttl are null

insert

<T> void insert(T entity,
                Consumer<T> callBack)

Saves an entity asynchronously

Type Parameters:

T - the instance type

Parameters:

entity - entity to be saved

callBack - the callback, when the process is finished will call this instance returning the saved entity within parameters

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either entity or callBack are null

insert

<T> void insert(T entity,
                Duration ttl,
                Consumer<T> callBack)

Saves an entity asynchronously with time to live

Type Parameters:

T - the instance type

Parameters:

entity - entity to be saved

ttl - time to live

callBack - the callback, when the process is finished will call this instance returning the saved entity within parameters

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either entity or ttl or callBack are null

update

<T> void update(T entity,
                Consumer<T> callBack)

Updates an entity asynchronously

Type Parameters:

T - the instance type

Parameters:

entity - entity to be updated

callBack - the callback, when the process is finished will call this instance returning the updated entity within parametersa

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either entity or callback are null

update

<T> void update(T entity)

Updates an entity asynchronously

Type Parameters:

T - the instance type

Parameters:

entity - entity to be updated

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when entity is null

update

default <T> void update(Iterable<T> entities)

Updates entities asynchronously, by default it's just run for each saving using DocumentTemplate.update(Object), each NoSQL vendor might replace to a more appropriate one.

Type Parameters:

T - the instance type

Parameters:

entities - entities to be saved

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when entities is null

delete

void delete(org.jnosql.diana.api.document.DocumentDeleteQuery query)

Deletes an entity asynchronously

Parameters:

query - query to delete an entity

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when query is null

delete

void delete(org.jnosql.diana.api.document.DocumentDeleteQuery query,
            Consumer<Void> callback)

Deletes an entity asynchronously

Parameters:

query - query to delete an entity

callback - the callback, when the process is finished will call this instance returning the null within parameters

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to delete asynchronous

NullPointerException - when either query or callback are null

select

<T> void select(org.jnosql.diana.api.document.DocumentQuery query,
                Consumer<List<T>> callback)

Finds entities from query asynchronously

Type Parameters:

T - the instance type

Parameters:

query - query to select entities

callback - the callback, when the process is finished will call this instance returning the result of query within parameters

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either query or callback are null

query

<T> void query(String query,
               Consumer<List<T>> callback)

Executes a query then bring the result as a List

Type Parameters:

T - the entity type

Parameters:

callback - the callback, when the process is finished will call this instance returning

query - the query

Throws:

NullPointerException - when the query is null

singleResult

<T> void singleResult(String query,
                      Consumer<Optional<T>> callback)

Executes a query then bring the result as a unique result

Type Parameters:

T - the entity type

Parameters:

callback - the callback, when the process is finished will call this instance returning

query - the query

Throws:

NullPointerException - when the query is null

org.jnosql.diana.api.NonUniqueResultException - if returns more than one result

prepare

PreparedStatementAsync prepare(String query)

Creates a PreparedStatementAsync from the query

Parameters:

query - the query

Returns:

a PreparedStatementAsync instance

Throws:

NullPointerException - when the query is null

find

<T,ID> void find(Class<T> entityClass,
                 ID id,
                 Consumer<Optional<T>> callBack)

Finds by Id.

Type Parameters:

T - the entity class type

ID - the id type

Parameters:

entityClass - the entity class

id - the id value

callBack - the callBack

Throws:

NullPointerException - when either the entityClass or id are null

IdNotFoundException - when the entityClass does not have the Id annotation

delete

<T,ID> void delete(Class<T> entityClass,
                   ID id,
                   Consumer<Void> callBack)

Deletes by Id.

Type Parameters:

T - the entity class type

ID - the id type

Parameters:

entityClass - the entity class

id - the id value

callBack - the callBack

Throws:

NullPointerException - when either the entityClass or id are null

IdNotFoundException - when the entityClass does not have the Id annotation

delete

<T,ID> void delete(Class<T> entityClass,
                   ID id)

Deletes by Id.

Type Parameters:

T - the entity class type

ID - the id type

Parameters:

entityClass - the entity class

id - the id value

Throws:

NullPointerException - when either the entityClass or id are null

IdNotFoundException - when the entityClass does not have the Id annotation

count

void count(String documentCollection,
           Consumer<Long> callback)

Returns the number of elements from document collection

Parameters:

documentCollection - the document collection

callback - the callback with the response

Throws:

NullPointerException - when there is null parameter

UnsupportedOperationException - when the database dot not have support

count

<T> void count(Class<T> entityClass,
               Consumer<Long> callback)

Returns the number of elements from document collection

Type Parameters:

T - the entity type

Parameters:

entityClass - the document collection

callback - the callback with the response

Throws:

NullPointerException - when there is null parameter

UnsupportedOperationException - when the database dot not have support

singleResult

default <T> void singleResult(org.jnosql.diana.api.document.DocumentQuery query,
                              Consumer<Optional<T>> callBack)

Execute a query to consume an unique result

Type Parameters:

T - the type

Parameters:

query - the query

callBack - the callback

Throws:

org.jnosql.diana.api.ExecuteAsyncQueryException - when there is a async error

UnsupportedOperationException - when the database does not have support to insert asynchronous

NullPointerException - when either query or callback are null

org.jnosql.diana.api.NonUniqueResultException - when it returns more than one result