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 package fr.paris.lutece.util.html;
35
36 import java.util.ArrayList;
37 import java.util.List;
38
39 /**
40 * Paginator provides a way to display a collection of items on severals pages. <strong>This implementation requires all items</strong>
41 *
42 * @param <E>
43 * Item of the list
44 */
45 public class Paginator<E> extends AbstractPaginator<E>
46 {
47 private static final long serialVersionUID = 1531851701326259139L;
48
49 /**
50 * Creates a new instance of Paginator
51 *
52 * @param list
53 * The collection to paginate
54 * @param nItemPerPage
55 * Number of items to display per page
56 * @param strBaseUrl
57 * The base Url for build links on each page link
58 * @param strPageIndexParameterName
59 * The parameter name for the page index
60 * @param strPageIndex
61 * The current page index
62 */
63 public Paginator( List<E> list, int nItemPerPage, String strBaseUrl, String strPageIndexParameterName, String strPageIndex )
64 {
65 _list = list;
66 _nItemsCount = _list.size( );
67 _nItemPerPage = ( nItemPerPage <= 0 ) ? 1 : nItemPerPage;
68 _strBaseUrl = strBaseUrl;
69 _strPageIndexParameterName = strPageIndexParameterName;
70 _strItemsPerPageParameterName = PARAMETER_ITEMS_PER_PAGE;
71
72 try
73 {
74 _nPageCurrent = Integer.parseInt( strPageIndex );
75 }
76 catch( NumberFormatException e )
77 {
78 // strPageIndex invalid, use 1 as default page index.
79 _nPageCurrent = 1;
80 }
81
82 if ( _nPageCurrent > getPagesCount( ) )
83 {
84 _nPageCurrent = 1;
85 }
86 }
87
88 /**
89 * Creates a new instance of Paginator
90 *
91 * @param list
92 * The collection to paginate
93 * @param nItemPerPage
94 * Number of items to display per page
95 * @param strBaseUrl
96 * The base Url for build links on each page link
97 * @param strPageIndexParameterName
98 * The parameter name for the page index
99 * @param strPageIndex
100 * The current page index
101 * @param strItemsPerPageParameterName
102 * The parameter name of the number items per page
103 */
104 public Paginator( List<E> list, int nItemPerPage, String strBaseUrl, String strPageIndexParameterName, String strPageIndex,
105 String strItemsPerPageParameterName )
106 {
107 this( list, nItemPerPage, strBaseUrl, strPageIndexParameterName, strPageIndex );
108 _strItemsPerPageParameterName = strItemsPerPageParameterName;
109 }
110
111 /**
112 * {@inheritDoc}
113 */
114 @Override
115 public List<E> getPageItems( )
116 {
117 int nStartIndex = ( _nPageCurrent - 1 ) * _nItemPerPage;
118 int nMax = _nItemsCount;
119 int nMaxPage = nStartIndex + _nItemPerPage;
120
121 if ( nMaxPage < nMax )
122 {
123 nMax = nMaxPage;
124 }
125
126 List<E> list = new ArrayList<>( );
127
128 for ( int i = nStartIndex; i < nMax; i++ )
129 {
130 list.add( _list.get( i ) );
131 }
132
133 return list;
134 }
135 }