jakarta.nosql.mapping.document

Interface DocumentTemplate

All Superinterfaces:

Template

public interface DocumentTemplate
extends Template

DocumentTemplate is a helper class that increases productivity when performing common DocumentEntity operations. Includes integrated object mapping between documents and POJOs. It represents the common operation between an entity and DocumentCollectionManager

See Also:

DocumentCollectionManager

Method Summary

Modifier and Type	Method and Description
<T> long	count(Class<T> entityType) Returns the number of elements from document collection
long	count(String documentCollection) Returns the number of elements from document collection
void	delete(DocumentDeleteQuery 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(DocumentQuery query) Finds entities from query
<T> Page<T>	select(DocumentQueryPagination query) Finds entities from query using pagination
<T> Optional<T>	singleResult(DocumentQuery 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

delete

void delete(DocumentDeleteQuery query)

Deletes an entity

Parameters:

query - query to delete an entity

Throws:

NullPointerException - query is null

select

<T> Stream<T> select(DocumentQuery 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(DocumentQueryPagination 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

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

count

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

Returns the number of elements from document collection

Type Parameters:

T - entityType

Parameters:

entityType - the document collection

Returns:

the number of elements

Throws:

NullPointerException - when document collection is null

UnsupportedOperationException - when the database dot not have support

singleResult

<T> Optional<T> singleResult(DocumentQuery 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