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

Last change on this file since 9543 was 9543, checked in by Don-vip, 8 years ago

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