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

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

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