View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.document.business.portlet;
35  
36  import fr.paris.lutece.portal.service.util.AppPropertiesService;
37  
38  import org.apache.commons.lang3.StringUtils;
39  
40  
41  /**
42   * PortletOrder
43   */
44  public class PortletOrder
45  {
46      // CONSTANTS
47      public static final int DATE_UPDATE_PORTLET = AppPropertiesService.getPropertyInt( "document.order.date_update_portlet",
48              0 );
49      public static final int PAGE_NAME = AppPropertiesService.getPropertyInt( "document.order.page_name", 1 );
50      public static final int PAGE_ID = AppPropertiesService.getPropertyInt( "document.order.page_id", 2 );
51      public static final int PORTLET_NAME = AppPropertiesService.getPropertyInt( "document.order.portlet_name", 3 );
52      public static final int SORT_ASC = AppPropertiesService.getPropertyInt( "document.order.asc", 1 );
53      private static final String SQL_ORDER_BY_PAGE_NAME = " ORDER BY f.name ";
54      private static final String SQL_ORDER_BY_PAGE_ID = " ORDER BY a.id_page ";
55      private static final String SQL_ORDER_BY_PORTLET_NAME = " ORDER BY a.name ";
56      private static final String SQL_ORDER_BY_DATE_UPDATE_PORTLET = " ORDER BY a.date_update ";
57      private static final String SQL_ASC = " ASC ";
58      private static final String SQL_DESC = " DESC ";
59  
60      // VARIABLES
61      private boolean _bSortAsc;
62      private int _nTypeOrder;
63  
64      /**
65       * Constructor
66       */
67      public PortletOrder(  )
68      {
69          _bSortAsc = false;
70          _nTypeOrder = DATE_UPDATE_PORTLET;
71      }
72  
73      /**
74       * Constructor
75       * @param bSortAsc true if it must be sorted ascendingly, false otherwise
76       * @param nTypeOrder the order type
77       */
78      public PortletOrder( boolean bSortAsc, int nTypeOrder )
79      {
80          _bSortAsc = bSortAsc;
81          _nTypeOrder = nTypeOrder;
82      }
83  
84      /**
85       * Set the way of sorting the portlets
86       * @param bSortAsc true if it must be sorted ascendingly, false otherwise
87       */
88      public void setSortAsc( boolean bSortAsc )
89      {
90          _bSortAsc = bSortAsc;
91      }
92  
93      /**
94       * Return true if it must be sorted ascendingly, false otherwise
95       * @return true if it must be sorted ascendingly, false otherwise
96       */
97      public boolean isSortAsc(  )
98      {
99          return _bSortAsc;
100     }
101 
102     /**
103      * Set the order type
104      * @param nTypeOrder the order type
105      */
106     public void setTypeOrder( int nTypeOrder )
107     {
108         _nTypeOrder = nTypeOrder;
109     }
110 
111     /**
112      * Get the order type
113      * @return the order type
114      */
115     public int getTypeOrder(  )
116     {
117         return _nTypeOrder;
118     }
119 
120     /**
121      * Get the SQL query for ordering the portlet
122      * @return the SQL query
123      */
124     public String getSQLOrderBy(  )
125     {
126         StringBuilder sbSQL = new StringBuilder(  );
127 
128         if ( _nTypeOrder == PAGE_NAME )
129         {
130             sbSQL.append( SQL_ORDER_BY_PAGE_NAME );
131         }
132         else if ( _nTypeOrder == PAGE_ID )
133         {
134             sbSQL.append( SQL_ORDER_BY_PAGE_ID );
135         }
136         else if ( _nTypeOrder == PORTLET_NAME )
137         {
138             sbSQL.append( SQL_ORDER_BY_PORTLET_NAME );
139         }
140         else if ( _nTypeOrder == DATE_UPDATE_PORTLET )
141         {
142             sbSQL.append( SQL_ORDER_BY_DATE_UPDATE_PORTLET );
143         }
144 
145         if ( StringUtils.isNotBlank( sbSQL.toString(  ) ) )
146         {
147             sbSQL.append( _bSortAsc ? SQL_ASC : SQL_DESC );
148         }
149 
150         return sbSQL.toString(  );
151     }
152 }