jakarta.nosql.mapping.document

Interface DocumentQueryMapper.DocumentMapperQueryBuild

All Known Subinterfaces:

DocumentQueryMapper.DocumentMapperFrom, DocumentQueryMapper.DocumentMapperLimit, DocumentQueryMapper.DocumentMapperNameOrder, DocumentQueryMapper.DocumentMapperSkip, DocumentQueryMapper.DocumentMapperWhere

Enclosing interface:

DocumentQueryMapper

public static interface DocumentQueryMapper.DocumentMapperQueryBuild

The last step to the build of DocumentQuery. It either can return a new DocumentQuery instance or execute a query with DocumentTemplate

Method Summary

Modifier and Type	Method and Description
DocumentQuery	build() Creates a new instance of DocumentQuery
DocumentQuery	build(Pagination pagination) Creates a new instance of DocumentQuery from Pagination
<T> Stream<T>	getResult(DocumentTemplate template) Executes DocumentTemplate.select(DocumentQuery)
<T> Stream<T>	getResult(DocumentTemplate template, Pagination pagination) Executes DocumentTemplate.select(DocumentQuery) using Pagination
<T> Optional<T>	getSingleResult(DocumentTemplate template) Executes DocumentTemplate.singleResult(DocumentQuery)
<T> Optional<T>	getSingleResult(DocumentTemplate template, Pagination pagination) Executes DocumentTemplate.singleResult(DocumentQuery) using Pagination
<T> Page<T>	page(DocumentTemplate template, Pagination pagination) Creates a Page from pagination

Method Detail

build

DocumentQuery build()

Creates a new instance of DocumentQuery

Returns:

a new DocumentQuery instance

build

DocumentQuery build(Pagination pagination)

Creates a new instance of DocumentQuery from Pagination

Parameters:

pagination - the pagination

Returns:

a new DocumentQuery instance from Pagination

getResult

<T> Stream<T> getResult(DocumentTemplate template)

Executes DocumentTemplate.select(DocumentQuery)

Type Parameters:

T - the entity type

Parameters:

template - the template to document

Returns:

the result of DocumentTemplate.select(DocumentQuery)

Throws:

NullPointerException - when manager is null

getSingleResult

<T> Optional<T> getSingleResult(DocumentTemplate template)

Executes DocumentTemplate.singleResult(DocumentQuery)

Type Parameters:

T - the entity type

Parameters:

template - the template to document

Returns:

the result of DocumentTemplate.singleResult(DocumentQuery)

Throws:

NullPointerException - when manager is null

getResult

<T> Stream<T> getResult(DocumentTemplate template,
                        Pagination pagination)

Executes DocumentTemplate.select(DocumentQuery) using Pagination

Type Parameters:

T - the entity type

Parameters:

template - the document template

pagination - the pagination

Returns:

the result of DocumentTemplate.select(DocumentQuery)

Throws:

NullPointerException - when there are null parameters

getSingleResult

<T> Optional<T> getSingleResult(DocumentTemplate template,
                                Pagination pagination)

Executes DocumentTemplate.singleResult(DocumentQuery) using Pagination

Type Parameters:

T - the entity type

Parameters:

template - the document template

pagination - the pagination

Returns:

the result of DocumentTemplate.singleResult(DocumentQuery)

Throws:

NullPointerException - when there are null parameters

page

<T> Page<T> page(DocumentTemplate template,
                 Pagination pagination)

Creates a Page from pagination

Type Parameters:

T - the type

Parameters:

pagination - the pagination

template - the template

Returns:

a Page from instance

Throws:

NullPointerException - when there are null parameters