de.hybris.platform.webservicescommons.pagination.impl

Class DefaultWebPaginationUtils

java.lang.Object

de.hybris.platform.webservicescommons.pagination.impl.DefaultWebPaginationUtils

All Implemented Interfaces:

WebPaginationUtils

public class DefaultWebPaginationUtils
extends Object
implements WebPaginationUtils

Helper class for handling pagination data

Constructor Summary

Constructors

Constructor and Description
DefaultWebPaginationUtils()

Method Summary

Modifier and Type	Method and Description
PaginationWsDTO	buildPagination(SearchResult<?> search) Extracts PaginationWsDTO form data in provided SearchResult.
protected static int	calculateStartPosition(int pageSize, int currentPage)
ConfigurationService	getConfigurationService()
int	getCurrentPage(Map<String,String> params) Returns current page from map of (request) parameters.
int	getDefaultPageSize() Returns default page size
protected int	getIntFromMap(Map<String,String> params, String key, int defaultValue)
int	getMaxPageSize()
int	getPageSize(Map<String,String> params) Returns page size from map of (request) parameters.
int	getPageSize(Map<String,String> params, int defaultValue) Returns page size from map of (request) parameters.
int	getStartPosition(Map<String,String> params) Calculates start position for paginated search using vales in map of (request) parameters.
int	getStartPosition(Map<String,String> params, int defaultPageSize) Calculates start position for paginated search using vales in map of (request) parameters.
void	setConfigurationService(ConfigurationService configurationService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebPaginationUtils

public DefaultWebPaginationUtils()

Method Detail

getPageSize

public int getPageSize(Map<String,String> params)

Description copied from interface: WebPaginationUtils

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

Specified by:

getPageSize in interface WebPaginationUtils

Parameters:

params - map of parameters

Returns:

page size for current request

getPageSize

public int getPageSize(Map<String,String> params,
                       int defaultValue)

Description copied from interface: WebPaginationUtils

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

Specified by:

getPageSize in interface WebPaginationUtils

Parameters:

params - map of parameters

defaultValue - default page size

Returns:

page size for current request

getDefaultPageSize

public int getDefaultPageSize()

Description copied from interface: WebPaginationUtils

Returns default page size

Specified by:

getDefaultPageSize in interface WebPaginationUtils

Returns:

default page size

getMaxPageSize

public int getMaxPageSize()

getCurrentPage

public int getCurrentPage(Map<String,String> params)

Description copied from interface: WebPaginationUtils

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

Specified by:

getCurrentPage in interface WebPaginationUtils

Parameters:

params - map of parameters

Returns:

current page number

getIntFromMap

protected int getIntFromMap(Map<String,String> params,
                            String key,
                            int defaultValue)

getStartPosition

public int getStartPosition(Map<String,String> params)

Description copied from interface: WebPaginationUtils

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

Specified by:

getStartPosition in interface WebPaginationUtils

Parameters:

params - map of parameters

Returns:

start position for query in current request

getStartPosition

public int getStartPosition(Map<String,String> params,
                            int defaultPageSize)

Description copied from interface: WebPaginationUtils

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.

Specified by:

getStartPosition in interface WebPaginationUtils

Parameters:

params - map of parameters

defaultPageSize - default page size

Returns:

start position for query in current request

calculateStartPosition

protected static int calculateStartPosition(int pageSize,
                                            int currentPage)

buildPagination

public PaginationWsDTO buildPagination(SearchResult<?> search)

Description copied from interface: WebPaginationUtils

Extracts PaginationWsDTO form data in provided SearchResult.

Specified by:

buildPagination in interface WebPaginationUtils

Parameters:

search - SearchResult used to create PaginationWsDTO

Returns:

Pagination data

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getConfigurationService

public ConfigurationService getConfigurationService()