source: josm/trunk/src/org/openstreetmap/josm/command/DeleteCommand.java@ 8509

Last change on this file since 8509 was 8469, checked in by Don-vip, 9 years ago

Add some more package-info.java to enhance Javadoc. Refactor package gui.actionsupport => move its only 3 classes to other packages
  • Property svn:eol-style set to native
File size: 22.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.command;
3
4import static org.openstreetmap.josm.tools.I18n.marktr;
5import static org.openstreetmap.josm.tools.I18n.tr;
6import static org.openstreetmap.josm.tools.I18n.trn;
7
8import java.awt.GridBagLayout;
9import java.util.ArrayList;
10import java.util.Collection;
11import java.util.Collections;
12import java.util.EnumSet;
13import java.util.HashMap;
14import java.util.HashSet;
15import java.util.Iterator;
16import java.util.LinkedList;
17import java.util.List;
18import java.util.Map;
19import java.util.Map.Entry;
20import java.util.Set;
21
22import javax.swing.Icon;
23import javax.swing.JOptionPane;
24import javax.swing.JPanel;
25
26import org.openstreetmap.josm.Main;
27import org.openstreetmap.josm.actions.SplitWayAction;
28import org.openstreetmap.josm.data.osm.Node;
29import org.openstreetmap.josm.data.osm.OsmPrimitive;
30import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
31import org.openstreetmap.josm.data.osm.PrimitiveData;
32import org.openstreetmap.josm.data.osm.Relation;
33import org.openstreetmap.josm.data.osm.RelationToChildReference;
34import org.openstreetmap.josm.data.osm.Way;
35import org.openstreetmap.josm.data.osm.WaySegment;
36import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
37import org.openstreetmap.josm.gui.DefaultNameFormatter;
38import org.openstreetmap.josm.gui.dialogs.DeleteFromRelationConfirmationDialog;
39import org.openstreetmap.josm.gui.layer.OsmDataLayer;
40import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
41import org.openstreetmap.josm.tools.CheckParameterUtil;
42import org.openstreetmap.josm.tools.ImageProvider;
43import org.openstreetmap.josm.tools.Utils;
44
45/**
46 * A command to delete a number of primitives from the dataset.
47 * @since 23
48 */
49public class DeleteCommand extends Command {
50 /**
51 * The primitives that get deleted.
52 */
53 private final Collection<? extends OsmPrimitive> toDelete;
54 private final Map<OsmPrimitive, PrimitiveData> clonedPrimitives = new HashMap<>();
55
56 /**
57 * Constructor. Deletes a collection of primitives in the current edit layer.
58 *
59 * @param data the primitives to delete. Must neither be null nor empty.
60 * @throws IllegalArgumentException if data is null or empty
61 */
62 public DeleteCommand(Collection<? extends OsmPrimitive> data) {
63 CheckParameterUtil.ensureParameterNotNull(data, "data");
64 if (data.isEmpty())
65 throw new IllegalArgumentException(tr("At least one object to delete required, got empty collection"));
66 this.toDelete = data;
67 checkConsistency();
68 }
69
70 /**
71 * Constructor. Deletes a single primitive in the current edit layer.
72 *
73 * @param data the primitive to delete. Must not be null.
74 * @throws IllegalArgumentException if data is null
75 */
76 public DeleteCommand(OsmPrimitive data) {
77 this(Collections.singleton(data));
78 }
79
80 /**
81 * Constructor for a single data item. Use the collection constructor to delete multiple
82 * objects.
83 *
84 * @param layer the layer context for deleting this primitive. Must not be null.
85 * @param data the primitive to delete. Must not be null.
86 * @throws IllegalArgumentException if data is null
87 * @throws IllegalArgumentException if layer is null
88 */
89 public DeleteCommand(OsmDataLayer layer, OsmPrimitive data) {
90 this(layer, Collections.singleton(data));
91 }
92
93 /**
94 * Constructor for a collection of data to be deleted in the context of
95 * a specific layer
96 *
97 * @param layer the layer context for deleting these primitives. Must not be null.
98 * @param data the primitives to delete. Must neither be null nor empty.
99 * @throws IllegalArgumentException if layer is null
100 * @throws IllegalArgumentException if data is null or empty
101 */
102 public DeleteCommand(OsmDataLayer layer, Collection<? extends OsmPrimitive> data) {
103 super(layer);
104 CheckParameterUtil.ensureParameterNotNull(data, "data");
105 if (data.isEmpty())
106 throw new IllegalArgumentException(tr("At least one object to delete required, got empty collection"));
107 this.toDelete = data;
108 checkConsistency();
109 }
110
111 private void checkConsistency() {
112 for (OsmPrimitive p : toDelete) {
113 if (p == null) {
114 throw new IllegalArgumentException("Primitive to delete must not be null");
115 } else if (p.getDataSet() == null) {
116 throw new IllegalArgumentException("Primitive to delete must be in a dataset");
117 }
118 }
119 }
120
121 @Override
122 public boolean executeCommand() {
123 // Make copy and remove all references (to prevent inconsistent dataset (delete referenced) while command is executed)
124 for (OsmPrimitive osm: toDelete) {
125 if (osm.isDeleted())
126 throw new IllegalArgumentException(osm + " is already deleted");
127 clonedPrimitives.put(osm, osm.save());
128
129 if (osm instanceof Way) {
130 ((Way) osm).setNodes(null);
131 } else if (osm instanceof Relation) {
132 ((Relation) osm).setMembers(null);
133 }
134 }
135
136 for (OsmPrimitive osm: toDelete) {
137 osm.setDeleted(true);
138 }
139
140 return true;
141 }
142
143 @Override
144 public void undoCommand() {
145 for (OsmPrimitive osm: toDelete) {
146 osm.setDeleted(false);
147 }
148
149 for (Entry<OsmPrimitive, PrimitiveData> entry: clonedPrimitives.entrySet()) {
150 entry.getKey().load(entry.getValue());
151 }
152 }
153
154 @Override
155 public void fillModifiedData(Collection<OsmPrimitive> modified, Collection<OsmPrimitive> deleted,
156 Collection<OsmPrimitive> added) {
157 }
158
159 private Set<OsmPrimitiveType> getTypesToDelete() {
160 Set<OsmPrimitiveType> typesToDelete = EnumSet.noneOf(OsmPrimitiveType.class);
161 for (OsmPrimitive osm : toDelete) {
162 typesToDelete.add(OsmPrimitiveType.from(osm));
163 }
164 return typesToDelete;
165 }
166
167 @Override
168 public String getDescriptionText() {
169 if (toDelete.size() == 1) {
170 OsmPrimitive primitive = toDelete.iterator().next();
171 String msg = "";
172 switch(OsmPrimitiveType.from(primitive)) {
173 case NODE: msg = marktr("Delete node {0}"); break;
174 case WAY: msg = marktr("Delete way {0}"); break;
175 case RELATION:msg = marktr("Delete relation {0}"); break;
176 }
177
178 return tr(msg, primitive.getDisplayName(DefaultNameFormatter.getInstance()));
179 } else {
180 Set<OsmPrimitiveType> typesToDelete = getTypesToDelete();
181 String msg = "";
182 if (typesToDelete.size() > 1) {
183 msg = trn("Delete {0} object", "Delete {0} objects", toDelete.size(), toDelete.size());
184 } else {
185 OsmPrimitiveType t = typesToDelete.iterator().next();
186 switch(t) {
187 case NODE: msg = trn("Delete {0} node", "Delete {0} nodes", toDelete.size(), toDelete.size()); break;
188 case WAY: msg = trn("Delete {0} way", "Delete {0} ways", toDelete.size(), toDelete.size()); break;
189 case RELATION: msg = trn("Delete {0} relation", "Delete {0} relations", toDelete.size(), toDelete.size()); break;
190 }
191 }
192 return msg;
193 }
194 }
195
196 @Override
197 public Icon getDescriptionIcon() {
198 if (toDelete.size() == 1)
199 return ImageProvider.get(toDelete.iterator().next().getDisplayType());
200 Set<OsmPrimitiveType> typesToDelete = getTypesToDelete();
201 if (typesToDelete.size() > 1)
202 return ImageProvider.get("data", "object");
203 else
204 return ImageProvider.get(typesToDelete.iterator().next());
205 }
206
207 @Override public Collection<PseudoCommand> getChildren() {
208 if (toDelete.size() == 1)
209 return null;
210 else {
211 List<PseudoCommand> children = new ArrayList<>(toDelete.size());
212 for (final OsmPrimitive osm : toDelete) {
213 children.add(new PseudoCommand() {
214
215 @Override public String getDescriptionText() {
216 return tr("Deleted ''{0}''", osm.getDisplayName(DefaultNameFormatter.getInstance()));
217 }
218
219 @Override public Icon getDescriptionIcon() {
220 return ImageProvider.get(osm.getDisplayType());
221 }
222
223 @Override public Collection<? extends OsmPrimitive> getParticipatingPrimitives() {
224 return Collections.singleton(osm);
225 }
226
227 });
228 }
229 return children;
230
231 }
232 }
233
234 @Override public Collection<? extends OsmPrimitive> getParticipatingPrimitives() {
235 return toDelete;
236 }
237
238 /**
239 * Delete the primitives and everything they reference.
240 *
241 * If a node is deleted, the node and all ways and relations the node is part of are deleted as well.
242 * If a way is deleted, all relations the way is member of are also deleted.
243 * If a way is deleted, only the way and no nodes are deleted.
244 *
245 * @param layer the {@link OsmDataLayer} in whose context primitives are deleted. Must not be null.
246 * @param selection The list of all object to be deleted.
247 * @param silent Set to true if the user should not be bugged with additional dialogs
248 * @return command A command to perform the deletions, or null of there is nothing to delete.
249 * @throws IllegalArgumentException if layer is null
250 */
251 public static Command deleteWithReferences(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection, boolean silent) {
252 CheckParameterUtil.ensureParameterNotNull(layer, "layer");
253 if (selection == null || selection.isEmpty()) return null;
254 Set<OsmPrimitive> parents = OsmPrimitive.getReferrer(selection);
255 parents.addAll(selection);
256
257 if (parents.isEmpty())
258 return null;
259 if (!silent && !checkAndConfirmOutlyingDelete(parents, null))
260 return null;
261 return new DeleteCommand(layer,parents);
262 }
263
264 /**
265 * Delete the primitives and everything they reference.
266 *
267 * If a node is deleted, the node and all ways and relations the node is part of are deleted as well.
268 * If a way is deleted, all relations the way is member of are also deleted.
269 * If a way is deleted, only the way and no nodes are deleted.
270 *
271 * @param layer the {@link OsmDataLayer} in whose context primitives are deleted. Must not be null.
272 * @param selection The list of all object to be deleted.
273 * @return command A command to perform the deletions, or null of there is nothing to delete.
274 * @throws IllegalArgumentException if layer is null
275 */
276 public static Command deleteWithReferences(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection) {
277 return deleteWithReferences(layer, selection, false);
278 }
279
280 /**
281 * Try to delete all given primitives.
282 *
283 * If a node is used by a way, it's removed from that way. If a node or a way is used by a
284 * relation, inform the user and do not delete.
285 *
286 * If this would cause ways with less than 2 nodes to be created, delete these ways instead. If
287 * they are part of a relation, inform the user and do not delete.
288 *
289 * @param layer the {@link OsmDataLayer} in whose context the primitives are deleted
290 * @param selection the objects to delete.
291 * @return command a command to perform the deletions, or null if there is nothing to delete.
292 */
293 public static Command delete(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection) {
294 return delete(layer, selection, true, false);
295 }
296
297 /**
298 * Replies the collection of nodes referred to by primitives in <code>primitivesToDelete</code> which
299 * can be deleted too. A node can be deleted if
300 * <ul>
301 * <li>it is untagged (see {@link Node#isTagged()}</li>
302 * <li>it is not referred to by other non-deleted primitives outside of <code>primitivesToDelete</code></li>
303 * </ul>
304 * @param layer the layer in whose context primitives are deleted
305 * @param primitivesToDelete the primitives to delete
306 * @return the collection of nodes referred to by primitives in <code>primitivesToDelete</code> which
307 * can be deleted too
308 */
309 protected static Collection<Node> computeNodesToDelete(OsmDataLayer layer, Collection<OsmPrimitive> primitivesToDelete) {
310 Collection<Node> nodesToDelete = new HashSet<>();
311 for (Way way : OsmPrimitive.getFilteredList(primitivesToDelete, Way.class)) {
312 for (Node n : way.getNodes()) {
313 if (n.isTagged()) {
314 continue;
315 }
316 Collection<OsmPrimitive> referringPrimitives = n.getReferrers();
317 referringPrimitives.removeAll(primitivesToDelete);
318 int count = 0;
319 for (OsmPrimitive p : referringPrimitives) {
320 if (!p.isDeleted()) {
321 count++;
322 }
323 }
324 if (count == 0) {
325 nodesToDelete.add(n);
326 }
327 }
328 }
329 return nodesToDelete;
330 }
331
332 /**
333 * Try to delete all given primitives.
334 *
335 * If a node is used by a way, it's removed from that way. If a node or a way is used by a
336 * relation, inform the user and do not delete.
337 *
338 * If this would cause ways with less than 2 nodes to be created, delete these ways instead. If
339 * they are part of a relation, inform the user and do not delete.
340 *
341 * @param layer the {@link OsmDataLayer} in whose context the primitives are deleted
342 * @param selection the objects to delete.
343 * @param alsoDeleteNodesInWay <code>true</code> if nodes should be deleted as well
344 * @return command a command to perform the deletions, or null if there is nothing to delete.
345 */
346 public static Command delete(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection,
347 boolean alsoDeleteNodesInWay) {
348 return delete(layer, selection, alsoDeleteNodesInWay, false /* not silent */);
349 }
350
351 /**
352 * Try to delete all given primitives.
353 *
354 * If a node is used by a way, it's removed from that way. If a node or a way is used by a
355 * relation, inform the user and do not delete.
356 *
357 * If this would cause ways with less than 2 nodes to be created, delete these ways instead. If
358 * they are part of a relation, inform the user and do not delete.
359 *
360 * @param layer the {@link OsmDataLayer} in whose context the primitives are deleted
361 * @param selection the objects to delete.
362 * @param alsoDeleteNodesInWay <code>true</code> if nodes should be deleted as well
363 * @param silent set to true if the user should not be bugged with additional questions
364 * @return command a command to perform the deletions, or null if there is nothing to delete.
365 */
366 public static Command delete(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection,
367 boolean alsoDeleteNodesInWay, boolean silent) {
368 if (selection == null || selection.isEmpty())
369 return null;
370
371 Set<OsmPrimitive> primitivesToDelete = new HashSet<>(selection);
372
373 Collection<Relation> relationsToDelete = Utils.filteredCollection(primitivesToDelete, Relation.class);
374 if (!relationsToDelete.isEmpty() && !silent && !confirmRelationDeletion(relationsToDelete))
375 return null;
376
377 Collection<Way> waysToBeChanged = new HashSet<>();
378
379 if (alsoDeleteNodesInWay) {
380 // delete untagged nodes only referenced by primitives in primitivesToDelete, too
381 Collection<Node> nodesToDelete = computeNodesToDelete(layer, primitivesToDelete);
382 primitivesToDelete.addAll(nodesToDelete);
383 }
384
385 if (!silent && !checkAndConfirmOutlyingDelete(
386 primitivesToDelete, Utils.filteredCollection(primitivesToDelete, Way.class)))
387 return null;
388
389 waysToBeChanged.addAll(OsmPrimitive.getFilteredSet(OsmPrimitive.getReferrer(primitivesToDelete), Way.class));
390
391 Collection<Command> cmds = new LinkedList<>();
392 for (Way w : waysToBeChanged) {
393 Way wnew = new Way(w);
394 wnew.removeNodes(OsmPrimitive.getFilteredSet(primitivesToDelete, Node.class));
395 if (wnew.getNodesCount() < 2) {
396 primitivesToDelete.add(w);
397 } else {
398 cmds.add(new ChangeNodesCommand(w, wnew.getNodes()));
399 }
400 }
401
402 // get a confirmation that the objects to delete can be removed from their parent relations
403 //
404 if (!silent) {
405 Set<RelationToChildReference> references = RelationToChildReference.getRelationToChildReferences(primitivesToDelete);
406 Iterator<RelationToChildReference> it = references.iterator();
407 while(it.hasNext()) {
408 RelationToChildReference ref = it.next();
409 if (ref.getParent().isDeleted()) {
410 it.remove();
411 }
412 }
413 if (!references.isEmpty()) {
414 DeleteFromRelationConfirmationDialog dialog = DeleteFromRelationConfirmationDialog.getInstance();
415 dialog.getModel().populate(references);
416 dialog.setVisible(true);
417 if (dialog.isCanceled())
418 return null;
419 }
420 }
421
422 // remove the objects from their parent relations
423 //
424 for (Relation cur : OsmPrimitive.getFilteredSet(OsmPrimitive.getReferrer(primitivesToDelete), Relation.class)) {
425 Relation rel = new Relation(cur);
426 rel.removeMembersFor(primitivesToDelete);
427 cmds.add(new ChangeCommand(cur, rel));
428 }
429
430 // build the delete command
431 //
432 if (!primitivesToDelete.isEmpty()) {
433 cmds.add(new DeleteCommand(layer,primitivesToDelete));
434 }
435
436 return new SequenceCommand(tr("Delete"), cmds);
437 }
438
439 public static Command deleteWaySegment(OsmDataLayer layer, WaySegment ws) {
440 if (ws.way.getNodesCount() < 3)
441 return delete(layer, Collections.singleton(ws.way), false);
442
443 if (ws.way.isClosed()) {
444 // If the way is circular (first and last nodes are the same), the way shouldn't be splitted
445
446 List<Node> n = new ArrayList<>();
447
448 n.addAll(ws.way.getNodes().subList(ws.lowerIndex + 1, ws.way.getNodesCount() - 1));
449 n.addAll(ws.way.getNodes().subList(0, ws.lowerIndex + 1));
450
451 Way wnew = new Way(ws.way);
452 wnew.setNodes(n);
453
454 return new ChangeCommand(ws.way, wnew);
455 }
456
457 List<Node> n1 = new ArrayList<>();
458 List<Node> n2 = new ArrayList<>();
459
460 n1.addAll(ws.way.getNodes().subList(0, ws.lowerIndex + 1));
461 n2.addAll(ws.way.getNodes().subList(ws.lowerIndex + 1, ws.way.getNodesCount()));
462
463 Way wnew = new Way(ws.way);
464
465 if (n1.size() < 2) {
466 wnew.setNodes(n2);
467 return new ChangeCommand(ws.way, wnew);
468 } else if (n2.size() < 2) {
469 wnew.setNodes(n1);
470 return new ChangeCommand(ws.way, wnew);
471 } else {
472 List<List<Node>> chunks = new ArrayList<>(2);
473 chunks.add(n1);
474 chunks.add(n2);
475 return SplitWayAction.splitWay(layer,ws.way, chunks, Collections.<OsmPrimitive>emptyList()).getCommand();
476 }
477 }
478
479 public static boolean checkAndConfirmOutlyingDelete(Collection<? extends OsmPrimitive> primitives, Collection<? extends OsmPrimitive> ignore) {
480 return Command.checkAndConfirmOutlyingOperation("delete",
481 tr("Delete confirmation"),
482 tr("You are about to delete nodes outside of the area you have downloaded."
483 + "<br>"
484 + "This can cause problems because other objects (that you do not see) might use them."
485 + "<br>"
486 + "Do you really want to delete?"),
487 tr("You are about to delete incomplete objects."
488 + "<br>"
489 + "This will cause problems because you don''t see the real object."
490 + "<br>" + "Do you really want to delete?"),
491 primitives, ignore);
492 }
493
494 private static boolean confirmRelationDeletion(Collection<Relation> relations) {
495 JPanel msg = new JPanel(new GridBagLayout());
496 msg.add(new JMultilineLabel("<html>" + trn(
497 "You are about to delete {0} relation: {1}"
498 + "<br/>"
499 + "This step is rarely necessary and cannot be undone easily after being uploaded to the server."
500 + "<br/>"
501 + "Do you really want to delete?",
502 "You are about to delete {0} relations: {1}"
503 + "<br/>"
504 + "This step is rarely necessary and cannot be undone easily after being uploaded to the server."
505 + "<br/>"
506 + "Do you really want to delete?",
507 relations.size(), relations.size(), DefaultNameFormatter.getInstance().formatAsHtmlUnorderedList(relations))
508 + "</html>"));
509 return ConditionalOptionPaneUtil.showConfirmationDialog(
510 "delete_relations",
511 Main.parent,
512 msg,
513 tr("Delete relation?"),
514 JOptionPane.YES_NO_OPTION,
515 JOptionPane.QUESTION_MESSAGE,
516 JOptionPane.YES_OPTION);
517 }
518
519 @Override
520 public int hashCode() {
521 final int prime = 31;
522 int result = super.hashCode();
523 result = prime * result + ((clonedPrimitives == null) ? 0 : clonedPrimitives.hashCode());
524 result = prime * result + ((toDelete == null) ? 0 : toDelete.hashCode());
525 return result;
526 }
527
528 @Override
529 public boolean equals(Object obj) {
530 if (this == obj)
531 return true;
532 if (!super.equals(obj))
533 return false;
534 if (getClass() != obj.getClass())
535 return false;
536 DeleteCommand other = (DeleteCommand) obj;
537 if (clonedPrimitives == null) {
538 if (other.clonedPrimitives != null)
539 return false;
540 } else if (!clonedPrimitives.equals(other.clonedPrimitives))
541 return false;
542 if (toDelete == null) {
543 if (other.toDelete != null)
544 return false;
545 } else if (!toDelete.equals(other.toDelete))
546 return false;
547 return true;
548 }
549}
Note: See TracBrowser for help on using the repository browser.