View Javadoc
1   /*
2    * Copyright (c) 2002-2023, 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.plugins.forms.modules.cartography.service;
35  
36  import fr.paris.lutece.plugins.carto.business.MapTemplate;
37  import fr.paris.lutece.plugins.carto.business.MapTemplateHome;
38  import fr.paris.lutece.plugins.cartography.modules.solr.service.CartographyService;
39  import fr.paris.lutece.plugins.forms.business.form.column.IFormColumn;
40  import fr.paris.lutece.plugins.forms.business.form.column.impl.FormColumnEntryCartography;
41  import fr.paris.lutece.plugins.forms.util.FormsConstants;
42  import fr.paris.lutece.plugins.forms.web.entrytype.DisplayType;
43  import fr.paris.lutece.plugins.forms.web.entrytype.IEntryDisplayService;
44  import fr.paris.lutece.plugins.genericattributes.business.Entry;
45  import fr.paris.lutece.plugins.genericattributes.business.Field;
46  import fr.paris.lutece.plugins.genericattributes.service.entrytype.EntryTypeServiceManager;
47  import fr.paris.lutece.plugins.genericattributes.service.entrytype.IEntryTypeService;
48  
49  import java.util.Locale;
50  import java.util.Map;
51  import java.util.Optional;
52  
53  import javax.servlet.http.HttpServletRequest;
54  
55  import org.apache.commons.lang3.StringUtils;
56  
57  import fr.paris.lutece.portal.service.template.AppTemplateService;
58  
59  /**
60   * The default display service
61   */
62  public class EntryTypeCartographyDisplayService implements IEntryDisplayService
63  {
64      private static final String MARK_ENTRY_TYPE_SERVICE = "entryTypeService";
65      private String _strEntryServiceName = StringUtils.EMPTY;
66  
67      /**
68       * Constructor of the EntryTypeDefaultDisplayService
69       * 
70       * @param strEntryServiceName
71       *            The entry service name
72       */
73      public EntryTypeCartographyDisplayService( String strEntryServiceName )
74      {
75          _strEntryServiceName = strEntryServiceName;
76      }
77  
78      /**
79       * Return the completed model
80       * 
81       * @param entry
82       *            The given entry
83       * @param model
84       *            The given model
85       * @return the completed model
86       */
87      private Map<String, Object> setModel( Entry entry, Map<String, Object> model )
88      {
89          model.put( FormsConstants.QUESTION_ENTRY_MARKER, entry );
90          Field mapProvider = entry.getFieldByCode( "provider" );
91  
92          // Charger map
93          Optional<MapTemplate> map = MapTemplateHome.findByPrimaryKey( Integer.valueOf( mapProvider.getValue( ) ) );
94  
95          if ( map.isPresent( ) )
96          {
97              CartographyService.loadMapAndPoints( map.get( ), model );
98          }
99  
100         return model;
101     }
102 
103     /**
104      * {@inheritDoc}
105      */
106     @Override
107     public String getDisplayServiceName( )
108     {
109         return _strEntryServiceName;
110     }
111 
112     /**
113      * {@inheritDoc}
114      */
115     @Override
116     public String getEntryTemplateDisplay( HttpServletRequest request, Entry entry, Locale locale, Map<String, Object> model, DisplayType displayType )
117     {
118         String strEntryHtml = StringUtils.EMPTY;
119         IEntryTypeService service = EntryTypeServiceManager.getEntryTypeService( entry );
120 
121         switch( displayType.getMode( ) )
122         {
123             case EDITION:
124                 strEntryHtml = AppTemplateService.getTemplate( service.getTemplateHtmlForm( entry, displayType.isFront( ) ), locale, setModel( entry, model ) )
125                         .getHtml( );
126                 break;
127             case READONLY:
128                 model.put( MARK_ENTRY_TYPE_SERVICE, service );
129                 strEntryHtml = AppTemplateService.getTemplate( service.getTemplateEntryReadOnly( displayType.isFront( ) ), locale, setModel( entry, model ) )
130                         .getHtml( );
131                 break;
132             default: // Nothing to do
133         }
134 
135         return strEntryHtml;
136     }
137 
138     /**
139      * Get the form column
140      * 
141      * @param nFormColumnPosition
142      * @param strColumnTitle
143      * @param listEntryTitle
144      * @return The form column
145      */
146     @Override
147     public IFormColumn getFormColumn( int nFormColumnPosition, String strColumnTitle )
148     {
149         return new FormColumnEntryCartography( nFormColumnPosition, strColumnTitle );
150     }
151 
152 }