de.hybris.platform.webservicescommons.pagination

Interface WebPaginationUtils

All Known Implementing Classes:

DefaultWebPaginationUtils

public interface WebPaginationUtils

Utility class for creating pagination info from web request parameters

Method Summary

Modifier and Type	Method and Description
PaginationWsDTO	buildPagination(SearchResult<?> search) Extracts PaginationWsDTO form data in provided SearchResult.
PaginationData	buildPaginationData(HttpServletRequest request) Builds PaginationData based on provided request
PaginationData	buildPaginationData(int currentPage, int pageSize) Builds PaginationData based on provided data
PaginationData	buildPaginationData(int currentPage, int pageSize, boolean needsTotal) Builds PaginationData based on provided data
PaginationWsDTO	buildPaginationWsDto(PaginationData paginationData) Converts PaginationData into PaginationWsDTO object
<RESULT> SearchPageData<RESULT>	buildSearchPageData(HttpServletRequest request) Builds whole SearchPageData object from provided request
<RESULT> SearchPageData<RESULT>	buildSearchPageData(java.lang.String sort, int currentPage, int pageSize, boolean needsTotal) Builds whole SearchPageData object from provided request
<RESULT,INPUT> SearchPageWsDTO<RESULT>	buildSearchPageWsDto(SearchPageData<INPUT> searchPage) Converts SearchPageData into SearchPageWsDTO.
<RESULT,INPUT> SearchPageWsDTO<RESULT>	buildSearchPageWsDto(SearchPageData<INPUT> searchPage, Converter<INPUT,RESULT> dataConverter) Converts SearchPageData into SearchPageWsDTO.
java.util.List<SortData>	buildSortData(HttpServletRequest request) Builds list of SortData objects from provided request.
java.util.List<SortWsDTO>	buildSortWsDto(java.util.List<SortData> sortData) Converts list of SortData objects into list of SortWsDTO objects.
int	getCurrentPage(java.util.Map<java.lang.String,java.lang.String> params) Returns current page from map of (request) parameters.
int	getDefaultPageSize() Returns default page size
boolean	getNeedsTotal(java.util.Map<java.lang.String,java.lang.String> params)
int	getPageSize(java.util.Map<java.lang.String,java.lang.String> params) Returns page size from map of (request) parameters.
int	getPageSize(java.util.Map<java.lang.String,java.lang.String> params, int defaultValue) Returns page size from map of (request) parameters.
int	getStartPosition(java.util.Map<java.lang.String,java.lang.String> params) Calculates start position for paginated search using vales in map of (request) parameters.
int	getStartPosition(java.util.Map<java.lang.String,java.lang.String> params, int defaultPageSize) Calculates start position for paginated search using vales in map of (request) parameters.

Method Detail

getPageSize

int getPageSize(java.util.Map<java.lang.String,java.lang.String> params)

Returns page size from map of (request) parameters. Uses WebservicescommonsConstants.PAGE_SIZE as key.

Parameters:

params - map of parameters

Returns:

page size for current request

getPageSize

int getPageSize(java.util.Map<java.lang.String,java.lang.String> params,
                int defaultValue)

Returns page size from map of (request) parameters. Uses WebservicescommonsConstants.PAGE_SIZE as key. If not found returns given default.

Parameters:

params - map of parameters

defaultValue - default page size

Returns:

page size for current request

getDefaultPageSize

int getDefaultPageSize()

Returns default page size

Returns:

default page size

getCurrentPage

int getCurrentPage(java.util.Map<java.lang.String,java.lang.String> params)

Returns current page from map of (request) parameters. Uses WebservicescommonsConstants.CURRENT_PAGE as key.

Parameters:

params - map of parameters

Returns:

current page number

getNeedsTotal

boolean getNeedsTotal(java.util.Map<java.lang.String,java.lang.String> params)

getStartPosition

int getStartPosition(java.util.Map<java.lang.String,java.lang.String> params)

Calculates start position for paginated search using vales in map of (request) parameters.

Parameters:

params - map of parameters

Returns:

start position for query in current request

getStartPosition

int getStartPosition(java.util.Map<java.lang.String,java.lang.String> params,
                     int defaultPageSize)

Calculates start position for paginated search using vales in map of (request) parameters. Uses provided defaultPageSize instead of system one in case of not finding page size in provided params.

Parameters:

params - map of parameters

defaultPageSize - default page size

Returns:

start position for query in current request

buildPagination

PaginationWsDTO buildPagination(SearchResult<?> search)

Extracts PaginationWsDTO form data in provided SearchResult.

Parameters:

search - SearchResult used to create PaginationWsDTO

Returns:

Pagination data

buildSortData

java.util.List<SortData> buildSortData(HttpServletRequest request)

Builds list of SortData objects from provided request.

Parameters:

request - request containing sort information

Returns:

List of sort data object. May be empty but not null.

buildPaginationData

PaginationData buildPaginationData(HttpServletRequest request)

Builds PaginationData based on provided request

Parameters:

request - request containing pagination information

Returns:

PaginationData object. Not null.

buildPaginationData

PaginationData buildPaginationData(int currentPage,
                                   int pageSize)

Builds PaginationData based on provided data

Parameters:

currentPage - current page

pageSize - size of the page

Returns:

PaginationData object. Not null.

buildPaginationData

PaginationData buildPaginationData(int currentPage,
                                   int pageSize,
                                   boolean needsTotal)

Builds PaginationData based on provided data

Parameters:

currentPage - current page

pageSize - size of the page

needsTotal -

Returns:

PaginationData object. Not null.

buildSearchPageData

<RESULT> SearchPageData<RESULT> buildSearchPageData(HttpServletRequest request)

Builds whole SearchPageData object from provided request

Parameters:

request - request containing search page information

Returns:

SearchPageData object. Not null.

buildSearchPageData

<RESULT> SearchPageData<RESULT> buildSearchPageData(java.lang.String sort,
                                                    int currentPage,
                                                    int pageSize,
                                                    boolean needsTotal)

Builds whole SearchPageData object from provided request

Parameters:

sort - String describing list of sorts for this SearchPageData

currentPage - current page

pageSize - size of the page

needsTotal - defines if numberOfPages and totalNumberOfResults in pagination object will be populated.

Returns:

SearchPageData object. Not null.

buildPaginationWsDto

PaginationWsDTO buildPaginationWsDto(PaginationData paginationData)

Converts PaginationData into PaginationWsDTO object

Parameters:

paginationData - input conversion data

Returns:

output of conversion. Not null.

buildSortWsDto

java.util.List<SortWsDTO> buildSortWsDto(java.util.List<SortData> sortData)

Converts list of SortData objects into list of SortWsDTO objects.

Parameters:

sortData - list to convert

Returns:

List of converted objects. Not Null.

buildSearchPageWsDto

<RESULT,INPUT> SearchPageWsDTO<RESULT> buildSearchPageWsDto(SearchPageData<INPUT> searchPage)

Converts SearchPageData into SearchPageWsDTO. Results object is ignored during this conversion.

Parameters:

searchPage - data to convert

Returns:

SearchPageWsDTO object. Not null.

buildSearchPageWsDto

<RESULT,INPUT> SearchPageWsDTO<RESULT> buildSearchPageWsDto(SearchPageData<INPUT> searchPage,
                                                            Converter<INPUT,RESULT> dataConverter)

Converts SearchPageData into SearchPageWsDTO. Results object is converted using provided converter.

Parameters:

searchPage - data to convert

dataConverter - converter used for results data conversion.

Returns:

SearchPageWsDTO object. Not null.