jakarta.nosql.mapping.document

Interface DocumentQueryMapper.DocumentMapperFrom

All Superinterfaces:

DocumentQueryMapper.DocumentMapperQueryBuild

Enclosing interface:

DocumentQueryMapper

public static interface DocumentQueryMapper.DocumentMapperFrom
extends DocumentQueryMapper.DocumentMapperQueryBuild

The DocumentFrom Query

Method Summary

Modifier and Type	Method and Description
DocumentQueryMapper.DocumentMapperLimit	limit(long limit) Defines the maximum number of results to retrieve.
DocumentQueryMapper.DocumentMapperOrder	orderBy(String name) Add the order how the result will returned
DocumentQueryMapper.DocumentMapperSkip	skip(long skip) Defines the position of the first result to retrieve.
DocumentQueryMapper.DocumentMapperNameCondition	where(String name) Starts a new condition defining the column name

Methods inherited from interface jakarta.nosql.mapping.document.DocumentQueryMapper.DocumentMapperQueryBuild

build, build, getResult, getResult, getResult, getSingleResult, getSingleResult, getSingleResult, page

Method Detail

where

DocumentQueryMapper.DocumentMapperNameCondition where(String name)

Starts a new condition defining the column name

Parameters:

name - the column name

Returns:

a new DocumentQueryMapper.DocumentMapperNameCondition

Throws:

NullPointerException - when name is null

skip

DocumentQueryMapper.DocumentMapperSkip skip(long skip)

Defines the position of the first result to retrieve.

Parameters:

skip - the first result to retrive

Returns:

a query with first result defined

limit

DocumentQueryMapper.DocumentMapperLimit limit(long limit)

Defines the maximum number of results to retrieve.

Parameters:

limit - the limit

Returns:

a query with the limit defined

orderBy

DocumentQueryMapper.DocumentMapperOrder orderBy(String name)

Add the order how the result will returned

Parameters:

name - the order

Returns:

a query with the sort defined

Throws:

NullPointerException - when name is null