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.business.record.column.querypart.impl;
35  
36  import java.util.LinkedHashMap;
37  import java.util.List;
38  import java.util.Map;
39  
40  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.IRecordColumn;
41  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.RecordColumnCell;
42  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.querypart.IRecordColumnQueryPart;
43  import fr.paris.lutece.util.sql.DAOUtil;
44  
45  /**
46   * Abstract class for RecordColumnQueryPart
47   */
48  public abstract class AbstractRecordColumnQueryPart implements IRecordColumnQueryPart
49  {
50      // Variables
51      private IRecordColumn _recordColumn;
52  
53      /**
54       * {@inheritDoc}
55       */
56      @Override
57      public abstract String getRecordColumnSelectQuery( );
58  
59      /**
60       * {@inheritDoc}
61       */
62      @Override
63      public abstract String getRecordColumnFromQuery( );
64  
65      /**
66       * {@inheritDoc}
67       */
68      @Override
69      public abstract List<String> getRecordColumnJoinQueries( );
70  
71      /**
72       * Build the map of RecordColumnValues for the Record column of the query part
73       * 
74       * @param daoUtil
75       *            The daoUtil to use to retrieve the data of the record column
76       * @return the map of RecordColumnValues for the Record column of the query part
77       */
78      protected abstract Map<String, Object> getMapRecordColumnValues( DAOUtil daoUtil );
79  
80      /**
81       * {@inheritDoc}
82       */
83      @Override
84      public void setRecordColumn( IRecordColumn recordColumn )
85      {
86          _recordColumn = recordColumn;
87      }
88  
89      /**
90       * {@inheritDoc}
91       */
92      @Override
93      public IRecordColumn getRecordColumn( )
94      {
95          return _recordColumn;
96      }
97  
98      /**
99       * {@inheritDoc}
100      */
101     @Override
102     public RecordColumnCell getRecordColumnCell( DAOUtil daoUtil )
103     {
104         Map<String, Object> mapRecordColumnValues = new LinkedHashMap<>( );
105 
106         IRecordColumn recordColumn = getRecordColumn( );
107         if ( recordColumn != null )
108         {
109             mapRecordColumnValues = getMapRecordColumnValues( daoUtil );
110         }
111 
112         RecordColumnCell recordColumnCell = new RecordColumnCell( );
113         recordColumnCell.setRecordColumnCellValues( mapRecordColumnValues );
114 
115         return recordColumnCell;
116     }
117 }