org.seedstack.business.pagination.dsl

Interface PaginationTypePicker<A extends AggregateRoot<I>,I>

Type Parameters:

A - the aggregate root type that is paginated.

I - the aggregate root identifier type.

All Known Subinterfaces:

RepositoryOptionsPicker<A,I>

public interface PaginationTypePicker<A extends AggregateRoot<I>,I>

An element of the Paginator DSL allowing to choose the pagination type. Three pagination types are supported:

• Offset-based which allows to skip a specified amount of objects,
• Page-based which is similar to offset-based but allows to specify the amount of skipped objects as a number of pages,
• Key-based which allows to select objects that come after a specific value of a specific attribute.

Method Summary

Modifier and Type	Method and Description
KeyValuePicker<A,I>	byAttribute(String attributeName) Choose a key-based pagination type.
LimitPicker<Slice<A>,A,I>	byOffset(long startingOffset) Choose an offset-based pagination type.
SizePicker<A,I>	byPage(long pageIndex) Choose a page-based pagination type.

Method Detail

byPage

SizePicker<A,I> byPage(long pageIndex)

Choose a page-based pagination type. Objects that come before the beginning of specified page will be skipped.

Parameters:

pageIndex - the index of the page containing objects that will be returned.

Returns:

the next operation of the paginator DSL, allowing to specify page size.

byOffset

LimitPicker<Slice<A>,A,I> byOffset(long startingOffset)

Choose an offset-based pagination type. Objects that come before the specified index will be skipped.

Parameters:

startingOffset - the index of first object that will be returned.

Returns:

the next operation of the paginator DSL, allowing to specify a limit to the number of objects returned.

byAttribute

KeyValuePicker<A,I> byAttribute(String attributeName)

Choose a key-based pagination type.

Parameters:

attributeName - the attribute on which the lessThan/greaterThan comparison will be made.

Returns:

the next operation of the paginator DSL, allowing to specify the value used as boundary.