1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34
35 package fr.paris.lutece.plugins.plugin.modules.sample.web;
36
37 import fr.paris.lutece.portal.service.util.AppPropertiesService;
38 import fr.paris.lutece.portal.util.mvc.admin.MVCAdminJspBean;
39 import fr.paris.lutece.portal.web.util.LocalizedPaginator;
40 import fr.paris.lutece.util.html.AbstractPaginator;
41 import fr.paris.lutece.util.url.UrlItem;
42
43 import java.util.List;
44 import java.util.Map;
45 import javax.servlet.http.HttpServletRequest;
46
47 /**
48 * ManageSample JSP Bean abstract class for JSP Bean
49 */
50 public abstract class AbstractManageSampleJspBean <S, T> extends MVCAdminJspBean
51 {
52 // Rights
53 public static final String RIGHT_MANAGESAMPLE = "PLUGIN_SAMPLE_MANAGEMENT";
54
55 // Properties
56 private static final String PROPERTY_DEFAULT_LIST_ITEM_PER_PAGE = "plugin-sample.listItems.itemsPerPage";
57
58 // Parameters
59 private static final String PARAMETER_PAGE_INDEX = "page_index";
60
61 // Markers
62 private static final String MARK_PAGINATOR = "paginator";
63 private static final String MARK_NB_ITEMS_PER_PAGE = "nb_items_per_page";
64
65 //Variables
66 private String _strCurrentPageIndex;
67 private int _nItemsPerPage;
68
69 /**
70 * Return a model that contains the list and paginator infos
71 * @param request The HTTP request
72 * @param strBookmark The bookmark
73 * @param list The list of item
74 * @param strManageJsp The JSP
75 * @return The model
76 */
77 protected <T> Map<String, Object> getPaginatedListModel( HttpServletRequest request, String strBookmark, List<S> list,
78 String strManageJsp )
79 {
80 int nDefaultItemsPerPage = AppPropertiesService.getPropertyInt( PROPERTY_DEFAULT_LIST_ITEM_PER_PAGE, 50 );
81 _strCurrentPageIndex = AbstractPaginator.getPageIndex( request, AbstractPaginator.PARAMETER_PAGE_INDEX, _strCurrentPageIndex );
82 _nItemsPerPage = AbstractPaginator.getItemsPerPage( request, AbstractPaginator.PARAMETER_ITEMS_PER_PAGE, _nItemsPerPage, nDefaultItemsPerPage );
83
84 UrlItem url = new UrlItem( strManageJsp );
85 String strUrl = url.getUrl( );
86
87 // PAGINATOR
88 LocalizedPaginator<S> paginator = new LocalizedPaginator<>( list, _nItemsPerPage, strUrl, PARAMETER_PAGE_INDEX, _strCurrentPageIndex, getLocale( ) );
89
90 Map<String, Object> model = getModel( );
91
92 model.put( MARK_NB_ITEMS_PER_PAGE, String.valueOf( _nItemsPerPage ) );
93 model.put( MARK_PAGINATOR, paginator );
94 model.put( strBookmark, getItemsFromIds ( paginator.getPageItems( ) ) );
95
96 return model;
97 }
98
99 /**
100 * Get Items from Ids list
101 * @param <T>
102 *
103 * @param <S> the generic type of the Ids
104 * @param <T> the generic type of the items
105 * @param <S>
106 * @param listIds
107 * @return the populated list of items corresponding to the id List
108 */
109 abstract List<T> getItemsFromIds ( List<S> listIds ) ;
110 }