View Javadoc
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.column.display.impl;
35  
36  import java.util.LinkedHashMap;
37  import java.util.Locale;
38  import java.util.Map;
39  
40  import org.apache.commons.lang3.StringUtils;
41  import org.apache.commons.lang3.math.NumberUtils;
42  
43  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.IRecordColumn;
44  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.RecordColumnCell;
45  import fr.paris.lutece.plugins.directory.modules.multiview.util.RecordEntryNameConstants;
46  import fr.paris.lutece.portal.service.template.AppTemplateService;
47  
48  /**
49   * Implementation of the IRecordColumnDisplay for the Entry column
50   */
51  public class RecordColumnDisplayEntry extends AbstractRecordColumnDisplay
52  {
53      // Templates
54      private static final String RECORD_COLUMN_HEADER_TEMPLATE = "admin/plugins/directory/modules/multiview/column/header/record_column_entry_header.html";
55      private static final String RECORD_COLUMN_CELL_TEMPLATE = "admin/plugins/directory/modules/multiview/column/cell/record_column_entry_cell.html";
56  
57      // Marks
58      private static final String MARK_ENTRY_VALUE_COLUMN_TITLE = "column_title";
59      private static final String MARK_ENTRY_VALUE_COLUMN_POSITION = "entry_column_position";
60      private static final String MARK_ENTRY_VALUE = "entry_value";
61  
62      /**
63       * {@inheritDoc}
64       */
65      @Override
66      public String buildRecordColumnHeaderTemplate( String strSortUrl, Locale locale )
67      {
68          Map<String, Object> model = new LinkedHashMap<>( );
69          model.put( MARK_ENTRY_VALUE_COLUMN_TITLE, getRecordColumnTitle( ) );
70          model.put( MARK_ENTRY_VALUE_COLUMN_POSITION, getPosition( ) );
71  
72          String strColumnHeaderTemplate = AppTemplateService.getTemplate( RECORD_COLUMN_HEADER_TEMPLATE, locale, model ).getHtml( );
73          setRecordColumnHeaderTemplate( strColumnHeaderTemplate );
74  
75          return strColumnHeaderTemplate;
76      }
77  
78      /**
79       * {@inheritDoc}
80       */
81      @Override
82      public String buildRecordColumnCellTemplate( RecordColumnCell recordColumnCell, Locale locale )
83      {
84          String strEntryValue = StringUtils.EMPTY;
85          if ( recordColumnCell != null )
86          {
87              String strEntryValueName = String.format( RecordEntryNameConstants.COLUMN_ENTRY_VALUE_PATTERN, getRecordColumnPosition( ) );
88              Object objEntryValue = recordColumnCell.getRecordColumnCellValueByName( strEntryValueName );
89              if ( objEntryValue != null )
90              {
91                  strEntryValue = String.valueOf( objEntryValue );
92              }
93          }
94  
95          Map<String, Object> model = new LinkedHashMap<>( );
96          model.put( MARK_ENTRY_VALUE, strEntryValue );
97  
98          String strRecordColumnEntryTemplate = AppTemplateService.getTemplate( RECORD_COLUMN_CELL_TEMPLATE, locale, model ).getHtml( );
99  
100         return strRecordColumnEntryTemplate;
101     }
102 
103     /**
104      * Return the position of the RecordColumn or NumberUtils.INTEGER_MINUS_ONE if doesn't exist
105      * 
106      * @return the position of the RecordColumn
107      */
108     private int getRecordColumnPosition( )
109     {
110         int nRecordColumnPosition = NumberUtils.INTEGER_MINUS_ONE;
111         IRecordColumn recordColumn = getRecordColumn( );
112         if ( recordColumn != null )
113         {
114             nRecordColumnPosition = recordColumn.getRecordColumnPosition( );
115         }
116 
117         return nRecordColumnPosition;
118     }
119 }