Class DefaultWebPaginationUtils
java.lang.Object
de.hybris.platform.webservicescommons.pagination.impl.DefaultWebPaginationUtils
- All Implemented Interfaces:
WebPaginationUtils
Helper class for handling pagination data
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuildPagination(SearchResult<?> search) ExtractsPaginationWsDTOform data in providedSearchResult.buildPaginationData(int currentPage, int pageSize) Builds PaginationData based on provided databuildPaginationData(int currentPage, int pageSize, boolean needsTotal) Builds PaginationData based on provided databuildPaginationData(Map<String, String> requestParams) Builds PaginationData based on provided request parameter mapbuildPaginationData(javax.servlet.http.HttpServletRequest request) Builds PaginationData based on provided requestbuildPaginationWsDto(PaginationData paginationData) Converts PaginationData into PaginationWsDTO object<RESULT> SearchPageData<RESULT>buildSearchPageData(String sort, int currentPage, int pageSize, boolean needsTotal) Builds whole SearchPageData object from provided request<RESULT> SearchPageData<RESULT>buildSearchPageData(Map<String, String> requestParams) Builds whole SearchPageData object from provided request<RESULT> SearchPageData<RESULT>buildSearchPageData(javax.servlet.http.HttpServletRequest request) 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.buildSortData(String sort) Builds list of SortData objects from provided string.buildSortData(Map<String, String> requestParams) Builds list of SortData objects from provided request parameter map.buildSortData(javax.servlet.http.HttpServletRequest request) Builds list of SortData objects from provided request.buildSortWsDto(List<SortData> sortData) Converts list of SortData objects into list of SortWsDTO objects.intgetCurrentPage(Map<String, String> params) Returns current page from map of (request) parameters.intReturns default page sizeintbooleangetNeedsTotal(Map<String, String> requestParams) intgetPageSize(Map<String, String> params) Returns page size from map of (request) parameters.intgetPageSize(Map<String, String> params, int defaultValue) Returns page size from map of (request) parameters.intgetStartPosition(Map<String, String> params) Calculates start position for paginated search using vales in map of (request) parameters.intgetStartPosition(Map<String, String> params, int defaultPageSize) Calculates start position for paginated search using vales in map of (request) parameters.voidsetConfigurationService(ConfigurationService configurationService) voidsetPaginationDataConverter(Converter<PaginationData, PaginationWsDTO> paginationDataConverter) voidsetSortDataConverter(Converter<SortData, SortWsDTO> sortDataConverter)
-
Constructor Details
-
DefaultWebPaginationUtils
public DefaultWebPaginationUtils()
-
-
Method Details
-
getPageSize
Description copied from interface:WebPaginationUtilsReturns page size from map of (request) parameters. Uses WebservicescommonsConstants.PAGE_SIZE as key.- Specified by:
getPageSizein interfaceWebPaginationUtils- Parameters:
params- map of parameters- Returns:
- page size for current request
-
getPageSize
Description copied from interface:WebPaginationUtilsReturns page size from map of (request) parameters. Uses WebservicescommonsConstants.PAGE_SIZE as key. If not found returns given default.- Specified by:
getPageSizein interfaceWebPaginationUtils- Parameters:
params- map of parametersdefaultValue- default page size- Returns:
- page size for current request
-
getDefaultPageSize
public int getDefaultPageSize()Description copied from interface:WebPaginationUtilsReturns default page size- Specified by:
getDefaultPageSizein interfaceWebPaginationUtils- Returns:
- default page size
-
getMaxPageSize
public int getMaxPageSize() -
getCurrentPage
Description copied from interface:WebPaginationUtilsReturns current page from map of (request) parameters. Uses WebservicescommonsConstants.CURRENT_PAGE as key.- Specified by:
getCurrentPagein interfaceWebPaginationUtils- Parameters:
params- map of parameters- Returns:
- current page number
-
getStartPosition
Description copied from interface:WebPaginationUtilsCalculates start position for paginated search using vales in map of (request) parameters.- Specified by:
getStartPositionin interfaceWebPaginationUtils- Parameters:
params- map of parameters- Returns:
- start position for query in current request
-
getStartPosition
Description copied from interface:WebPaginationUtilsCalculates 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:
getStartPositionin interfaceWebPaginationUtils- Parameters:
params- map of parametersdefaultPageSize- default page size- Returns:
- start position for query in current request
-
getNeedsTotal
- Specified by:
getNeedsTotalin interfaceWebPaginationUtils
-
buildPagination
Description copied from interface:WebPaginationUtilsExtractsPaginationWsDTOform data in providedSearchResult.- Specified by:
buildPaginationin interfaceWebPaginationUtils- Parameters:
search- SearchResult used to create PaginationWsDTO- Returns:
- Pagination data
-
buildSortData
Description copied from interface:WebPaginationUtilsBuilds list of SortData objects from provided request.- Specified by:
buildSortDatain interfaceWebPaginationUtils- Parameters:
request- request containing sort information- Returns:
- List of sort data object. May be empty but not null.
-
buildSortData
Description copied from interface:WebPaginationUtilsBuilds list of SortData objects from provided request parameter map.- Specified by:
buildSortDatain interfaceWebPaginationUtils- Parameters:
requestParams- map containing sort information- Returns:
- List of sort data object. May be empty but not null.
-
buildSortData
Description copied from interface:WebPaginationUtilsBuilds list of SortData objects from provided string.- Specified by:
buildSortDatain interfaceWebPaginationUtils- Parameters:
sort- string describing sort data- Returns:
- List of sort data object. May be empty but not null.
-
buildPaginationData
Description copied from interface:WebPaginationUtilsBuilds PaginationData based on provided request- Specified by:
buildPaginationDatain interfaceWebPaginationUtils- Parameters:
request- request containing pagination information- Returns:
- PaginationData object. Not null.
-
buildPaginationData
Description copied from interface:WebPaginationUtilsBuilds PaginationData based on provided request parameter map- Specified by:
buildPaginationDatain interfaceWebPaginationUtils- Parameters:
requestParams- map containing pagination information- Returns:
- PaginationData object. Not null.
-
buildPaginationData
Description copied from interface:WebPaginationUtilsBuilds PaginationData based on provided data- Specified by:
buildPaginationDatain interfaceWebPaginationUtils- Parameters:
currentPage- current pagepageSize- size of the page- Returns:
- PaginationData object. Not null.
-
buildPaginationData
Description copied from interface:WebPaginationUtilsBuilds PaginationData based on provided data- Specified by:
buildPaginationDatain interfaceWebPaginationUtils- Parameters:
currentPage- current pagepageSize- size of the page- Returns:
- PaginationData object. Not null.
-
buildSearchPageData
public <RESULT> SearchPageData<RESULT> buildSearchPageData(javax.servlet.http.HttpServletRequest request) Description copied from interface:WebPaginationUtilsBuilds whole SearchPageData object from provided request- Specified by:
buildSearchPageDatain interfaceWebPaginationUtils- Parameters:
request- request containing search page information- Returns:
- SearchPageData object. Not null.
-
buildSearchPageData
Description copied from interface:WebPaginationUtilsBuilds whole SearchPageData object from provided request- Specified by:
buildSearchPageDatain interfaceWebPaginationUtils- Parameters:
requestParams- request parameters map containing search page information- Returns:
- SearchPageData object. Not null.
-
buildSearchPageData
public <RESULT> SearchPageData<RESULT> buildSearchPageData(String sort, int currentPage, int pageSize, boolean needsTotal) Description copied from interface:WebPaginationUtilsBuilds whole SearchPageData object from provided request- Specified by:
buildSearchPageDatain interfaceWebPaginationUtils- Parameters:
sort- String describing list of sorts for this SearchPageDatacurrentPage- current pagepageSize- size of the pageneedsTotal- defines if numberOfPages and totalNumberOfResults in pagination object will be populated.- Returns:
- SearchPageData object. Not null.
-
buildPaginationWsDto
Description copied from interface:WebPaginationUtilsConverts PaginationData into PaginationWsDTO object- Specified by:
buildPaginationWsDtoin interfaceWebPaginationUtils- Parameters:
paginationData- input conversion data- Returns:
- output of conversion. Not null.
-
buildSortWsDto
Description copied from interface:WebPaginationUtilsConverts list of SortData objects into list of SortWsDTO objects.- Specified by:
buildSortWsDtoin interfaceWebPaginationUtils- Parameters:
sortData- list to convert- Returns:
- List of converted objects. Not Null.
-
buildSearchPageWsDto
public <RESULT,INPUT> SearchPageWsDTO<RESULT> buildSearchPageWsDto(SearchPageData<INPUT> searchPage) Description copied from interface:WebPaginationUtilsConverts SearchPageData into SearchPageWsDTO. Results object is ignored during this conversion.- Specified by:
buildSearchPageWsDtoin interfaceWebPaginationUtils- Parameters:
searchPage- data to convert- Returns:
- SearchPageWsDTO object. Not null.
-
buildSearchPageWsDto
public <RESULT,INPUT> SearchPageWsDTO<RESULT> buildSearchPageWsDto(SearchPageData<INPUT> searchPage, Converter<INPUT, RESULT> dataConverter) Description copied from interface:WebPaginationUtilsConverts SearchPageData into SearchPageWsDTO. Results object is converted using provided converter.- Specified by:
buildSearchPageWsDtoin interfaceWebPaginationUtils- Parameters:
searchPage- data to convertdataConverter- converter used for results data conversion.- Returns:
- SearchPageWsDTO object. Not null.
-
setConfigurationService
-
getConfigurationService
-
getPaginationDataConverter
-
setPaginationDataConverter
public void setPaginationDataConverter(Converter<PaginationData, PaginationWsDTO> paginationDataConverter) -
getSortDataConverter
-
setSortDataConverter
-