1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.actions;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
|
---|
5 | import static org.openstreetmap.josm.tools.CheckParameterUtil.ensureParameterNotNull;
|
---|
6 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
7 |
|
---|
8 | import java.awt.event.ActionEvent;
|
---|
9 | import java.awt.event.KeyEvent;
|
---|
10 | import java.util.Collection;
|
---|
11 | import java.util.Collections;
|
---|
12 |
|
---|
13 | import javax.swing.JOptionPane;
|
---|
14 |
|
---|
15 | import org.openstreetmap.josm.Main;
|
---|
16 | import org.openstreetmap.josm.data.osm.DataSet;
|
---|
17 | import org.openstreetmap.josm.data.osm.OsmPrimitive;
|
---|
18 | import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
|
---|
19 | import org.openstreetmap.josm.data.osm.PrimitiveId;
|
---|
20 | import org.openstreetmap.josm.gui.ExceptionDialogUtil;
|
---|
21 | import org.openstreetmap.josm.gui.io.UpdatePrimitivesTask;
|
---|
22 | import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
|
---|
23 | import org.openstreetmap.josm.io.MultiFetchServerObjectReader;
|
---|
24 | import org.openstreetmap.josm.io.OnlineResource;
|
---|
25 | import org.openstreetmap.josm.tools.Shortcut;
|
---|
26 |
|
---|
27 | /**
|
---|
28 | * This action synchronizes a set of primitives with their state on the server.
|
---|
29 | * @since 1670
|
---|
30 | */
|
---|
31 | public class UpdateSelectionAction extends JosmAction {
|
---|
32 |
|
---|
33 | /**
|
---|
34 | * handle an exception thrown because a primitive was deleted on the server
|
---|
35 | *
|
---|
36 | * @param id the primitive id
|
---|
37 | * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE},
|
---|
38 | * {@link OsmPrimitiveType#WAY WAY}, {@link OsmPrimitiveType#RELATION RELATION}
|
---|
39 | */
|
---|
40 | public static void handlePrimitiveGoneException(long id, OsmPrimitiveType type) {
|
---|
41 | MultiFetchServerObjectReader reader = MultiFetchServerObjectReader.create();
|
---|
42 | reader.append(getCurrentDataSet(), id, type);
|
---|
43 | try {
|
---|
44 | DataSet ds = reader.parseOsm(NullProgressMonitor.INSTANCE);
|
---|
45 | Main.main.getEditLayer().mergeFrom(ds);
|
---|
46 | } catch (Exception e) {
|
---|
47 | ExceptionDialogUtil.explainException(e);
|
---|
48 | }
|
---|
49 | }
|
---|
50 |
|
---|
51 | /**
|
---|
52 | * Updates the data for for the {@link OsmPrimitive}s in <code>selection</code>
|
---|
53 | * with the data currently kept on the server.
|
---|
54 | *
|
---|
55 | * @param selection a collection of {@link OsmPrimitive}s to update
|
---|
56 | *
|
---|
57 | */
|
---|
58 | public static void updatePrimitives(final Collection<OsmPrimitive> selection) {
|
---|
59 | UpdatePrimitivesTask task = new UpdatePrimitivesTask(Main.main.getEditLayer(), selection);
|
---|
60 | Main.worker.submit(task);
|
---|
61 | }
|
---|
62 |
|
---|
63 | /**
|
---|
64 | * Updates the data for the {@link OsmPrimitive}s with id <code>id</code>
|
---|
65 | * with the data currently kept on the server.
|
---|
66 | *
|
---|
67 | * @param id the id of a primitive in the {@link DataSet} of the current edit layer. Must not be null.
|
---|
68 | * @throws IllegalArgumentException if id is null
|
---|
69 | * @throws IllegalStateException if there is no primitive with <code>id</code> in the current dataset
|
---|
70 | * @throws IllegalStateException if there is no current dataset
|
---|
71 | */
|
---|
72 | public static void updatePrimitive(PrimitiveId id) {
|
---|
73 | ensureParameterNotNull(id, "id");
|
---|
74 | if (getEditLayer() == null)
|
---|
75 | throw new IllegalStateException(tr("No current dataset found"));
|
---|
76 | OsmPrimitive primitive = getEditLayer().data.getPrimitiveById(id);
|
---|
77 | if (primitive == null)
|
---|
78 | throw new IllegalStateException(tr("Did not find an object with id {0} in the current dataset", id));
|
---|
79 | updatePrimitives(Collections.singleton(primitive));
|
---|
80 | }
|
---|
81 |
|
---|
82 | /**
|
---|
83 | * Constructs a new {@code UpdateSelectionAction}.
|
---|
84 | */
|
---|
85 | public UpdateSelectionAction() {
|
---|
86 | super(tr("Update selection"), "updatedata",
|
---|
87 | tr("Updates the currently selected objects from the server (re-downloads data)"),
|
---|
88 | Shortcut.registerShortcut("file:updateselection",
|
---|
89 | tr("File: {0}", tr("Update selection")), KeyEvent.VK_U,
|
---|
90 | Shortcut.ALT_CTRL),
|
---|
91 | true, "updateselection", true);
|
---|
92 | putValue("help", ht("/Action/UpdateSelection"));
|
---|
93 | }
|
---|
94 |
|
---|
95 | /**
|
---|
96 | * Constructs a new {@code UpdateSelectionAction}.
|
---|
97 | *
|
---|
98 | * @param name the action's text as displayed on the menu (if it is added to a menu)
|
---|
99 | * @param iconName the filename of the icon to use
|
---|
100 | * @param tooltip a longer description of the action that will be displayed in the tooltip. Please note
|
---|
101 | * that html is not supported for menu actions on some platforms.
|
---|
102 | * @param shortcut a ready-created shortcut object or null if you don't want a shortcut. But you always
|
---|
103 | * do want a shortcut, remember you can always register it with group=none, so you
|
---|
104 | * won't be assigned a shortcut unless the user configures one. If you pass null here,
|
---|
105 | * the user CANNOT configure a shortcut for your action.
|
---|
106 | * @param register register this action for the toolbar preferences?
|
---|
107 | * @param toolbarId identifier for the toolbar preferences. The iconName is used, if this parameter is null
|
---|
108 | */
|
---|
109 | public UpdateSelectionAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean register, String toolbarId) {
|
---|
110 | super(name, iconName, tooltip, shortcut, register, toolbarId, true);
|
---|
111 | }
|
---|
112 |
|
---|
113 | @Override
|
---|
114 | protected void updateEnabledState() {
|
---|
115 | if (getCurrentDataSet() == null) {
|
---|
116 | setEnabled(false);
|
---|
117 | } else {
|
---|
118 | updateEnabledState(getCurrentDataSet().getAllSelected());
|
---|
119 | }
|
---|
120 | }
|
---|
121 |
|
---|
122 | @Override
|
---|
123 | protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
|
---|
124 | setEnabled(selection != null && !selection.isEmpty() && !Main.isOffline(OnlineResource.OSM_API));
|
---|
125 | }
|
---|
126 |
|
---|
127 | @Override
|
---|
128 | public void actionPerformed(ActionEvent e) {
|
---|
129 | if (!isEnabled())
|
---|
130 | return;
|
---|
131 | Collection<OsmPrimitive> toUpdate = getData();
|
---|
132 | if (toUpdate.isEmpty()) {
|
---|
133 | JOptionPane.showMessageDialog(
|
---|
134 | Main.parent,
|
---|
135 | tr("There are no selected objects to update."),
|
---|
136 | tr("Selection empty"),
|
---|
137 | JOptionPane.INFORMATION_MESSAGE
|
---|
138 | );
|
---|
139 | return;
|
---|
140 | }
|
---|
141 | updatePrimitives(toUpdate);
|
---|
142 | }
|
---|
143 |
|
---|
144 | /**
|
---|
145 | * Returns the data on which this action operates. Override if needed.
|
---|
146 | * @return the data on which this action operates
|
---|
147 | */
|
---|
148 | public Collection<OsmPrimitive> getData() {
|
---|
149 | return getCurrentDataSet().getAllSelected();
|
---|
150 | }
|
---|
151 | }
|
---|