jakarta.nosql.mapping.column

Interface ColumnTemplate

All Superinterfaces:

Template

public interface ColumnTemplate
extends Template

ColumnTemplate is a helper class that increases productivity when performing common Column Family operations. Includes integrated object mapping between documents and POJOs. It represents the common operation between an entity and ColumnFamilyManager

See Also:

ColumnFamilyManager

Method Summary

Modifier and Type	Method and Description
<T> long	count(Class<T> entityClass) Returns the number of elements from column family
long	count(String columnFamily) Returns the number of elements from column family
void	delete(ColumnDeleteQuery query) Deletes an entity
PreparedStatement	prepare(String query) Creates a PreparedStatement from the query
<T> Stream<T>	query(String query) Executes a query then bring the result as a Stream
<T> Stream<T>	select(ColumnQuery query) Finds entities from query
<T> Page<T>	select(ColumnQueryPagination query) Finds entities from query using pagination
<T> Optional<T>	singleResult(ColumnQuery query) Returns a single entity from query
<T> Optional<T>	singleResult(String query) Executes a query then bring the result as a unique result

Methods inherited from interface jakarta.nosql.mapping.Template

delete, find, insert, insert, insert, insert, update, update

Method Detail

count

long count(String columnFamily)

Returns the number of elements from column family

Parameters:

columnFamily - the column family

Returns:

the number of elements

Throws:

NullPointerException - when column family is null

UnsupportedOperationException - when the database dot not have support

count

<T> long count(Class<T> entityClass)

Returns the number of elements from column family

Type Parameters:

T - the entity type

Parameters:

entityClass - the column family

Returns:

the number of elements

Throws:

NullPointerException - when column family is null

UnsupportedOperationException - when the database dot not have support

delete

void delete(ColumnDeleteQuery query)

Deletes an entity

Parameters:

query - query to delete an entity

Throws:

NullPointerException - when query is null

select

<T> Stream<T> select(ColumnQuery query)

Finds entities from query

Type Parameters:

T - the instance type

Parameters:

query - - query to figure out entities

Returns:

entities found by query

Throws:

NullPointerException - when query is null

select

<T> Page<T> select(ColumnQueryPagination query)

Finds entities from query using pagination

Type Parameters:

T - the instance type

Parameters:

query - - query to figure out entities

Returns:

entities found by query

Throws:

NullPointerException - when query is null

singleResult

<T> Optional<T> singleResult(ColumnQuery query)

Returns a single entity from query

Type Parameters:

T - the instance type

Parameters:

query - - query to figure out entities

Returns:

an entity on Optional or Optional.empty() when the result is not found.

Throws:

jakarta.nosql.NonUniqueResultException - when the result has more than 1 entity

NullPointerException - when query is null

query

<T> Stream<T> query(String query)

Executes a query then bring the result as a Stream

Type Parameters:

T - the entity type

Parameters:

query - the query

Returns:

the result as Stream

Throws:

NullPointerException - when the query is null

UnsupportedOperationException - if the specified template does not support this operation

singleResult

<T> Optional<T> singleResult(String query)

Executes a query then bring the result as a unique result

Type Parameters:

T - the entity type

Parameters:

query - the query

Returns:

the result as Optional

Throws:

NullPointerException - when the query is null

jakarta.nosql.NonUniqueResultException - if returns more than one result

UnsupportedOperationException - if the specified template does not support this operation

prepare

PreparedStatement prepare(String query)

Creates a PreparedStatement from the query

Parameters:

query - the query

Returns:

a PreparedStatement instance

Throws:

NullPointerException - when the query is null

UnsupportedOperationException - if the specified template does not support this operation