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 Details

    • DefaultWebPaginationUtils

      public DefaultWebPaginationUtils()
  • Method Details

    • 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
    • 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
    • getNeedsTotal

      public boolean getNeedsTotal(Map<String,String> requestParams)
      Specified by:
      getNeedsTotal in interface WebPaginationUtils
    • 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
    • buildSortData

      public List<SortData> buildSortData(javax.servlet.http.HttpServletRequest request)
      Description copied from interface: WebPaginationUtils
      Builds list of SortData objects from provided request.
      Specified by:
      buildSortData in interface WebPaginationUtils
      Parameters:
      request - request containing sort information
      Returns:
      List of sort data object. May be empty but not null.
    • buildSortData

      public List<SortData> buildSortData(Map<String,String> requestParams)
      Description copied from interface: WebPaginationUtils
      Builds list of SortData objects from provided request parameter map.
      Specified by:
      buildSortData in interface WebPaginationUtils
      Parameters:
      requestParams - map containing sort information
      Returns:
      List of sort data object. May be empty but not null.
    • buildSortData

      public List<SortData> buildSortData(String sort)
      Description copied from interface: WebPaginationUtils
      Builds list of SortData objects from provided string.
      Specified by:
      buildSortData in interface WebPaginationUtils
      Parameters:
      sort - string describing sort data
      Returns:
      List of sort data object. May be empty but not null.
    • buildPaginationData

      public PaginationData buildPaginationData(javax.servlet.http.HttpServletRequest request)
      Description copied from interface: WebPaginationUtils
      Builds PaginationData based on provided request
      Specified by:
      buildPaginationData in interface WebPaginationUtils
      Parameters:
      request - request containing pagination information
      Returns:
      PaginationData object. Not null.
    • buildPaginationData

      public PaginationData buildPaginationData(Map<String,String> requestParams)
      Description copied from interface: WebPaginationUtils
      Builds PaginationData based on provided request parameter map
      Specified by:
      buildPaginationData in interface WebPaginationUtils
      Parameters:
      requestParams - map containing pagination information
      Returns:
      PaginationData object. Not null.
    • buildPaginationData

      public PaginationData buildPaginationData(int currentPage, int pageSize)
      Description copied from interface: WebPaginationUtils
      Builds PaginationData based on provided data
      Specified by:
      buildPaginationData in interface WebPaginationUtils
      Parameters:
      currentPage - current page
      pageSize - size of the page
      Returns:
      PaginationData object. Not null.
    • buildPaginationData

      public PaginationData buildPaginationData(int currentPage, int pageSize, boolean needsTotal)
      Description copied from interface: WebPaginationUtils
      Builds PaginationData based on provided data
      Specified by:
      buildPaginationData in interface WebPaginationUtils
      Parameters:
      currentPage - current page
      pageSize - size of the page
      Returns:
      PaginationData object. Not null.
    • buildSearchPageData

      public <RESULT> SearchPageData<RESULT> buildSearchPageData(javax.servlet.http.HttpServletRequest request)
      Description copied from interface: WebPaginationUtils
      Builds whole SearchPageData object from provided request
      Specified by:
      buildSearchPageData in interface WebPaginationUtils
      Parameters:
      request - request containing search page information
      Returns:
      SearchPageData object. Not null.
    • buildSearchPageData

      public <RESULT> SearchPageData<RESULT> buildSearchPageData(Map<String,String> requestParams)
      Description copied from interface: WebPaginationUtils
      Builds whole SearchPageData object from provided request
      Specified by:
      buildSearchPageData in interface WebPaginationUtils
      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: WebPaginationUtils
      Builds whole SearchPageData object from provided request
      Specified by:
      buildSearchPageData in interface WebPaginationUtils
      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

      public PaginationWsDTO buildPaginationWsDto(PaginationData paginationData)
      Description copied from interface: WebPaginationUtils
      Converts PaginationData into PaginationWsDTO object
      Specified by:
      buildPaginationWsDto in interface WebPaginationUtils
      Parameters:
      paginationData - input conversion data
      Returns:
      output of conversion. Not null.
    • buildSortWsDto

      public List<SortWsDTO> buildSortWsDto(List<SortData> sortData)
      Description copied from interface: WebPaginationUtils
      Converts list of SortData objects into list of SortWsDTO objects.
      Specified by:
      buildSortWsDto in interface WebPaginationUtils
      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: WebPaginationUtils
      Converts SearchPageData into SearchPageWsDTO. Results object is ignored during this conversion.
      Specified by:
      buildSearchPageWsDto in interface WebPaginationUtils
      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: WebPaginationUtils
      Converts SearchPageData into SearchPageWsDTO. Results object is converted using provided converter.
      Specified by:
      buildSearchPageWsDto in interface WebPaginationUtils
      Parameters:
      searchPage - data to convert
      dataConverter - converter used for results data conversion.
      Returns:
      SearchPageWsDTO object. Not null.
    • setConfigurationService

      public void setConfigurationService(ConfigurationService configurationService)
    • getConfigurationService

      public ConfigurationService getConfigurationService()
    • getPaginationDataConverter

      public Converter<PaginationData,PaginationWsDTO> getPaginationDataConverter()
    • setPaginationDataConverter

      public void setPaginationDataConverter(Converter<PaginationData,PaginationWsDTO> paginationDataConverter)
    • getSortDataConverter

      public Converter<SortData,SortWsDTO> getSortDataConverter()
    • setSortDataConverter

      public void setSortDataConverter(Converter<SortData,SortWsDTO> sortDataConverter)