jakarta.nosql.mapping.column

Interface ColumnTemplateAsync

public interface ColumnTemplateAsync

This interface that represents the common operation between an entity and ColumnEntity to do async operations

See Also:

ColumnFamilyManagerAsync

Method Summary

Modifier and Type	Method and Description
<T> void	count(Class<T> entityClass, Consumer<Long> callback) Returns the number of elements from column family
void	count(String columnFamily, Consumer<Long> callback) Returns the number of elements from column family
<T,K> void	delete(Class<T> entityClass, K id) Deletes by Id.
<T,K> void	delete(Class<T> entityClass, K id, Consumer<Void> callback) Deletes by Id.
void	delete(ColumnDeleteQuery query) Deletes an entity asynchronously
void	delete(ColumnDeleteQuery query, Consumer<Void> callback) Deletes an entity asynchronously
<T,K> void	find(Class<T> entityClass, K id, Consumer<Optional<T>> callback) Finds by Id.
default <T> void	insert(Iterable<T> entities) Inserts entities asynchronously, by default it's just run for each saving using ColumnTemplate.insert(Object), each NoSQL vendor might replace to a more appropriate one.
default <T> void	insert(Iterable<T> entities, Duration ttl) Inserts entities asynchronously with time to live, by default it's just run for each saving using ColumnTemplate.insert(Object, Duration), each NoSQL vendor might replace to a more appropriate one.
<T> void	insert(T entity) Inserts an entity asynchronously
<T> void	insert(T entity, Consumer<T> callback) Inserts an entity asynchronously
<T> void	insert(T entity, Duration ttl) Inserts an entity asynchronously with time to live
<T> void	insert(T entity, Duration ttl, Consumer<T> callback) Inserts an entity asynchronously with time to live
PreparedStatementAsync	prepare(String query) Creates a PreparedStatementAsync from the query
<T> void	query(String query, Consumer<Stream<T>> callback) Executes a query then bring the result as a Stream
<T> void	select(ColumnQuery query, Consumer<Stream<T>> callback) Finds entities from query asynchronously
<T> void	singleResult(ColumnQuery 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
<T> void	update(Iterable<T> entities) Inserts entities asynchronously, by default it's just run for each saving using ColumnTemplate.update(Object), each NoSQL vendor might replace to a more appropriate one.
<T> void	update(T entity) Inserts an entity asynchronously
<T> void	update(T entity, Consumer<T> callback) Inserts an entity asynchronously

Method Detail

insert

<T> void insert(T entity)

Inserts an entity asynchronously

Type Parameters:

T - the instance type

Parameters:

entity - entity to be saved

Throws:

jakarta.nosql.ExecuteAsyncQueryException - when there is a async error

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

NullPointerException - when entity is null

insert

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

Inserts 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:

jakarta.nosql.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)

Inserts entities asynchronously, by default it's just run for each saving using ColumnTemplate.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:

jakarta.nosql.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)

Inserts entities asynchronously with time to live, by default it's just run for each saving using ColumnTemplate.insert(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:

jakarta.nosql.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)

Inserts 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:

jakarta.nosql.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)

Inserts 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:

jakarta.nosql.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)

Inserts an entity asynchronously

Type Parameters:

T - the instance type

Parameters:

entity - entity to be updated

Throws:

jakarta.nosql.ExecuteAsyncQueryException - when there is a async error

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

NullPointerException - when entity is null

update

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

Inserts entities asynchronously, by default it's just run for each saving using ColumnTemplate.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:

jakarta.nosql.ExecuteAsyncQueryException - when there is a async error

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

NullPointerException - when entities is null

update

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

Inserts 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:

jakarta.nosql.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

delete

void delete(ColumnDeleteQuery query)

Deletes an entity asynchronously

Parameters:

query - query to delete an entity

Throws:

jakarta.nosql.ExecuteAsyncQueryException - when there is a async error

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

NullPointerException - when query are null

delete

void delete(ColumnDeleteQuery 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:

jakarta.nosql.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(ColumnQuery query,
                Consumer<Stream<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:

jakarta.nosql.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<Stream<T>> callback)

Executes a query then bring the result as a Stream

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

jakarta.nosql.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,K> void find(Class<T> entityClass,
                K id,
                Consumer<Optional<T>> callback)

Finds by Id.

Type Parameters:

T - the entity class type

K - the id type

Parameters:

entityClass - the entity class

id - the id value

callback - the callback observer

Throws:

NullPointerException - when either the entityClass or id are null

IdNotFoundException - when the entityClass does not have the Id annotation

delete

<T,K> void delete(Class<T> entityClass,
                  K id,
                  Consumer<Void> callback)

Deletes by Id.

Type Parameters:

T - the entity class type

K - 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,K> void delete(Class<T> entityClass,
                  K id)

Deletes by Id.

Type Parameters:

T - the entity class type

K - 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 columnFamily,
           Consumer<Long> callback)

Returns the number of elements from column family

Parameters:

columnFamily - the column family

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 column family

Type Parameters:

T - the entity type

Parameters:

entityClass - the entity class

callback - the callback with the response

Throws:

NullPointerException - when there is null parameter

UnsupportedOperationException - when the database dot not have support

singleResult

<T> void singleResult(ColumnQuery 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:

jakarta.nosql.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

jakarta.nosql.NonUniqueResultException - when it returns more than one result