Interface WebPaginationUtils

All Known Implementing Classes:
DefaultWebPaginationUtils

public interface WebPaginationUtils
Utility class for creating pagination info from web request parameters
  • Method Details

    • getPageSize

      int getPageSize(Map<String,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(Map<String,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(Map<String,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(Map<String,String> params)
    • getStartPosition

      int getStartPosition(Map<String,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(Map<String,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

      List<SortData> buildSortData(javax.servlet.http.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.
    • buildSortData

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

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

      PaginationData buildPaginationData(javax.servlet.http.HttpServletRequest request)
      Builds PaginationData based on provided request
      Parameters:
      request - request containing pagination information
      Returns:
      PaginationData object. Not null.
    • buildPaginationData

      PaginationData buildPaginationData(Map<String,String> requestParams)
      Builds PaginationData based on provided request parameter map
      Parameters:
      requestParams - map 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(javax.servlet.http.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(Map<String,String> requestParams)
      Builds whole SearchPageData object from provided request
      Parameters:
      requestParams - request parameters map containing search page information
      Returns:
      SearchPageData object. Not null.
    • buildSearchPageData

      <RESULT> SearchPageData<RESULT> buildSearchPageData(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

      List<SortWsDTO> buildSortWsDto(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.