io.cdap.wrangler.dataset.utils

Class PageRequest<T>

java.lang.Object

io.cdap.wrangler.dataset.utils.PageRequest<T>

Type Parameters:

T - Type of resource that the page request is for.

Direct Known Subclasses:

RecipePageRequest

public abstract class PageRequest<T>
extends Object

An interface to implement a page request. Pagination utility class that contains relevant fields and methods that describe a page.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE_DEFAULT
protected int	pageSize Maximum number of results to return in a page.
protected String	pageToken Token to identify the page to retrieve.
static String	SORT_ORDER_ASC
static String	SORT_ORDER_DESC
protected String	sortBy Indicates the table column name based on which results should be sorted.
protected io.cdap.cdap.spi.data.SortOrder	sortOrder Indicates the sorting order (ascending or descending).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PageRequest(Integer pageSize, String pageToken, String sortBy, String sortOrder)

Method Summary

Modifier and Type	Method and Description
protected abstract String	getDefaultSortBy() Get the default table column name using which results will be sorted.
abstract String	getNextPageToken(T object) Get the nextPageToken returned as part of response to request.
int	getPageSize()
String	getPageToken()
abstract io.cdap.cdap.spi.data.table.field.Range	getScanRange() Constructs the range used to query the storage table.
String	getSortBy()
protected abstract String	getSortByColumnName(String sortBy) Get the table column name mapped to given sortBy value.
io.cdap.cdap.spi.data.SortOrder	getSortOrder()
protected void	validatePageSize(Integer pageSize)
protected abstract void	validateSortBy(String sortBy) Checks whether given sortBy value has a respective table column mapping.
protected void	validateSortOrder(String sortOrder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pageSize

protected final int pageSize

Maximum number of results to return in a page.

pageToken

@Nullable
protected final String pageToken

Token to identify the page to retrieve. Either received from a previous page or left empty to fetch the first page.

sortBy

protected final String sortBy

Indicates the table column name based on which results should be sorted.

sortOrder

protected final io.cdap.cdap.spi.data.SortOrder sortOrder

Indicates the sorting order (ascending or descending).

SORT_ORDER_ASC

public static final String SORT_ORDER_ASC

See Also:

Constant Field Values

SORT_ORDER_DESC

public static final String SORT_ORDER_DESC

See Also:

Constant Field Values

PAGE_SIZE_DEFAULT

public static final int PAGE_SIZE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

PageRequest

protected PageRequest(Integer pageSize,
                      @Nullable
                      String pageToken,
                      String sortBy,
                      String sortOrder)

Method Detail

getPageSize

public int getPageSize()

getPageToken

@Nullable
public String getPageToken()

getSortBy

public String getSortBy()

getSortOrder

public io.cdap.cdap.spi.data.SortOrder getSortOrder()

validateSortBy

protected abstract void validateSortBy(String sortBy)
                                throws IllegalArgumentException

Checks whether given sortBy value has a respective table column mapping.

Parameters:

sortBy - field based on which results should be sorted

Throws:

IllegalArgumentException - if the value does not have a mapping

getDefaultSortBy

protected abstract String getDefaultSortBy()

Get the default table column name using which results will be sorted.

getSortByColumnName

protected abstract String getSortByColumnName(String sortBy)

Get the table column name mapped to given sortBy value.

getScanRange

public abstract io.cdap.cdap.spi.data.table.field.Range getScanRange()

Constructs the range used to query the storage table.

Returns:

Range corresponding to page query parameters.

getNextPageToken

public abstract String getNextPageToken(T object)

Get the nextPageToken returned as part of response to request.

Parameters:

object - resource returned by the request

validatePageSize

protected void validatePageSize(Integer pageSize)

validateSortOrder

protected void validateSortOrder(String sortOrder)