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

Last change on this file since 16438 was 16438, checked in by simon04, 4 years ago

see #19251 - Java 8: use Stream
  • Property svn:eol-style set to native
File size: 19.9 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.gui.widgets.JMultilineLabel;
34import org.openstreetmap.josm.gui.widgets.JosmTextField;
35import org.openstreetmap.josm.io.Capabilities;
36import org.openstreetmap.josm.io.MaxChangesetSizeExceededPolicy;
37import org.openstreetmap.josm.io.OsmApi;
38import org.openstreetmap.josm.io.UploadStrategy;
39import org.openstreetmap.josm.io.UploadStrategySpecification;
40import org.openstreetmap.josm.spi.preferences.Config;
41import org.openstreetmap.josm.tools.Logging;
42
43/**
44 * UploadStrategySelectionPanel is a panel for selecting an upload strategy.
45 *
46 * Clients can listen for property change events for the property
47 * {@link #UPLOAD_STRATEGY_SPECIFICATION_PROP}.
48 */
49public class UploadStrategySelectionPanel extends JPanel implements PropertyChangeListener {
50
51 /**
52 * The property for the upload strategy
53 */
54 public static final String UPLOAD_STRATEGY_SPECIFICATION_PROP =
55 UploadStrategySelectionPanel.class.getName() + ".uploadStrategySpecification";
56
57 private static final Color BG_COLOR_ERROR = new Color(255, 224, 224);
58
59 private transient Map<UploadStrategy, JRadioButton> rbStrategy;
60 private transient Map<UploadStrategy, JLabel> lblNumRequests;
61 private transient Map<UploadStrategy, JMultilineLabel> lblStrategies;
62 private final JosmTextField tfChunkSize = new JosmTextField(4);
63 private final JPanel pnlMultiChangesetPolicyPanel = new JPanel(new GridBagLayout());
64 private final JRadioButton rbFillOneChangeset = new JRadioButton(
65 tr("Fill up one changeset and return to the Upload Dialog"));
66 private final JRadioButton rbUseMultipleChangesets = new JRadioButton(
67 tr("Open and use as many new changesets as necessary"));
68 private JMultilineLabel lblMultiChangesetPoliciesHeader;
69
70 private long numUploadedObjects;
71
72 /**
73 * Constructs a new {@code UploadStrategySelectionPanel}.
74 */
75 public UploadStrategySelectionPanel() {
76 build();
77 }
78
79 protected JPanel buildUploadStrategyPanel() {
80 JPanel pnl = new JPanel(new GridBagLayout());
81 ButtonGroup bgStrategies = new ButtonGroup();
82 rbStrategy = new EnumMap<>(UploadStrategy.class);
83 lblStrategies = new EnumMap<>(UploadStrategy.class);
84 lblNumRequests = new EnumMap<>(UploadStrategy.class);
85 for (UploadStrategy strategy: UploadStrategy.values()) {
86 rbStrategy.put(strategy, new JRadioButton());
87 lblNumRequests.put(strategy, new JLabel());
88 lblStrategies.put(strategy, new JMultilineLabel(""));
89 bgStrategies.add(rbStrategy.get(strategy));
90 }
91
92 // -- headline
93 GridBagConstraints gc = new GridBagConstraints();
94 gc.gridx = 0;
95 gc.gridy = 0;
96 gc.weightx = 1.0;
97 gc.weighty = 0.0;
98 gc.gridwidth = 4;
99 gc.fill = GridBagConstraints.HORIZONTAL;
100 gc.insets = new Insets(0, 0, 3, 0);
101 gc.anchor = GridBagConstraints.FIRST_LINE_START;
102 pnl.add(new JMultilineLabel(tr("Please select the upload strategy:")), gc);
103
104 // -- single request strategy
105 gc.gridx = 0;
106 gc.gridy = 1;
107 gc.weightx = 0.0;
108 gc.weighty = 0.0;
109 gc.gridwidth = 1;
110 gc.anchor = GridBagConstraints.FIRST_LINE_START;
111 pnl.add(rbStrategy.get(UploadStrategy.SINGLE_REQUEST_STRATEGY), gc);
112 gc.gridx = 1;
113 gc.gridy = 1;
114 gc.weightx = 1.0;
115 gc.weighty = 0.0;
116 gc.gridwidth = 2;
117 JMultilineLabel lbl = lblStrategies.get(UploadStrategy.SINGLE_REQUEST_STRATEGY);
118 lbl.setText(tr("Upload data in one request"));
119 pnl.add(lbl, gc);
120 gc.gridx = 3;
121 gc.gridy = 1;
122 gc.weightx = 0.0;
123 gc.weighty = 0.0;
124 gc.gridwidth = 1;
125 pnl.add(lblNumRequests.get(UploadStrategy.SINGLE_REQUEST_STRATEGY), gc);
126
127 // -- chunked dataset strategy
128 gc.gridx = 0;
129 gc.gridy = 2;
130 gc.weightx = 0.0;
131 gc.weighty = 0.0;
132 pnl.add(rbStrategy.get(UploadStrategy.CHUNKED_DATASET_STRATEGY), gc);
133 gc.gridx = 1;
134 gc.gridy = 2;
135 gc.weightx = 1.0;
136 gc.weighty = 0.0;
137 gc.gridwidth = 1;
138 lbl = lblStrategies.get(UploadStrategy.CHUNKED_DATASET_STRATEGY);
139 lbl.setText(tr("Upload data in chunks of objects. Chunk size: "));
140 pnl.add(lbl, gc);
141 gc.gridx = 2;
142 gc.gridy = 2;
143 gc.weightx = 0.0;
144 gc.weighty = 0.0;
145 gc.gridwidth = 1;
146 pnl.add(tfChunkSize, gc);
147 gc.gridx = 3;
148 gc.gridy = 2;
149 gc.weightx = 0.0;
150 gc.weighty = 0.0;
151 gc.gridwidth = 1;
152 pnl.add(lblNumRequests.get(UploadStrategy.CHUNKED_DATASET_STRATEGY), gc);
153
154 // -- single request strategy
155 gc.gridx = 0;
156 gc.gridy = 3;
157 gc.weightx = 0.0;
158 gc.weighty = 0.0;
159 pnl.add(rbStrategy.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY), gc);
160 gc.gridx = 1;
161 gc.gridy = 3;
162 gc.weightx = 1.0;
163 gc.weighty = 0.0;
164 gc.gridwidth = 2;
165 lbl = lblStrategies.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY);
166 lbl.setText(tr("Upload each object individually"));
167 pnl.add(lbl, gc);
168 gc.gridx = 3;
169 gc.gridy = 3;
170 gc.weightx = 0.0;
171 gc.weighty = 0.0;
172 gc.gridwidth = 1;
173 pnl.add(lblNumRequests.get(UploadStrategy.INDIVIDUAL_OBJECTS_STRATEGY), gc);
174
175 tfChunkSize.addFocusListener(new TextFieldFocusHandler());
176 tfChunkSize.getDocument().addDocumentListener(new ChunkSizeInputVerifier());
177
178 StrategyChangeListener strategyChangeListener = new StrategyChangeListener();
179 tfChunkSize.addFocusListener(strategyChangeListener);
180 tfChunkSize.addActionListener(strategyChangeListener);
181 for (UploadStrategy strategy: UploadStrategy.values()) {
182 rbStrategy.get(strategy).addItemListener(strategyChangeListener);
183 }
184
185 return pnl;
186 }
187
188 protected JPanel buildMultiChangesetPolicyPanel() {
189 GridBagConstraints gc = new GridBagConstraints();
190 gc.gridx = 0;
191 gc.gridy = 0;
192 gc.fill = GridBagConstraints.HORIZONTAL;
193 gc.anchor = GridBagConstraints.FIRST_LINE_START;
194 gc.weightx = 1.0;
195 lblMultiChangesetPoliciesHeader = new JMultilineLabel(
196 tr("<html>There are <strong>multiple changesets</strong> necessary in order to upload {0} objects. " +
197 "Which strategy do you want to use?</html>",
198 numUploadedObjects));
199 pnlMultiChangesetPolicyPanel.add(lblMultiChangesetPoliciesHeader, gc);
200 gc.gridy = 1;
201 pnlMultiChangesetPolicyPanel.add(rbFillOneChangeset, gc);
202 gc.gridy = 2;
203 pnlMultiChangesetPolicyPanel.add(rbUseMultipleChangesets, gc);
204
205 ButtonGroup bgMultiChangesetPolicies = new ButtonGroup();
206 bgMultiChangesetPolicies.add(rbFillOneChangeset);
207 bgMultiChangesetPolicies.add(rbUseMultipleChangesets);
208 return pnlMultiChangesetPolicyPanel;
209 }
210
211 protected void build() {
212 setLayout(new GridBagLayout());
213 GridBagConstraints gc = new GridBagConstraints();
214 gc.gridx = 0;
215 gc.gridy = 0;
216 gc.fill = GridBagConstraints.HORIZONTAL;
217 gc.weightx = 1.0;
218 gc.weighty = 0.0;
219 gc.anchor = GridBagConstraints.NORTHWEST;
220 gc.insets = new Insets(3, 3, 3, 3);
221
222 add(buildUploadStrategyPanel(), gc);
223 gc.gridy = 1;
224 add(buildMultiChangesetPolicyPanel(), gc);
225
226 // consume remaining space
227 gc.gridy = 2;
228 gc.fill = GridBagConstraints.BOTH;
229 gc.weightx = 1.0;
230 gc.weighty = 1.0;
231 add(new JPanel(), gc);
232
233 Capabilities capabilities = OsmApi.getOsmApi().getCapabilities();
234 int maxChunkSize = capabilities != null ? capabilities.getMaxChangesetSize() : -1;
235 pnlMultiChangesetPolicyPanel.setVisible(
236 maxChunkSize > 0 && numUploadedObjects > maxChunkSize
237 );
238 }
239
240 /**
241 * Sets the number of uploaded objects to display
242 * @param numUploadedObjects The number of objects
243 */
244 public void setNumUploadedObjects(int numUploadedObjects) {
245 this.numUploadedObjects = Math.max(numUploadedObjects, 0);
246 updateNumRequestsLabels();
247 }
248
249 /**
250 * Fills the inputs using a {@link UploadStrategySpecification}
251 * @param strategy The strategy
252 */
253 public void setUploadStrategySpecification(UploadStrategySpecification strategy) {
254 if (strategy == null)
255 return;
256 rbStrategy.get(strategy.getStrategy()).setSelected(true);
257 tfChunkSize.setEnabled(strategy.getStrategy() == UploadStrategy.CHUNKED_DATASET_STRATEGY);
258 if (strategy.getStrategy() == UploadStrategy.CHUNKED_DATASET_STRATEGY) {
259 if (strategy.getChunkSize() != UploadStrategySpecification.UNSPECIFIED_CHUNK_SIZE) {
260 tfChunkSize.setText(Integer.toString(strategy.getChunkSize()));
261 } else {
262 tfChunkSize.setText("1");
263 }
264 }
265 }
266
267 /**
268 * Gets the upload strategy the user chose
269 * @return The strategy
270 */
271 public UploadStrategySpecification getUploadStrategySpecification() {
272 UploadStrategy strategy = getUploadStrategy();
273 UploadStrategySpecification spec = new UploadStrategySpecification();
274 if (strategy != null) {
275 switch(strategy) {
276 case CHUNKED_DATASET_STRATEGY:
277 spec.setStrategy(strategy).setChunkSize(getChunkSize());
278 break;
279 case INDIVIDUAL_OBJECTS_STRATEGY:
280 case SINGLE_REQUEST_STRATEGY:
281 default:
282 spec.setStrategy(strategy);
283 break;
284 }
285 }
286 if (pnlMultiChangesetPolicyPanel.isVisible()) {
287 if (rbFillOneChangeset.isSelected()) {
288 spec.setPolicy(MaxChangesetSizeExceededPolicy.FILL_ONE_CHANGESET_AND_RETURN_TO_UPLOAD_DIALOG);
289 } else if (rbUseMultipleChangesets.isSelected()) {
290 spec.setPolicy(MaxChangesetSizeExceededPolicy.AUTOMATICALLY_OPEN_NEW_CHANGESETS);
291 } else {
292 spec.setPolicy(null); // unknown policy
293 }
294 } else {
295 spec.setPolicy(null);
296 }
297 return spec;
298 }
299
300 protected UploadStrategy getUploadStrategy() {
301 return rbStrategy.entrySet().stream()
302 .filter(e -> e.getValue().isSelected())
303 .map(Entry::getKey)
304 .findFirst().orElse(null);
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 = Config.getPref().getInt("osm-server.upload-strategy.chunk-size", 1000);
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 Config.getPref().putInt("osm-server.upload-strategy.chunk-size", chunkSize);
336 } catch (NumberFormatException e) {
337 // don't save invalid value to preferences
338 Logging.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 e) {
461 validateChunkSize();
462 }
463
464 @Override
465 public void insertUpdate(DocumentEvent e) {
466 validateChunkSize();
467 }
468
469 @Override
470 public void removeUpdate(DocumentEvent e) {
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 e) {
509 notifyStrategy();
510 }
511
512 @Override
513 public void actionPerformed(ActionEvent e) {
514 notifyStrategy();
515 }
516 }
517}
Note: See TracBrowser for help on using the repository browser.