1 /**
2 * This file Copyright (c) 2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.admincentral.findbar.search;
35
36 import info.magnolia.periscope.search.SearchResultSupplier;
37
38 import java.util.HashMap;
39 import java.util.List;
40 import java.util.Map;
41 import java.util.Optional;
42
43 import lombok.extern.slf4j.Slf4j;
44
45 /**
46 * Sorting utility that bases target order based on another list, and falls back to a deterministic intrinsic
47 * order otherwise.
48 */
49 @Slf4j
50 public class SupplierSorter {
51
52 private final Map<String, Integer> baseListIndex;
53
54 public SupplierSorter(List<String> baseList) {
55 this.baseListIndex = new HashMap<>();
56 for (int i = 0; i < baseList.size(); i++) {
57 if (this.baseListIndex.containsKey(baseList.get(i))) {
58 log.warn("Duplicate entries in supplier order base list found");
59 continue;
60 }
61
62 this.baseListIndex.put(baseList.get(i), i);
63 }
64 }
65
66 public void sort(List<SearchResultSupplier> suppliers) {
67 suppliers.sort((a, b) -> {
68 Optional<Integer> indexA = Optional.ofNullable(baseListIndex.get(a.getName()));
69 Optional<Integer> indexB = Optional.ofNullable(baseListIndex.get(b.getName()));
70
71 if (indexA.isPresent() || indexB.isPresent()) {
72 // fall back to list size, so we sort non-configured items after configured ones
73 return indexA.orElse(baseListIndex.size()) - indexB.orElse(baseListIndex.size());
74 }
75
76 return compareFallback(a, b);
77 });
78 }
79
80 private int compareFallback(SearchResultSupplier a, SearchResultSupplier b) {
81 return a.getName().compareTo(b.getName());
82 }
83 }