1 /*
2 * Copyright (c) 2002-2018, Mairie de 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.plugins.directory.modules.multiview.web.record.filter.display;
35
36 import java.util.ArrayList;
37 import java.util.Collections;
38 import java.util.List;
39
40 import javax.servlet.http.HttpServletRequest;
41
42 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.IRecordFilter;
43 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.configuration.RecordFilterConfiguration;
44 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.factory.IRecordFilterDisplayFactory;
45 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.factory.RecordFilterDisplayFactoryFacade;
46 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.util.RecordListPositionComparator;
47
48 /**
49 * Factory for RecordFilterDisplay objects
50 */
51 public class RecordFilterDisplayFactory
52 {
53 /**
54 * Return the list of all RecordFilterDisplay ordered by their position
55 *
56 * @param request
57 * The HttpServletRequest used to create the list of all RecordFilterDisplay
58 * @param listRecordFilter
59 * The list of IRecordFilter used for building IRecordFilterDisplay
60 * @return the list of all RecordFilterDisplay ordered by their position
61 */
62 public List<IRecordFilterDisplay> createRecordFilterDisplayList( HttpServletRequest request, List<IRecordFilter> listRecordFilter )
63 {
64 List<IRecordFilterDisplay> listRecordFilterDisplay = new ArrayList<>( );
65 List<IRecordFilterDisplayFactory> listRecordFilterDisplayFactory = new RecordFilterDisplayFactoryFacade( ).buildRecordFilterDisplayFactoryList( );
66
67 if ( listRecordFilter != null && !listRecordFilter.isEmpty( ) && listRecordFilterDisplayFactory != null && !listRecordFilterDisplayFactory.isEmpty( ) )
68 {
69 for ( IRecordFilter recordFilter : listRecordFilter )
70 {
71 IRecordFilterDisplay recordFilterDisplay = null;
72 for ( IRecordFilterDisplayFactory recordFilterDisplayFactory : listRecordFilterDisplayFactory )
73 {
74 recordFilterDisplay = recordFilterDisplayFactory.buildFilterDisplay( recordFilter );
75 if ( recordFilterDisplay != null )
76 {
77 manageRecordFilterDisplay( request, recordFilter, recordFilterDisplay );
78
79 listRecordFilterDisplay.add( recordFilterDisplay );
80 break;
81 }
82 }
83 }
84
85 // Sort the list by the position of each elements
86 Collections.sort( listRecordFilterDisplay, new RecordListPositionComparator( ) );
87 }
88
89 return listRecordFilterDisplay;
90 }
91
92 /**
93 * Create the RecordFilterItem for the given RecordFilterDisplay and set is position from the given RecordFilter
94 *
95 * @param request
96 * The request used to build the RecordFilterItem of the RecordFilterDisplay
97 * @param recordFilter
98 * The RecordFilter used to retrieve the position of the RecordFilterDisplay
99 * @param recordFilterDisplay
100 * The RecordFilterDisplay from which the RecordFilterItem must be created
101 */
102 private void manageRecordFilterDisplay( HttpServletRequest request, IRecordFilter recordFilter, IRecordFilterDisplay recordFilterDisplay )
103 {
104 recordFilterDisplay.createRecordParameters( request );
105
106 RecordFilterConfiguration recordFilterConfiguration = recordFilter.getRecordFilterConfiguration( );
107 if ( recordFilterConfiguration != null )
108 {
109 recordFilterDisplay.setPosition( recordFilterConfiguration.getPosition( ) );
110 }
111 }
112 }