1 /*
2 * Copyright (c) 2002-2022, 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.resource.business.database;
35
36 /**
37 * Database resource sort DTO
38 */
39 public final class DatabaseResourceSort
40 {
41 private static final String SORT_COLUMN_ID = "id_resource";
42 private static final String SORT_COLUMN_RESOURCE_TYPE = "resource_type";
43 private static final String SORT_COLUMN_RESOURCE_NAME = "resource_name";
44 private static final DatabaseResourceSortss/database/DatabaseResourceSort.html#DatabaseResourceSort">DatabaseResourceSort DEFAULT_SORT = new DatabaseResourceSort( SORT_COLUMN_ID, true );
45 private String _strSort;
46 private boolean _bSortAsc;
47
48 /**
49 * Creates a new database resource sort
50 *
51 * @param strSort
52 * The sort
53 * @param bSortAsc
54 * True to sort ascending, false otherwise
55 */
56 private DatabaseResourceSort( String strSort, boolean bSortAsc )
57 {
58 this._strSort = strSort;
59 this._bSortAsc = bSortAsc;
60 }
61
62 /**
63 * Get the sort column name
64 *
65 * @return The sort column name
66 */
67 public String getSort( )
68 {
69 return _strSort;
70 }
71
72 /**
73 * Check if the sort should be ascending or descending
74 *
75 * @return True to sort ascending, false otherwise
76 */
77 public boolean getSortAsc( )
78 {
79 return _bSortAsc;
80 }
81
82 /**
83 * Get a sort from a column name
84 *
85 * @param strSort
86 * The sort to get
87 * @param bSortAsc
88 * True to sort ascending, false otherwise
89 * @return The sort, or the default sort if the specified one does not match any of the columns
90 */
91 public static DatabaseResourceSort getDatabaseResourceSort( String strSort, boolean bSortAsc )
92 {
93 if ( SORT_COLUMN_ID.equals( strSort ) || SORT_COLUMN_RESOURCE_TYPE.equals( strSort ) || SORT_COLUMN_RESOURCE_NAME.equals( strSort ) )
94 {
95 return new DatabaseResourceSort( strSort, bSortAsc );
96 }
97
98 return DEFAULT_SORT;
99 }
100 }