1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.gui.dialogs.relation.sort;
|
---|
3 |
|
---|
4 | import java.util.ArrayList;
|
---|
5 | import java.util.Arrays;
|
---|
6 | import java.util.Collection;
|
---|
7 | import java.util.Comparator;
|
---|
8 | import java.util.HashMap;
|
---|
9 | import java.util.LinkedHashMap;
|
---|
10 | import java.util.LinkedList;
|
---|
11 | import java.util.List;
|
---|
12 | import java.util.Map;
|
---|
13 | import java.util.Map.Entry;
|
---|
14 | import java.util.stream.Collectors;
|
---|
15 |
|
---|
16 | import org.openstreetmap.josm.data.osm.DefaultNameFormatter;
|
---|
17 | import org.openstreetmap.josm.data.osm.OsmPrimitive;
|
---|
18 | import org.openstreetmap.josm.data.osm.Relation;
|
---|
19 | import org.openstreetmap.josm.data.osm.RelationMember;
|
---|
20 | import org.openstreetmap.josm.tools.AlphanumComparator;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * This class sorts the relation members by connectivity.
|
---|
24 | * <p>
|
---|
25 | * Multiple {@link AdditionalSorter}s are implemented to handle special relation types.
|
---|
26 | */
|
---|
27 | public class RelationSorter {
|
---|
28 |
|
---|
29 | private interface AdditionalSorter {
|
---|
30 | boolean acceptsMember(List<RelationMember> relationMembers, RelationMember m);
|
---|
31 |
|
---|
32 | List<RelationMember> sortMembers(List<RelationMember> list);
|
---|
33 | }
|
---|
34 |
|
---|
35 | private static final Collection<AdditionalSorter> ADDITIONAL_SORTERS = Arrays.asList(
|
---|
36 | // first adequate sorter is used, so order matters
|
---|
37 | new AssociatedStreetRoleStreetSorter(),
|
---|
38 | new AssociatedStreetRoleAddressHouseSorter(),
|
---|
39 | new PublicTransportRoleStopPlatformSorter(),
|
---|
40 | new FromViaToSorter()
|
---|
41 | );
|
---|
42 |
|
---|
43 | /**
|
---|
44 | * Class that sorts the {@code street} members of
|
---|
45 | * {@code type=associatedStreet} and {@code type=street} relations.
|
---|
46 | */
|
---|
47 | private static class AssociatedStreetRoleStreetSorter implements AdditionalSorter {
|
---|
48 |
|
---|
49 | @Override
|
---|
50 | public boolean acceptsMember(List<RelationMember> relationMembers, RelationMember m) {
|
---|
51 | return "street".equals(m.getRole());
|
---|
52 | }
|
---|
53 |
|
---|
54 | @Override
|
---|
55 | public List<RelationMember> sortMembers(List<RelationMember> list) {
|
---|
56 | return sortMembersByConnectivity(list);
|
---|
57 | }
|
---|
58 | }
|
---|
59 |
|
---|
60 | /**
|
---|
61 | * Class that sorts the {@code address} and {@code house} members of
|
---|
62 | * {@code type=associatedStreet} and {@code type=street} relations.
|
---|
63 | */
|
---|
64 | private static class AssociatedStreetRoleAddressHouseSorter implements AdditionalSorter {
|
---|
65 |
|
---|
66 | @Override
|
---|
67 | public boolean acceptsMember(List<RelationMember> relationMembers, RelationMember m) {
|
---|
68 | return "address".equals(m.getRole()) || "house".equals(m.getRole());
|
---|
69 | }
|
---|
70 |
|
---|
71 | @Override
|
---|
72 | public List<RelationMember> sortMembers(List<RelationMember> list) {
|
---|
73 | list.sort((a, b) -> {
|
---|
74 | final int houseNumber = AlphanumComparator.getInstance().compare(
|
---|
75 | a.getMember().get("addr:housenumber"),
|
---|
76 | b.getMember().get("addr:housenumber"));
|
---|
77 | if (houseNumber != 0) {
|
---|
78 | return houseNumber;
|
---|
79 | }
|
---|
80 | final String aDisplayName = a.getMember().getDisplayName(DefaultNameFormatter.getInstance());
|
---|
81 | final String bDisplayName = b.getMember().getDisplayName(DefaultNameFormatter.getInstance());
|
---|
82 | return AlphanumComparator.getInstance().compare(aDisplayName, bDisplayName);
|
---|
83 | });
|
---|
84 | return list;
|
---|
85 | }
|
---|
86 | }
|
---|
87 |
|
---|
88 | /**
|
---|
89 | * Class that sorts the {@code platform} and {@code stop} members of
|
---|
90 | * {@code type=public_transport} relations.
|
---|
91 | */
|
---|
92 | private static class PublicTransportRoleStopPlatformSorter implements AdditionalSorter {
|
---|
93 |
|
---|
94 | @Override
|
---|
95 | public boolean acceptsMember(List<RelationMember> relationMembers, RelationMember m) {
|
---|
96 | return m.getRole() != null && (m.getRole().startsWith("platform") || m.getRole().startsWith("stop"));
|
---|
97 | }
|
---|
98 |
|
---|
99 | private static String getStopName(OsmPrimitive p) {
|
---|
100 | return p.referrers(Relation.class)
|
---|
101 | .filter(ref -> ref.hasTag("type", "public_transport")
|
---|
102 | && ref.hasTag("public_transport", "stop_area")
|
---|
103 | && ref.getName() != null)
|
---|
104 | .map(Relation::getName)
|
---|
105 | .findFirst()
|
---|
106 | .orElse(p.getName());
|
---|
107 | }
|
---|
108 |
|
---|
109 | @Override
|
---|
110 | public List<RelationMember> sortMembers(List<RelationMember> list) {
|
---|
111 | final Map<String, RelationMember> platformByName = new HashMap<>();
|
---|
112 | for (RelationMember i : list) {
|
---|
113 | if (i.getRole().startsWith("platform")) {
|
---|
114 | final RelationMember old = platformByName.put(getStopName(i.getMember()), i);
|
---|
115 | if (old != null) {
|
---|
116 | // Platform with same name present. Stop to avoid damaging complicated relations.
|
---|
117 | // This case can happily be handled differently.
|
---|
118 | return list;
|
---|
119 | }
|
---|
120 | }
|
---|
121 | }
|
---|
122 | final List<RelationMember> sorted = new ArrayList<>(list.size());
|
---|
123 | for (RelationMember i : list) {
|
---|
124 | if (i.getRole().startsWith("stop")) {
|
---|
125 | sorted.add(i);
|
---|
126 | final RelationMember platform = platformByName.remove(getStopName(i.getMember()));
|
---|
127 | if (platform != null) {
|
---|
128 | sorted.add(platform);
|
---|
129 | }
|
---|
130 | }
|
---|
131 | }
|
---|
132 | sorted.addAll(platformByName.values());
|
---|
133 | return sorted;
|
---|
134 | }
|
---|
135 | }
|
---|
136 |
|
---|
137 | /**
|
---|
138 | * Class that sorts the {@code from}, {@code via} and {@code to} members of
|
---|
139 | * {@code type=restriction} relations.
|
---|
140 | */
|
---|
141 | private static class FromViaToSorter implements AdditionalSorter {
|
---|
142 |
|
---|
143 | private static final List<String> ROLES = Arrays.asList("from", "via", "to");
|
---|
144 |
|
---|
145 | @Override
|
---|
146 | public boolean acceptsMember(List<RelationMember> relationMembers, RelationMember m) {
|
---|
147 | return ROLES.contains(m.getRole())
|
---|
148 | && relationMembers.stream().map(RelationMember::getRole).collect(Collectors.toSet()).containsAll(ROLES);
|
---|
149 | }
|
---|
150 |
|
---|
151 | @Override
|
---|
152 | public List<RelationMember> sortMembers(List<RelationMember> list) {
|
---|
153 | list.sort(Comparator.comparingInt(m -> ROLES.indexOf(m.getRole())));
|
---|
154 | return list;
|
---|
155 | }
|
---|
156 | }
|
---|
157 |
|
---|
158 | /**
|
---|
159 | * Sort a collection of relation members by the way they are linked.
|
---|
160 | *
|
---|
161 | * @param relationMembers collection of relation members
|
---|
162 | * @return sorted collection of relation members
|
---|
163 | */
|
---|
164 | public List<RelationMember> sortMembers(List<RelationMember> relationMembers) {
|
---|
165 | List<RelationMember> newMembers = new ArrayList<>();
|
---|
166 |
|
---|
167 | // Sort members with custom mechanisms (relation-dependent)
|
---|
168 | List<RelationMember> defaultMembers = new ArrayList<>(relationMembers.size());
|
---|
169 | // Maps sorter to assigned members for sorting. Use LinkedHashMap to retain order.
|
---|
170 | Map<AdditionalSorter, List<RelationMember>> customMap = new LinkedHashMap<>();
|
---|
171 |
|
---|
172 | // Dispatch members to the first adequate sorter
|
---|
173 | for (RelationMember m : relationMembers) {
|
---|
174 | boolean wasAdded = false;
|
---|
175 | for (AdditionalSorter sorter : ADDITIONAL_SORTERS) {
|
---|
176 | if (sorter.acceptsMember(relationMembers, m)) {
|
---|
177 | wasAdded = customMap.computeIfAbsent(sorter, k -> new LinkedList<>()).add(m);
|
---|
178 | break;
|
---|
179 | }
|
---|
180 | }
|
---|
181 | if (!wasAdded) {
|
---|
182 | defaultMembers.add(m);
|
---|
183 | }
|
---|
184 | }
|
---|
185 |
|
---|
186 | // Sort members and add them to result
|
---|
187 | for (Entry<AdditionalSorter, List<RelationMember>> entry : customMap.entrySet()) {
|
---|
188 | newMembers.addAll(entry.getKey().sortMembers(entry.getValue()));
|
---|
189 | }
|
---|
190 | newMembers.addAll(sortMembersByConnectivity(defaultMembers));
|
---|
191 | return newMembers;
|
---|
192 | }
|
---|
193 |
|
---|
194 | /**
|
---|
195 | * Sorts a list of members by connectivity
|
---|
196 | * @param defaultMembers The members to sort
|
---|
197 | * @return A sorted list of the same members
|
---|
198 | */
|
---|
199 | public static List<RelationMember> sortMembersByConnectivity(List<RelationMember> defaultMembers) {
|
---|
200 |
|
---|
201 | List<RelationMember> newMembers = new ArrayList<>();
|
---|
202 |
|
---|
203 | RelationNodeMap map = new RelationNodeMap(defaultMembers);
|
---|
204 | // List of groups of linked members
|
---|
205 | //
|
---|
206 | List<LinkedList<Integer>> allGroups = new ArrayList<>();
|
---|
207 |
|
---|
208 | // current group of members that are linked among each other
|
---|
209 | // Two successive members are always linked i.e. have a common node.
|
---|
210 | //
|
---|
211 | LinkedList<Integer> group;
|
---|
212 |
|
---|
213 | Integer first;
|
---|
214 | while ((first = map.pop()) != null) {
|
---|
215 | group = new LinkedList<>();
|
---|
216 | group.add(first);
|
---|
217 |
|
---|
218 | allGroups.add(group);
|
---|
219 |
|
---|
220 | Integer next = first;
|
---|
221 | while ((next = map.popAdjacent(next)) != null) {
|
---|
222 | group.addLast(next);
|
---|
223 | }
|
---|
224 |
|
---|
225 | // The first element need not be in front of the list.
|
---|
226 | // So the search goes in both directions
|
---|
227 | //
|
---|
228 | next = first;
|
---|
229 | while ((next = map.popAdjacent(next)) != null) {
|
---|
230 | group.addFirst(next);
|
---|
231 | }
|
---|
232 | }
|
---|
233 |
|
---|
234 | for (List<Integer> tmpGroup : allGroups) {
|
---|
235 | for (Integer p : tmpGroup) {
|
---|
236 | newMembers.add(defaultMembers.get(p));
|
---|
237 | }
|
---|
238 | }
|
---|
239 |
|
---|
240 | // Finally, add members that have not been sorted at all
|
---|
241 | for (Integer i : map.getNotSortableMembers()) {
|
---|
242 | newMembers.add(defaultMembers.get(i));
|
---|
243 | }
|
---|
244 |
|
---|
245 | return newMembers;
|
---|
246 | }
|
---|
247 |
|
---|
248 | }
|
---|