source: josm/trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySelectionPanel.java@ 12452

Last change on this file since 12452 was 12370, checked in by michael2402, 7 years ago

Document upload dialog classes
  • Property svn:eol-style set to native
File size: 19.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.io;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trn;
6
7import java.awt.Color;
8import java.awt.Component;
9import java.awt.GridBagConstraints;
10import java.awt.GridBagLayout;
11import java.awt.Insets;
12import java.awt.event.ActionEvent;
13import java.awt.event.ActionListener;
14import java.awt.event.FocusAdapter;
15import java.awt.event.FocusEvent;
16import java.awt.event.ItemEvent;
17import java.awt.event.ItemListener;
18import java.beans.PropertyChangeEvent;
19import java.beans.PropertyChangeListener;
20import java.util.EnumMap;
21import java.util.Map;
22import java.util.Map.Entry;
23
24import javax.swing.BorderFactory;
25import javax.swing.ButtonGroup;
26import javax.swing.JLabel;
27import javax.swing.JPanel;
28import javax.swing.JRadioButton;
29import javax.swing.UIManager;
30import javax.swing.event.DocumentEvent;
31import javax.swing.event.DocumentListener;
32
33import org.openstreetmap.josm.Main;
34import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
35import org.openstreetmap.josm.gui.widgets.JosmTextField;
36import org.openstreetmap.josm.io.Capabilities;
37import org.openstreetmap.josm.io.OsmApi;
38
39/**
40 * UploadStrategySelectionPanel is a panel for selecting an upload strategy.
41 *
42 * Clients can listen for property change events for the property
43 * {@link #UPLOAD_STRATEGY_SPECIFICATION_PROP}.
44 */
45public class UploadStrategySelectionPanel extends JPanel implements PropertyChangeListener {
46
47 /**
48 * The property for the upload strategy
49 */
50 public static final String UPLOAD_STRATEGY_SPECIFICATION_PROP =
51 UploadStrategySelectionPanel.class.getName() + ".uploadStrategySpecification";
52
53 private static final Color BG_COLOR_ERROR = new Color(255, 224, 224);
54
55 private transient Map<UploadStrategy, JRadioButton> rbStrategy;
56 private transient Map<UploadStrategy, JLabel> lblNumRequests;
57 private transient Map<UploadStrategy, JMultilineLabel> lblStrategies;
58 private final JosmTextField tfChunkSize = new JosmTextField(4);
59 private final JPanel pnlMultiChangesetPolicyPanel = new JPanel(new GridBagLayout());
60 private final JRadioButton rbFillOneChangeset = new JRadioButton(
61 tr("Fill up one changeset and return to the Upload Dialog"));
62 private final JRadioButton rbUseMultipleChangesets = new JRadioButton(
63 tr("Open and use as many new changesets as necessary"));
64 private JMultilineLabel lblMultiChangesetPoliciesHeader;
65
66 private long numUploadedObjects;
67
68 /**
69 * Constructs a new {@code UploadStrategySelectionPanel}.
70 */
71 public UploadStrategySelectionPanel() {
72 build();
73 }
74
75 protected JPanel buildUploadStrategyPanel() {
76 JPanel pnl = new JPanel(new GridBagLayout());
77 ButtonGroup bgStrategies = new ButtonGroup();
78 rbStrategy = new EnumMap<>(UploadStrategy.class);
79 lblStrategies = new EnumMap<>(UploadStrategy.class);
80 lblNumRequests = new EnumMap<>(UploadStrategy.class);
81 for (UploadStrategy strategy: UploadStrategy.values()) {
82 rbStrategy.put(strategy, new JRadioButton());
83 lblNumRequests.put(strategy, new JLabel());
84 lblStrategies.put(strategy, new JMultilineLabel(""));
85 bgStrategies.add(rbStrategy.get(strategy));
86 }
87
88 // -- headline
89 GridBagConstraints gc = new GridBagConstraints();
90 gc.gridx = 0;
91 gc.gridy = 0;
92 gc.weightx = 1.0;
93 gc.weighty = 0.0;
94 gc.gridwidth = 4;
95 gc.fill = GridBagConstraints.HORIZONTAL;
96 gc.insets = new Insets(0, 0, 3, 0);
97 gc.anchor = GridBagConstraints.FIRST_LINE_START;
98 pnl.add(new JMultilineLabel(tr("Please select the upload strategy:")), gc);
99
100 // -- single request strategy
101 gc.gridx = 0;
102 gc.gridy = 1;
103 gc.weightx = 0.0;
104 gc.weighty = 0.0;
105 gc.gridwidth = 1;
106 gc.anchor = GridBagConstraints.FIRST_LINE_START;
107 pnl.add(rbStrategy.get(UploadStrategy.SINGLE_REQUEST_STRATEGY), gc);
108 gc.gridx = 1;
109 gc.gridy = 1;
110 gc.weightx = 1.0;
111 gc.weighty = 0.0;
112 gc.gridwidth = 2;
113 JMultilineLabel lbl = lblStrategies.get(UploadStrategy.SINGLE_REQUEST_STRATEGY);
114 lbl.setText(tr("Upload data in one request"));
115 pnl.add(lbl, gc);
116 gc.gridx = 3;
117 gc.gridy = 1;
118 gc.weightx = 0.0;
119 gc.weighty = 0.0;
120 gc.gridwidth = 1;
121 pnl.add(lblNumRequests.get(UploadStrategy.SINGLE_REQUEST_STRATEGY), gc);
122
123 // -- chunked dataset strategy
124 gc.gridx = 0;
125 gc.gridy = 2;
126 gc.weightx = 0.0;
127 gc.weighty = 0.0;
128 pnl.add(rbStrategy.get(UploadStrategy.CHUNKED_DATASET_STRATEGY), gc);
129 gc.gridx = 1;
130 gc.gridy = 2;
131 gc.weightx = 1.0;
132 gc.weighty = 0.0;
133 gc.gridwidth = 1;
134 lbl = lblStrategies.get(UploadStrategy.CHUNKED_DATASET_STRATEGY);
135 lbl.setText(tr("Upload data in chunks of objects. Chunk size: "));
136 pnl.add(lbl, gc);
137 gc.gridx = 2;
138 gc.gridy = 2;
139 gc.weightx = 0.0;
140 gc.weighty = 0.0;
141 gc.gridwidth = 1;
142 pnl.add(tfChunkSize, gc);
143 gc.gridx = 3;
144 gc.gridy = 2;
145 gc.weightx = 0.0;
146 gc.weighty = 0.0;
147 gc.gridwidth = 1;
148 pnl.add(lblNumRequests.get(UploadStrategy.CHUNKED_DATASET_STRATEGY), gc);
149
150 // -- single request strategy
151 gc.gridx = 0;
152 gc.gridy = 3;
153 gc.weightx = 0.0;
154 gc.weighty = 0.0;
155 pnl.add(rbStrategy.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY), gc);
156 gc.gridx = 1;
157 gc.gridy = 3;
158 gc.weightx = 1.0;
159 gc.weighty = 0.0;
160 gc.gridwidth = 2;
161 lbl = lblStrategies.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY);
162 lbl.setText(tr("Upload each object individually"));
163 pnl.add(lbl, gc);
164 gc.gridx = 3;
165 gc.gridy = 3;
166 gc.weightx = 0.0;
167 gc.weighty = 0.0;
168 gc.gridwidth = 1;
169 pnl.add(lblNumRequests.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY), gc);
170
171 tfChunkSize.addFocusListener(new TextFieldFocusHandler());
172 tfChunkSize.getDocument().addDocumentListener(new ChunkSizeInputVerifier());
173
174 StrategyChangeListener strategyChangeListener = new StrategyChangeListener();
175 tfChunkSize.addFocusListener(strategyChangeListener);
176 tfChunkSize.addActionListener(strategyChangeListener);
177 for (UploadStrategy strategy: UploadStrategy.values()) {
178 rbStrategy.get(strategy).addItemListener(strategyChangeListener);
179 }
180
181 return pnl;
182 }
183
184 protected JPanel buildMultiChangesetPolicyPanel() {
185 GridBagConstraints gc = new GridBagConstraints();
186 gc.gridx = 0;
187 gc.gridy = 0;
188 gc.fill = GridBagConstraints.HORIZONTAL;
189 gc.anchor = GridBagConstraints.FIRST_LINE_START;
190 gc.weightx = 1.0;
191 lblMultiChangesetPoliciesHeader = new JMultilineLabel(
192 tr("<html>There are <strong>multiple changesets</strong> necessary in order to upload {0} objects. " +
193 "Which strategy do you want to use?</html>",
194 numUploadedObjects));
195 pnlMultiChangesetPolicyPanel.add(lblMultiChangesetPoliciesHeader, gc);
196 gc.gridy = 1;
197 pnlMultiChangesetPolicyPanel.add(rbFillOneChangeset, gc);
198 gc.gridy = 2;
199 pnlMultiChangesetPolicyPanel.add(rbUseMultipleChangesets, gc);
200
201 ButtonGroup bgMultiChangesetPolicies = new ButtonGroup();
202 bgMultiChangesetPolicies.add(rbFillOneChangeset);
203 bgMultiChangesetPolicies.add(rbUseMultipleChangesets);
204 return pnlMultiChangesetPolicyPanel;
205 }
206
207 protected void build() {
208 setLayout(new GridBagLayout());
209 GridBagConstraints gc = new GridBagConstraints();
210 gc.gridx = 0;
211 gc.gridy = 0;
212 gc.fill = GridBagConstraints.HORIZONTAL;
213 gc.weightx = 1.0;
214 gc.weighty = 0.0;
215 gc.anchor = GridBagConstraints.NORTHWEST;
216 gc.insets = new Insets(3, 3, 3, 3);
217
218 add(buildUploadStrategyPanel(), gc);
219 gc.gridy = 1;
220 add(buildMultiChangesetPolicyPanel(), gc);
221
222 // consume remaining space
223 gc.gridy = 2;
224 gc.fill = GridBagConstraints.BOTH;
225 gc.weightx = 1.0;
226 gc.weighty = 1.0;
227 add(new JPanel(), gc);
228
229 Capabilities capabilities = OsmApi.getOsmApi().getCapabilities();
230 int maxChunkSize = capabilities != null ? capabilities.getMaxChangesetSize() : -1;
231 pnlMultiChangesetPolicyPanel.setVisible(
232 maxChunkSize > 0 && numUploadedObjects > maxChunkSize
233 );
234 }
235
236 /**
237 * Sets the number of uploaded objects to display
238 * @param numUploadedObjects The number of objects
239 */
240 public void setNumUploadedObjects(int numUploadedObjects) {
241 this.numUploadedObjects = Math.max(numUploadedObjects, 0);
242 updateNumRequestsLabels();
243 }
244
245 /**
246 * Fills the inputs using a {@link UploadStrategySpecification}
247 * @param strategy The strategy
248 */
249 public void setUploadStrategySpecification(UploadStrategySpecification strategy) {
250 if (strategy == null)
251 return;
252 rbStrategy.get(strategy.getStrategy()).setSelected(true);
253 tfChunkSize.setEnabled(strategy.getStrategy() == UploadStrategy.CHUNKED_DATASET_STRATEGY);
254 if (strategy.getStrategy().equals(UploadStrategy.CHUNKED_DATASET_STRATEGY)) {
255 if (strategy.getChunkSize() != UploadStrategySpecification.UNSPECIFIED_CHUNK_SIZE) {
256 tfChunkSize.setText(Integer.toString(strategy.getChunkSize()));
257 } else {
258 tfChunkSize.setText("1");
259 }
260 }
261 }
262
263 /**
264 * Gets the upload strategy the user chose
265 * @return The strategy
266 */
267 public UploadStrategySpecification getUploadStrategySpecification() {
268 UploadStrategy strategy = getUploadStrategy();
269 UploadStrategySpecification spec = new UploadStrategySpecification();
270 if (strategy != null) {
271 switch(strategy) {
272 case CHUNKED_DATASET_STRATEGY:
273 spec.setStrategy(strategy).setChunkSize(getChunkSize());
274 break;
275 case INDIVIDUAL_OBJECTS_STRATEGY:
276 case SINGLE_REQUEST_STRATEGY:
277 default:
278 spec.setStrategy(strategy);
279 break;
280 }
281 }
282 if (pnlMultiChangesetPolicyPanel.isVisible()) {
283 if (rbFillOneChangeset.isSelected()) {
284 spec.setPolicy(MaxChangesetSizeExceededPolicy.FILL_ONE_CHANGESET_AND_RETURN_TO_UPLOAD_DIALOG);
285 } else if (rbUseMultipleChangesets.isSelected()) {
286 spec.setPolicy(MaxChangesetSizeExceededPolicy.AUTOMATICALLY_OPEN_NEW_CHANGESETS);
287 } else {
288 spec.setPolicy(null); // unknown policy
289 }
290 } else {
291 spec.setPolicy(null);
292 }
293 return spec;
294 }
295
296 protected UploadStrategy getUploadStrategy() {
297 UploadStrategy strategy = null;
298 for (Entry<UploadStrategy, JRadioButton> e : rbStrategy.entrySet()) {
299 if (e.getValue().isSelected()) {
300 strategy = e.getKey();
301 break;
302 }
303 }
304 return strategy;
305 }
306
307 protected int getChunkSize() {
308 try {
309 return Integer.parseInt(tfChunkSize.getText().trim());
310 } catch (NumberFormatException e) {
311 return UploadStrategySpecification.UNSPECIFIED_CHUNK_SIZE;
312 }
313 }
314
315 /**
316 * Load the panel contents from preferences
317 */
318 public void initFromPreferences() {
319 UploadStrategy strategy = UploadStrategy.getFromPreferences();
320 rbStrategy.get(strategy).setSelected(true);
321 int chunkSize = Main.pref.getInteger("osm-server.upload-strategy.chunk-size", 1);
322 tfChunkSize.setText(Integer.toString(chunkSize));
323 updateNumRequestsLabels();
324 }
325
326 /**
327 * Stores the values that the user has input into the preferences
328 */
329 public void rememberUserInput() {
330 UploadStrategy strategy = getUploadStrategy();
331 UploadStrategy.saveToPreferences(strategy);
332 int chunkSize;
333 try {
334 chunkSize = Integer.parseInt(tfChunkSize.getText().trim());
335 Main.pref.putInteger("osm-server.upload-strategy.chunk-size", chunkSize);
336 } catch (NumberFormatException e) {
337 // don't save invalid value to preferences
338 Main.trace(e);
339 }
340 }
341
342 protected void updateNumRequestsLabels() {
343 int maxChunkSize = OsmApi.getOsmApi().getCapabilities().getMaxChangesetSize();
344 if (maxChunkSize > 0 && numUploadedObjects > maxChunkSize) {
345 rbStrategy.get(UploadStrategy.SINGLE_REQUEST_STRATEGY).setEnabled(false);
346 JMultilineLabel lbl = lblStrategies.get(UploadStrategy.SINGLE_REQUEST_STRATEGY);
347 lbl.setText(tr("Upload in one request not possible (too many objects to upload)"));
348 lbl.setToolTipText(tr("<html>Cannot upload {0} objects in one request because the<br>"
349 + "max. changeset size {1} on server ''{2}'' is exceeded.</html>",
350 numUploadedObjects, maxChunkSize, OsmApi.getOsmApi().getBaseUrl()
351 )
352 );
353 rbStrategy.get(UploadStrategy.CHUNKED_DATASET_STRATEGY).setSelected(true);
354 lblNumRequests.get(UploadStrategy.SINGLE_REQUEST_STRATEGY).setVisible(false);
355
356 lblMultiChangesetPoliciesHeader.setText(
357 tr("<html>There are <strong>multiple changesets</strong> necessary in order to upload {0} objects. " +
358 "Which strategy do you want to use?</html>",
359 numUploadedObjects));
360 if (!rbFillOneChangeset.isSelected() && !rbUseMultipleChangesets.isSelected()) {
361 rbUseMultipleChangesets.setSelected(true);
362 }
363 pnlMultiChangesetPolicyPanel.setVisible(true);
364
365 } else {
366 rbStrategy.get(UploadStrategy.SINGLE_REQUEST_STRATEGY).setEnabled(true);
367 JMultilineLabel lbl = lblStrategies.get(UploadStrategy.SINGLE_REQUEST_STRATEGY);
368 lbl.setText(tr("Upload data in one request"));
369 lbl.setToolTipText(null);
370 lblNumRequests.get(UploadStrategy.SINGLE_REQUEST_STRATEGY).setVisible(true);
371
372 pnlMultiChangesetPolicyPanel.setVisible(false);
373 }
374
375 lblNumRequests.get(UploadStrategy.SINGLE_REQUEST_STRATEGY).setText(tr("(1 request)"));
376 if (numUploadedObjects == 0) {
377 lblNumRequests.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY).setText(tr("(# requests unknown)"));
378 lblNumRequests.get(UploadStrategy.CHUNKED_DATASET_STRATEGY).setText(tr("(# requests unknown)"));
379 } else {
380 lblNumRequests.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY).setText(
381 trn("({0} request)", "({0} requests)", numUploadedObjects, numUploadedObjects)
382 );
383 lblNumRequests.get(UploadStrategy.CHUNKED_DATASET_STRATEGY).setText(tr("(# requests unknown)"));
384 int chunkSize = getChunkSize();
385 if (chunkSize == UploadStrategySpecification.UNSPECIFIED_CHUNK_SIZE) {
386 lblNumRequests.get(UploadStrategy.CHUNKED_DATASET_STRATEGY).setText(tr("(# requests unknown)"));
387 } else {
388 int chunks = (int) Math.ceil((double) numUploadedObjects / (double) chunkSize);
389 lblNumRequests.get(UploadStrategy.CHUNKED_DATASET_STRATEGY).setText(
390 trn("({0} request)", "({0} requests)", chunks, chunks)
391 );
392 }
393 }
394 }
395
396 /**
397 * Sets the focus on the chunk size field
398 */
399 public void initEditingOfChunkSize() {
400 tfChunkSize.requestFocusInWindow();
401 }
402
403 @Override
404 public void propertyChange(PropertyChangeEvent evt) {
405 if (evt.getPropertyName().equals(UploadedObjectsSummaryPanel.NUM_OBJECTS_TO_UPLOAD_PROP)) {
406 setNumUploadedObjects((Integer) evt.getNewValue());
407 }
408 }
409
410 static class TextFieldFocusHandler extends FocusAdapter {
411 @Override
412 public void focusGained(FocusEvent e) {
413 Component c = e.getComponent();
414 if (c instanceof JosmTextField) {
415 JosmTextField tf = (JosmTextField) c;
416 tf.selectAll();
417 }
418 }
419 }
420
421 class ChunkSizeInputVerifier implements DocumentListener, PropertyChangeListener {
422 protected void setErrorFeedback(JosmTextField tf, String message) {
423 tf.setBorder(BorderFactory.createLineBorder(Color.RED, 1));
424 tf.setToolTipText(message);
425 tf.setBackground(BG_COLOR_ERROR);
426 }
427
428 protected void clearErrorFeedback(JosmTextField tf, String message) {
429 tf.setBorder(UIManager.getBorder("TextField.border"));
430 tf.setToolTipText(message);
431 tf.setBackground(UIManager.getColor("TextField.background"));
432 }
433
434 protected void validateChunkSize() {
435 try {
436 int chunkSize = Integer.parseInt(tfChunkSize.getText().trim());
437 int maxChunkSize = OsmApi.getOsmApi().getCapabilities().getMaxChangesetSize();
438 if (chunkSize <= 0) {
439 setErrorFeedback(tfChunkSize, tr("Illegal chunk size <= 0. Please enter an integer > 1"));
440 } else if (maxChunkSize > 0 && chunkSize > maxChunkSize) {
441 setErrorFeedback(tfChunkSize, tr("Chunk size {0} exceeds max. changeset size {1} for server ''{2}''",
442 chunkSize, maxChunkSize, OsmApi.getOsmApi().getBaseUrl()));
443 } else {
444 clearErrorFeedback(tfChunkSize, tr("Please enter an integer > 1"));
445 }
446
447 if (maxChunkSize > 0 && chunkSize > maxChunkSize) {
448 setErrorFeedback(tfChunkSize, tr("Chunk size {0} exceeds max. changeset size {1} for server ''{2}''",
449 chunkSize, maxChunkSize, OsmApi.getOsmApi().getBaseUrl()));
450 }
451 } catch (NumberFormatException e) {
452 setErrorFeedback(tfChunkSize, tr("Value ''{0}'' is not a number. Please enter an integer > 1",
453 tfChunkSize.getText().trim()));
454 } finally {
455 updateNumRequestsLabels();
456 }
457 }
458
459 @Override
460 public void changedUpdate(DocumentEvent arg0) {
461 validateChunkSize();
462 }
463
464 @Override
465 public void insertUpdate(DocumentEvent arg0) {
466 validateChunkSize();
467 }
468
469 @Override
470 public void removeUpdate(DocumentEvent arg0) {
471 validateChunkSize();
472 }
473
474 @Override
475 public void propertyChange(PropertyChangeEvent evt) {
476 if (evt.getSource() == tfChunkSize
477 && "enabled".equals(evt.getPropertyName())
478 && (Boolean) evt.getNewValue()
479 ) {
480 validateChunkSize();
481 }
482 }
483 }
484
485 class StrategyChangeListener extends FocusAdapter implements ItemListener, ActionListener {
486
487 protected void notifyStrategy() {
488 firePropertyChange(UPLOAD_STRATEGY_SPECIFICATION_PROP, null, getUploadStrategySpecification());
489 }
490
491 @Override
492 public void itemStateChanged(ItemEvent e) {
493 UploadStrategy strategy = getUploadStrategy();
494 if (strategy == null)
495 return;
496 switch(strategy) {
497 case CHUNKED_DATASET_STRATEGY:
498 tfChunkSize.setEnabled(true);
499 tfChunkSize.requestFocusInWindow();
500 break;
501 default:
502 tfChunkSize.setEnabled(false);
503 }
504 notifyStrategy();
505 }
506
507 @Override
508 public void focusLost(FocusEvent arg0) {
509 notifyStrategy();
510 }
511
512 @Override
513 public void actionPerformed(ActionEvent arg0) {
514 notifyStrategy();
515 }
516 }
517}
Note: See TracBrowser for help on using the repository browser.