source: josm/trunk/src/org/openstreetmap/josm/actions/MergeNodesAction.java@ 11488

Last change on this file since 11488 was 11481, checked in by Don-vip, 7 years ago

sonar - squid:S3518 - Zero should not be a possible denominator
  • Property svn:eol-style set to native
File size: 15.0 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6import static org.openstreetmap.josm.tools.I18n.trn;
7
8import java.awt.event.ActionEvent;
9import java.awt.event.KeyEvent;
10import java.util.ArrayList;
11import java.util.Collection;
12import java.util.Collections;
13import java.util.HashSet;
14import java.util.LinkedList;
15import java.util.List;
16import java.util.Objects;
17import java.util.Set;
18
19import javax.swing.JOptionPane;
20
21import org.openstreetmap.josm.Main;
22import org.openstreetmap.josm.command.ChangeCommand;
23import org.openstreetmap.josm.command.ChangeNodesCommand;
24import org.openstreetmap.josm.command.Command;
25import org.openstreetmap.josm.command.DeleteCommand;
26import org.openstreetmap.josm.command.SequenceCommand;
27import org.openstreetmap.josm.data.coor.EastNorth;
28import org.openstreetmap.josm.data.coor.LatLon;
29import org.openstreetmap.josm.data.osm.Node;
30import org.openstreetmap.josm.data.osm.OsmPrimitive;
31import org.openstreetmap.josm.data.osm.TagCollection;
32import org.openstreetmap.josm.data.osm.Way;
33import org.openstreetmap.josm.gui.DefaultNameFormatter;
34import org.openstreetmap.josm.gui.HelpAwareOptionPane;
35import org.openstreetmap.josm.gui.HelpAwareOptionPane.ButtonSpec;
36import org.openstreetmap.josm.gui.Notification;
37import org.openstreetmap.josm.gui.conflict.tags.CombinePrimitiveResolverDialog;
38import org.openstreetmap.josm.gui.layer.OsmDataLayer;
39import org.openstreetmap.josm.tools.CheckParameterUtil;
40import org.openstreetmap.josm.tools.ImageProvider;
41import org.openstreetmap.josm.tools.Shortcut;
42import org.openstreetmap.josm.tools.UserCancelException;
43
44/**
45 * Merges a collection of nodes into one node.
46 *
47 * The "surviving" node will be the one with the lowest positive id.
48 * (I.e. it was uploaded to the server and is the oldest one.)
49 *
50 * However we use the location of the node that was selected *last*.
51 * The "surviving" node will be moved to that location if it is
52 * different from the last selected node.
53 *
54 * @since 422
55 */
56public class MergeNodesAction extends JosmAction {
57
58 /**
59 * Constructs a new {@code MergeNodesAction}.
60 */
61 public MergeNodesAction() {
62 super(tr("Merge Nodes"), "mergenodes", tr("Merge nodes into the oldest one."),
63 Shortcut.registerShortcut("tools:mergenodes", tr("Tool: {0}", tr("Merge Nodes")), KeyEvent.VK_M, Shortcut.DIRECT), true);
64 putValue("help", ht("/Action/MergeNodes"));
65 }
66
67 @Override
68 public void actionPerformed(ActionEvent event) {
69 if (!isEnabled())
70 return;
71 Collection<OsmPrimitive> selection = getLayerManager().getEditDataSet().getAllSelected();
72 List<Node> selectedNodes = OsmPrimitive.getFilteredList(selection, Node.class);
73
74 if (selectedNodes.size() == 1) {
75 List<Node> nearestNodes = Main.map.mapView.getNearestNodes(
76 Main.map.mapView.getPoint(selectedNodes.get(0)), selectedNodes, OsmPrimitive::isUsable);
77 if (nearestNodes.isEmpty()) {
78 new Notification(
79 tr("Please select at least two nodes to merge or one node that is close to another node."))
80 .setIcon(JOptionPane.WARNING_MESSAGE)
81 .show();
82 return;
83 }
84 selectedNodes.addAll(nearestNodes);
85 }
86
87 Node targetNode = selectTargetNode(selectedNodes);
88 Node targetLocationNode = selectTargetLocationNode(selectedNodes);
89 Command cmd = mergeNodes(Main.getLayerManager().getEditLayer(), selectedNodes, targetNode, targetLocationNode);
90 if (cmd != null) {
91 Main.main.undoRedo.add(cmd);
92 Main.getLayerManager().getEditLayer().data.setSelected(targetNode);
93 }
94 }
95
96 /**
97 * Select the location of the target node after merge.
98 *
99 * @param candidates the collection of candidate nodes
100 * @return the coordinates of this node are later used for the target node
101 */
102 public static Node selectTargetLocationNode(List<Node> candidates) {
103 int size = candidates.size();
104 if (size == 0)
105 throw new IllegalArgumentException("empty list");
106 if (size == 1) // to avoid division by 0 in mode 2
107 return candidates.get(0);
108
109 switch (Main.pref.getInteger("merge-nodes.mode", 0)) {
110 case 0:
111 return candidates.get(size - 1);
112 case 1:
113 double east1 = 0;
114 double north1 = 0;
115 for (final Node n : candidates) {
116 EastNorth en = n.getEastNorth();
117 east1 += en.east();
118 north1 += en.north();
119 }
120
121 return new Node(new EastNorth(east1 / size, north1 / size));
122 case 2:
123 final double[] weights = new double[size];
124
125 for (int i = 0; i < size; i++) {
126 final LatLon c1 = candidates.get(i).getCoor();
127 for (int j = i + 1; j < size; j++) {
128 final LatLon c2 = candidates.get(j).getCoor();
129 final double d = c1.distance(c2);
130 weights[i] += d;
131 weights[j] += d;
132 }
133 }
134
135 double east2 = 0;
136 double north2 = 0;
137 double weight = 0;
138 for (int i = 0; i < size; i++) {
139 final EastNorth en = candidates.get(i).getEastNorth();
140 final double w = weights[i];
141 east2 += en.east() * w;
142 north2 += en.north() * w;
143 weight += w;
144 }
145
146 if (weight == 0) // to avoid division by 0
147 return candidates.get(0);
148
149 return new Node(new EastNorth(east2 / weight, north2 / weight));
150 default:
151 throw new IllegalStateException("unacceptable merge-nodes.mode");
152 }
153 }
154
155 /**
156 * Find which node to merge into (i.e. which one will be left)
157 *
158 * @param candidates the collection of candidate nodes
159 * @return the selected target node
160 */
161 public static Node selectTargetNode(Collection<Node> candidates) {
162 Node oldestNode = null;
163 Node targetNode = null;
164 Node lastNode = null;
165 for (Node n : candidates) {
166 if (!n.isNew()) {
167 // Among existing nodes, try to keep the oldest used one
168 if (!n.getReferrers().isEmpty()) {
169 if (targetNode == null || n.getId() < targetNode.getId()) {
170 targetNode = n;
171 }
172 } else if (oldestNode == null || n.getId() < oldestNode.getId()) {
173 oldestNode = n;
174 }
175 }
176 lastNode = n;
177 }
178 if (targetNode == null) {
179 targetNode = oldestNode != null ? oldestNode : lastNode;
180 }
181 return targetNode;
182 }
183
184
185 /**
186 * Fixes the parent ways referring to one of the nodes.
187 *
188 * Replies null, if the ways could not be fixed, i.e. because a way would have to be deleted
189 * which is referred to by a relation.
190 *
191 * @param nodesToDelete the collection of nodes to be deleted
192 * @param targetNode the target node the other nodes are merged to
193 * @return a list of commands; null, if the ways could not be fixed
194 */
195 protected static List<Command> fixParentWays(Collection<Node> nodesToDelete, Node targetNode) {
196 List<Command> cmds = new ArrayList<>();
197 Set<Way> waysToDelete = new HashSet<>();
198
199 for (Way w: OsmPrimitive.getFilteredList(OsmPrimitive.getReferrer(nodesToDelete), Way.class)) {
200 List<Node> newNodes = new ArrayList<>(w.getNodesCount());
201 for (Node n: w.getNodes()) {
202 if (!nodesToDelete.contains(n) && !n.equals(targetNode)) {
203 newNodes.add(n);
204 } else if (newNodes.isEmpty() || !newNodes.get(newNodes.size()-1).equals(targetNode)) {
205 // make sure we collapse a sequence of deleted nodes
206 // to exactly one occurrence of the merged target node
207 newNodes.add(targetNode);
208 }
209 // else: drop the node
210 }
211 if (newNodes.size() < 2) {
212 if (w.getReferrers().isEmpty()) {
213 waysToDelete.add(w);
214 } else {
215 ButtonSpec[] options = new ButtonSpec[] {
216 new ButtonSpec(
217 tr("Abort Merging"),
218 ImageProvider.get("cancel"),
219 tr("Click to abort merging nodes"),
220 null /* no special help topic */
221 )
222 };
223 HelpAwareOptionPane.showOptionDialog(
224 Main.parent,
225 tr("Cannot merge nodes: Would have to delete way {0} which is still used by {1}",
226 DefaultNameFormatter.getInstance().formatAsHtmlUnorderedList(w),
227 DefaultNameFormatter.getInstance().formatAsHtmlUnorderedList(w.getReferrers(), 20)),
228 tr("Warning"),
229 JOptionPane.WARNING_MESSAGE,
230 null, /* no icon */
231 options,
232 options[0],
233 ht("/Action/MergeNodes#WaysToDeleteStillInUse")
234 );
235 return null;
236 }
237 } else if (newNodes.size() < 2 && w.getReferrers().isEmpty()) {
238 waysToDelete.add(w);
239 } else {
240 cmds.add(new ChangeNodesCommand(w, newNodes));
241 }
242 }
243 if (!waysToDelete.isEmpty()) {
244 cmds.add(new DeleteCommand(waysToDelete));
245 }
246 return cmds;
247 }
248
249 /**
250 * Merges the nodes in {@code nodes} at the specified node's location. Uses the dataset
251 * managed by {@code layer} as reference.
252 * @param layer layer the reference data layer. Must not be null
253 * @param nodes the collection of nodes. Ignored if null
254 * @param targetLocationNode this node's location will be used for the target node
255 * @throws IllegalArgumentException if {@code layer} is null
256 */
257 public static void doMergeNodes(OsmDataLayer layer, Collection<Node> nodes, Node targetLocationNode) {
258 if (nodes == null) {
259 return;
260 }
261 Set<Node> allNodes = new HashSet<>(nodes);
262 allNodes.add(targetLocationNode);
263 Node target;
264 if (nodes.contains(targetLocationNode) && !targetLocationNode.isNew()) {
265 target = targetLocationNode; // keep existing targetLocationNode as target to avoid unnecessary changes (see #2447)
266 } else {
267 target = selectTargetNode(allNodes);
268 }
269
270 Command cmd = mergeNodes(layer, nodes, target, targetLocationNode);
271 if (cmd != null) {
272 Main.main.undoRedo.add(cmd);
273 layer.data.setSelected(target);
274 }
275 }
276
277 /**
278 * Merges the nodes in {@code nodes} at the specified node's location. Uses the dataset
279 * managed by {@code layer} as reference.
280 *
281 * @param layer layer the reference data layer. Must not be null.
282 * @param nodes the collection of nodes. Ignored if null.
283 * @param targetLocationNode this node's location will be used for the targetNode.
284 * @return The command necessary to run in order to perform action, or {@code null} if there is nothing to do
285 * @throws IllegalArgumentException if {@code layer} is null
286 */
287 public static Command mergeNodes(OsmDataLayer layer, Collection<Node> nodes, Node targetLocationNode) {
288 if (nodes == null) {
289 return null;
290 }
291 Set<Node> allNodes = new HashSet<>(nodes);
292 allNodes.add(targetLocationNode);
293 return mergeNodes(layer, nodes, selectTargetNode(allNodes), targetLocationNode);
294 }
295
296 /**
297 * Merges the nodes in <code>nodes</code> onto one of the nodes. Uses the dataset
298 * managed by <code>layer</code> as reference.
299 *
300 * @param layer layer the reference data layer. Must not be null.
301 * @param nodes the collection of nodes. Ignored if null.
302 * @param targetNode the target node the collection of nodes is merged to. Must not be null.
303 * @param targetLocationNode this node's location will be used for the targetNode.
304 * @return The command necessary to run in order to perform action, or {@code null} if there is nothing to do
305 * @throws IllegalArgumentException if layer is null
306 */
307 public static Command mergeNodes(OsmDataLayer layer, Collection<Node> nodes, Node targetNode, Node targetLocationNode) {
308 CheckParameterUtil.ensureParameterNotNull(layer, "layer");
309 CheckParameterUtil.ensureParameterNotNull(targetNode, "targetNode");
310 if (nodes == null) {
311 return null;
312 }
313
314 try {
315 TagCollection nodeTags = TagCollection.unionOfAllPrimitives(nodes);
316
317 // the nodes we will have to delete
318 //
319 Collection<Node> nodesToDelete = new HashSet<>(nodes);
320 nodesToDelete.remove(targetNode);
321
322 // fix the ways referring to at least one of the merged nodes
323 //
324 List<Command> wayFixCommands = fixParentWays(nodesToDelete, targetNode);
325 if (wayFixCommands == null) {
326 return null;
327 }
328 List<Command> cmds = new LinkedList<>(wayFixCommands);
329
330 // build the commands
331 //
332 if (!targetNode.equals(targetLocationNode)) {
333 LatLon targetLocationCoor = targetLocationNode.getCoor();
334 if (!Objects.equals(targetNode.getCoor(), targetLocationCoor)) {
335 Node newTargetNode = new Node(targetNode);
336 newTargetNode.setCoor(targetLocationCoor);
337 cmds.add(new ChangeCommand(targetNode, newTargetNode));
338 }
339 }
340 cmds.addAll(CombinePrimitiveResolverDialog.launchIfNecessary(nodeTags, nodes, Collections.singleton(targetNode)));
341 if (!nodesToDelete.isEmpty()) {
342 cmds.add(new DeleteCommand(nodesToDelete));
343 }
344 return new SequenceCommand(/* for correct i18n of plural forms - see #9110 */
345 trn("Merge {0} node", "Merge {0} nodes", nodes.size(), nodes.size()), cmds);
346 } catch (UserCancelException ex) {
347 Main.trace(ex);
348 return null;
349 }
350 }
351
352 @Override
353 protected void updateEnabledState() {
354 updateEnabledStateOnCurrentSelection();
355 }
356
357 @Override
358 protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
359 if (selection == null || selection.isEmpty()) {
360 setEnabled(false);
361 return;
362 }
363 boolean ok = true;
364 for (OsmPrimitive osm : selection) {
365 if (!(osm instanceof Node)) {
366 ok = false;
367 break;
368 }
369 }
370 setEnabled(ok);
371 }
372}
Note: See TracBrowser for help on using the repository browser.