Changeset 8218 in josm for trunk/src/org/openstreetmap

Timestamp:

2015-04-18T12:33:06+02:00 (9 years ago)

Author:

simon04

Message:

fix #10868 - Add osm.notes.daysClosed to preference dialog

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/downloadtasks/DownloadNotesTask.java (modified) (3 diffs)
• gui/preferences/server/AuthenticationPreferencesPanel.java (modified) (5 diffs)
• gui/preferences/server/FeaturesPanel.java (moved) (moved from trunk/src/org/openstreetmap/josm/gui/preferences/server/MessagesNotifierPanel.java ) (6 diffs)
• io/BoundingBoxDownloader.java (modified) (3 diffs)
• io/OsmServerReader.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesTask.java

@@ -15 +15 @@
 import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.notes.Note;
+import org.openstreetmap.josm.data.preferences.IntegerProperty;
 import org.openstreetmap.josm.gui.PleaseWaitRunnable;
 import org.openstreetmap.josm.gui.layer.NoteLayer;
@@ -30 +31 @@
     private static final String PATTERN_API_URL = "https?://.*/api/0.6/notes.*";
     private static final String PATTERN_DUMP_FILE = "https?://.*/(.*\\.osn(.bz2)?)";
+    /** Property defining the number of notes to be downloaded */
+    public static final IntegerProperty DOWNLOAD_LIMIT = new IntegerProperty("osm.notes.downloadLimit", 1000);
+    /** Property defining number of days a bug needs to be closed to no longer be downloaded */
+    public static final IntegerProperty DAYS_CLOSED = new IntegerProperty("osm.notes.daysClosed", 7);
 
     private DownloadTask downloadTask;
@@ -143 +148 @@
             ProgressMonitor subMonitor = progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false);
             try {
-                notesData = reader.parseNotes(null, null, subMonitor);
+                notesData = reader.parseNotes(DOWNLOAD_LIMIT.get(), DAYS_CLOSED.get(), subMonitor);
             } catch (BoundingBoxDownloader.MoreNotesException e) {
                 notesData = e.notes;

trunk/src/org/openstreetmap/josm/gui/preferences/server/AuthenticationPreferencesPanel.java

@@ -16 +16 @@
 import javax.swing.JPanel;
 import javax.swing.JRadioButton;
+import javax.swing.JSeparator;
 
 import org.openstreetmap.josm.Main;
@@ -42 +43 @@
     private OAuthAuthenticationPreferencesPanel pnlOAuthPreferences;
     /** the panel for messages notifier preferences */
-    private MessagesNotifierPanel pnlMessagesPreferences;
+    private FeaturesPanel pnlFeaturesPreferences;
 
     /**
@@ -94 +95 @@
         pnlAuthenticationParameteters.add(pnlBasicAuthPreferences, BorderLayout.CENTER);
 
-        //-- the panel for messages preferences
         gc.gridy = 2;
+        add(new JSeparator(), gc);
+
+        //-- the panel for API feature preferences
+        gc.gridy = 3;
         gc.fill = GridBagConstraints.NONE;
-        pnlMessagesPreferences = new MessagesNotifierPanel();
-        add(pnlMessagesPreferences, gc);
+        pnlFeaturesPreferences = new FeaturesPanel();
+        add(pnlFeaturesPreferences, gc);
     }
 
@@ -125 +129 @@
         pnlBasicAuthPreferences.initFromPreferences();
         pnlOAuthPreferences.initFromPreferences();
-        pnlMessagesPreferences.initFromPreferences();
+        pnlFeaturesPreferences.initFromPreferences();
     }
 
@@ -152 +156 @@
         }
         // save message notifications preferences. To be done after authentication preferences.
-        pnlMessagesPreferences.saveToPreferences();
+        pnlFeaturesPreferences.saveToPreferences();
     }
 

trunk/src/org/openstreetmap/josm/gui/preferences/server/FeaturesPanel.java

@@ -13 +13 @@
 import javax.swing.event.ChangeListener;
 
+import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesTask;
 import org.openstreetmap.josm.gui.widgets.JosmTextField;
 import org.openstreetmap.josm.io.MessageNotifier;
@@ -21 +22 @@
  * @since 6349
  */
-public class MessagesNotifierPanel extends JPanel {
+public class FeaturesPanel extends JPanel {
 
     private JCheckBox notifier;
     private JLabel intervalLabel;
     private final JosmTextField notifierInterval = new JosmTextField(4);
+    private final JosmTextField notesDaysClosed = new JosmTextField(4);
 
     /**
      * Constructs a new {@code MessagesNotifierPanel}.
      */
-    public MessagesNotifierPanel() {
+    public FeaturesPanel() {
         build();
         initFromPreferences();
@@ -50 +52 @@
         
         intervalLabel = new JLabel(tr("Check interval (minutes):"));
-        add(intervalLabel, GBC.std().insets(25,0,0,0));
+        add(intervalLabel, GBC.std().insets(25, 0, 0, 0));
 
         notifierInterval.setToolTipText(tr("Default value: {0}", MessageNotifier.PROP_INTERVAL.getDefaultValue()));
         notifierInterval.setMinimumSize(notifierInterval.getPreferredSize());
         add(notifierInterval, GBC.eol().insets(5,0,0,0));
+
+        final JLabel notesDaysClosedLabel = new JLabel(tr("Max age for closed notes (days):"));
+        notesDaysClosedLabel.setToolTipText(tr("Specifies the number of days a note needs to be closed to no longer be downloaded"));
+        add(notesDaysClosedLabel, GBC.std().insets(0, 20, 0, 0));
+        notesDaysClosed.setToolTipText(tr("Default value: {0}", DownloadNotesTask.DAYS_CLOSED.getDefaultValue()));
+        notesDaysClosed.setMinimumSize(notesDaysClosed.getPreferredSize());
+        add(notesDaysClosed, GBC.eol().insets(5, 20, 0, 0));
+
     }
     
@@ -62 +72 @@
         notifierInterval.setEnabled(enabled);
         notifierInterval.setEditable(enabled);
+        notesDaysClosed.setEditable(enabled);
     }
 
@@ -70 +81 @@
         notifier.setSelected(MessageNotifier.PROP_NOTIFIER_ENABLED.get());
         notifierInterval.setText(Integer.toString(MessageNotifier.PROP_INTERVAL.get()));
+        notesDaysClosed.setText(Integer.toString(DownloadNotesTask.DAYS_CLOSED.get()));
     }
 
@@ -79 +91 @@
         boolean changed = MessageNotifier.PROP_NOTIFIER_ENABLED.put(enabled);
         changed |= MessageNotifier.PROP_INTERVAL.parseAndPut(notifierInterval.getText());
+        changed |= DownloadNotesTask.DAYS_CLOSED.parseAndPut(notesDaysClosed.getText());
         // If parameters have changed, restart notifier
         if (changed) {

trunk/src/org/openstreetmap/josm/io/BoundingBoxDownloader.java

@@ -8 +8 @@
 import java.util.List;
 
-import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.DataSource;
@@ -162 +161 @@
 
     @Override
-    public List<Note> parseNotes(Integer noteLimit, Integer daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException, MoreNotesException {
+    public List<Note> parseNotes(int noteLimit, int daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException, MoreNotesException {
         progressMonitor.beginTask("Downloading notes");
-        noteLimit = checkNoteLimit(noteLimit);
-        daysClosed = checkDaysClosed(daysClosed);
-        String url = new StringBuilder()
-        .append("notes?limit=")
-        .append(noteLimit)
-        .append("&closed=")
-        .append(daysClosed)
-        .append("&bbox=")
-        .append(lon1)
-        .append(",").append(lat1)
-        .append(",").append(lon2)
-        .append(",").append(lat2)
-        .toString();
+        CheckParameterUtil.ensureThat(noteLimit > 0, "Requested note limit is less than 1.");
+        // see max_number_of_nodes in https://github.com/openstreetmap/openstreetmap-website/blob/master/config/example.application.yml
+        CheckParameterUtil.ensureThat(noteLimit <= 50000, "Requested note limit is over API hard limit of 50000.");
+        CheckParameterUtil.ensureThat(daysClosed >= 0, "Requested note limit is less than 0.");
+        String url = "notes?limit=" + noteLimit + "&closed=" + daysClosed + "&bbox=" + lon1 + "," + lat1 + "," + lon2 + "," + lat2;
         try {
             InputStream is = getInputStream(url, progressMonitor.createSubTaskMonitor(1, false));
@@ -213 +204 @@
     }
 
-    private Integer checkNoteLimit(Integer limit) {
-        if (limit == null) {
-            limit = Main.pref.getInteger("osm.notes.downloadLimit", 1000);
-        }
-        if (limit > 50000) {
-            // see max_number_of_nodes in https://github.com/openstreetmap/openstreetmap-website/blob/master/config/example.application.yml
-            Main.error("Requested note limit is over API hard limit of 50000. Reducing to 50000.");
-            limit = 50000;
-        }
-        if (limit < 1) {
-            Main.error("Requested note limit is less than 1. Setting to 1.");
-            limit = 1;
-        }
-        return limit;
-    }
-
-    private Integer checkDaysClosed(Integer days) {
-        if (days == null) {
-            days = Main.pref.getInteger("osm.notes.daysClosed", 7);
-        }
-        if (days < -1) {
-            Main.error("Requested days closed must be greater than -1");
-            days = -1;
-        }
-        return days;
-    }
-
 }

trunk/src/org/openstreetmap/josm/io/OsmServerReader.java

@@ -354 +354 @@
      * Downloads notes from the API, given API limit parameters
      *
-     * @param noteLimit How many notes to download. Defaults to 1000 if not specified. API has a hard limit of 10000
+     * @param noteLimit How many notes to download.
      * @param daysClosed Return notes closed this many days in the past. -1 means all notes, ever. 0 means only unresolved notes.
      * @param progressMonitor Progress monitor for user feedback
@@ -360 +360 @@
      * @throws OsmTransferException if any errors happen
      */
-    public List<Note> parseNotes(Integer noteLimit, Integer daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException {
+    public List<Note> parseNotes(int noteLimit, int daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException {
         return null;
     }