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.panel.initializer.querypart.impl;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  
39  import org.apache.commons.lang3.StringUtils;
40  
41  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.RecordParameters;
42  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.panel.initializer.querypart.IRecordPanelInitializerQueryPart;
43  
44  /**
45   * Abstract class for the implementation of the IRecordPanelQueryPart
46   */
47  public abstract class AbstractRecordPanelInitializerQueryPart implements IRecordPanelInitializerQueryPart
48  {
49      // Variables
50      private String _strRecordPanelInitializerSelectQuery = StringUtils.EMPTY;
51      private String _strRecordPanelInitializerFromQuery = StringUtils.EMPTY;
52      private List<String> _listRecordPanelInitializerJoinQueries = new ArrayList<>( );
53  
54      /**
55       * {@inheritDoc}
56       */
57      @Override
58      public abstract void buildRecordPanelInitializerQuery( RecordParameters recordParameters );
59  
60      /**
61       * {@inheritDoc}
62       */
63      @Override
64      public String getRecordPanelInitializerSelectQuery( )
65      {
66          return _strRecordPanelInitializerSelectQuery;
67      }
68  
69      /**
70       * Set the select query part of the RecordPanelInitializer
71       * 
72       * @param strRecordPanelInitializerSelectQuery
73       *            The select query part of the RecordPanelInitializer
74       */
75      protected void setRecordPanelInitializerSelectQuery( String strRecordPanelInitializerSelectQuery )
76      {
77          _strRecordPanelInitializerSelectQuery = strRecordPanelInitializerSelectQuery;
78      }
79  
80      /**
81       * {@inheritDoc}
82       */
83      @Override
84      public String getRecordPanelInitializerFromQuery( )
85      {
86          return _strRecordPanelInitializerFromQuery;
87      }
88  
89      /**
90       * Set the From query part of the RecordPanelInitializer
91       * 
92       * @param strRecordPanelInitializerFromQuery
93       *            The from query part of the RecordPanelInitializer to set
94       */
95      protected void setRecordPanelInitializerFromQuery( String strRecordPanelInitializerFromQuery )
96      {
97          _strRecordPanelInitializerFromQuery = strRecordPanelInitializerFromQuery;
98      }
99  
100     /**
101      * {@inheritDoc}
102      */
103     @Override
104     public List<String> getRecordPanelInitializerJoinQueries( )
105     {
106         return _listRecordPanelInitializerJoinQueries;
107     }
108 
109     /**
110      * Set the list of all join query parts of the RecordPanelInitializer
111      * 
112      * @param listRecordPanelInitializerJoinQueries
113      *            The list of all join query parts of RecordPanelInitializer
114      */
115     protected void setRecordPanelInitializerJoinQueriesList( List<String> listRecordPanelInitializerJoinQueries )
116     {
117         _listRecordPanelInitializerJoinQueries = listRecordPanelInitializerJoinQueries;
118     }
119 }