org.brapi.v2.model.geno

Class BrAPIAlleleMatrixPagination

java.lang.Object

org.brapi.v2.model.geno.BrAPIAlleleMatrixPagination

public class BrAPIAlleleMatrixPagination
extends Object

AlleleMatrixPagination

Constructor Summary

Constructors

Constructor and Description
BrAPIAlleleMatrixPagination()

Method Summary

Modifier and Type	Method and Description
BrAPIAlleleMatrixPagination	dimension(BrAPIDimensionEnum dimension)
boolean	equals(Object o)
BrAPIDimensionEnum	getDimension() The dimension of the matrix being paginated
Integer	getPage() the requested page number (zero indexed)
Integer	getPageSize() the maximum number of elements per page in this dimension of the matrix
Integer	getTotalCount() The total number of elements that are available on the server and match the requested query parameters.
Integer	getTotalPages() The total number of pages of elements available on the server.
int	hashCode()
BrAPIAlleleMatrixPagination	page(Integer page)
BrAPIAlleleMatrixPagination	pageSize(Integer pageSize)
void	setDimension(BrAPIDimensionEnum dimension)
void	setPage(Integer page)
void	setPageSize(Integer pageSize)
void	setTotalCount(Integer totalCount)
void	setTotalPages(Integer totalPages)
String	toString()
BrAPIAlleleMatrixPagination	totalCount(Integer totalCount)
BrAPIAlleleMatrixPagination	totalPages(Integer totalPages)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BrAPIAlleleMatrixPagination

public BrAPIAlleleMatrixPagination()

Method Detail

dimension

public BrAPIAlleleMatrixPagination dimension(BrAPIDimensionEnum dimension)

getDimension

public BrAPIDimensionEnum getDimension()

The dimension of the matrix being paginated

Returns:

dimension

setDimension

public void setDimension(BrAPIDimensionEnum dimension)

page

public BrAPIAlleleMatrixPagination page(Integer page)

getPage

public Integer getPage()

the requested page number (zero indexed)

Returns:

page

setPage

public void setPage(Integer page)

pageSize

public BrAPIAlleleMatrixPagination pageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

the maximum number of elements per page in this dimension of the matrix

Returns:

pageSize

setPageSize

public void setPageSize(Integer pageSize)

totalCount

public BrAPIAlleleMatrixPagination totalCount(Integer totalCount)

getTotalCount

public Integer getTotalCount()

The total number of elements that are available on the server and match the requested query parameters.

Returns:

totalCount

setTotalCount

public void setTotalCount(Integer totalCount)

totalPages

public BrAPIAlleleMatrixPagination totalPages(Integer totalPages)

getTotalPages

public Integer getTotalPages()

The total number of pages of elements available on the server. This should be calculated with the following formula. <br/>totalPages = CEILING( totalCount / requested_page_size)

Returns:

totalPages

setTotalPages

public void setTotalPages(Integer totalPages)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object