Changeset 7782 in josm

Timestamp:

2014-12-10T21:25:59+01:00 (9 years ago)

Author:

Don-vip

Message:

fix #10826 - Add note sorting options (patch by ToeBee)

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/osm/NoteData.java (modified) (5 diffs)
• gui/NoteSortDialog.java (added)
• gui/dialogs/NoteDialog.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/data/osm/NoteData.java

@@ -3 +3 @@
 
 import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.Date;
 import java.util.List;
@@ -23 +25 @@
     private final List<Note> noteList;
     private Note selectedNote = null;
+    private Comparator<Note> comparator = DEFAULT_COMPARATOR;
+
+    /**
+     * Sorts notes in the following order:
+     * 1) Open notes
+     * 2) Closed notes
+     * 3) New notes
+     * Within each subgroup it sorts by ID
+     */
+    public static final Comparator<Note> DEFAULT_COMPARATOR = new Comparator<Note>() {
+        @Override
+        public int compare(Note n1, Note n2) {
+            if (n1.getId() < 0 && n2.getId() > 0) {
+                return 1;
+            }
+            if (n1.getId() > 0 && n2.getId() < 0) {
+                return -1;
+            }
+            if (n1.getState() == State.closed && n2.getState() == State.open) {
+                return 1;
+            }
+            if (n1.getState() == State.open && n2.getState() == State.closed) {
+                return -1;
+            }
+            return Long.valueOf(Math.abs(n1.getId())).compareTo(Long.valueOf(Math.abs(n2.getId())));
+        }
+    };
+
+    /** Sorts notes strictly by creation date */
+    public static final Comparator<Note> DATE_COMPARATOR = new Comparator<Note>() {
+        @Override
+        public int compare(Note n1, Note n2) {
+            return n1.getCreatedAt().compareTo(n2.getCreatedAt());
+        }
+    };
+
+    /** Sorts notes by user, then creation date */
+    public static final Comparator<Note> USER_COMPARATOR = new Comparator<Note>() {
+        @Override
+        public int compare(Note n1, Note n2) {
+            String n1User = n1.getFirstComment().getUser().getName();
+            String n2User = n2.getFirstComment().getUser().getName();
+            if (n1User.equals(n2User)) {
+                return n1.getCreatedAt().compareTo(n2.getCreatedAt());
+            }
+            return n1.getFirstComment().getUser().getName().compareTo(n2.getFirstComment().getUser().getName());
+        }
+    };
+
+    /** Sorts notes by the last modified date */
+    public static final Comparator<Note> LAST_ACTION_COMPARATOR = new Comparator<Note>() {
+        @Override
+        public int compare(Note n1, Note n2) {
+            Date n1Date = n1.getComments().get(n1.getComments().size()-1).getCommentTimestamp();
+            Date n2Date = n2.getComments().get(n2.getComments().size()-1).getCommentTimestamp();
+            return n1Date.compareTo(n2Date);
+        }
+    };
 
     /**
@@ -37 +97 @@
     public NoteData(List<Note> notes) {
         noteList = notes;
+        Collections.sort(notes, comparator);
         for (Note note : notes) {
             if (note.getId() <= newNoteId) {
@@ -195 +256 @@
 
     private void dataUpdated() {
+        Collections.sort(noteList, comparator);
         Main.map.noteDialog.setNoteList(noteList);
         Main.map.mapView.repaint();
@@ -217 +279 @@
         dataUpdated();
     }
+
+    /** @return The current comparator being used to sort the note list */
+    public Comparator<Note> getCurrentSortMethod() {
+        return comparator;
+    }
+
+    /** Set the comparator to be used to sort the note list. Several are available
+     * as public static members of this class.
+     * @param comparator - The Note comparator to sort by
+     */
+    public void setSortMethod(Comparator<Note> comparator) {
+        this.comparator = comparator;
+        dataUpdated();
+    }
 }

trunk/src/org/openstreetmap/josm/gui/dialogs/NoteDialog.java

@@ -36 +36 @@
 import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
 import org.openstreetmap.josm.gui.NoteInputDialog;
+import org.openstreetmap.josm.gui.NoteSortDialog;
 import org.openstreetmap.josm.gui.SideButton;
 import org.openstreetmap.josm.gui.layer.Layer;
@@ -75 +76 @@
     private final NewAction newAction;
     private final ReopenAction reopenAction;
+    private final SortAction sortAction;
     private final UploadNotesAction uploadAction;
 
@@ -90 +92 @@
         newAction = new NewAction();
         reopenAction = new ReopenAction();
+        sortAction = new SortAction();
         uploadAction = new UploadNotesAction();
         buildDialog();
@@ -121 +124 @@
                 new SideButton(closeAction, false),
                 new SideButton(reopenAction, false),
+                new SideButton(sortAction, false),
                 new SideButton(uploadAction, false)}));
         updateButtonStates();
@@ -144 +148 @@
             uploadAction.setEnabled(true);
         }
+        //enable sort button if any notes are loaded
+        if (noteData == null || noteData.getNotes().isEmpty()) {
+            sortAction.setEnabled(false);
+        } else {
+            sortAction.setEnabled(true);
+        }
     }
 
@@ -161 +171 @@
     @Override
     public void layerAdded(Layer newLayer) {
-        if (Main.isDebugEnabled()) {
-            Main.debug("layer added: " + newLayer);
-        }
         if (newLayer instanceof NoteLayer) {
-            if (Main.isDebugEnabled()) {
-                Main.debug("note layer added");
-            }
             noteData = ((NoteLayer)newLayer).getNoteData();
             model.setData(noteData.getNotes());
+            setNoteList(noteData.getNotes());
         }
     }
@@ -364 +369 @@
         }
     }
+
+    class SortAction extends AbstractAction {
+
+        public SortAction() {
+            putValue(SHORT_DESCRIPTION, tr("Sort notes"));
+            putValue(NAME, tr("Sort"));
+            putValue(SMALL_ICON, ImageProvider.get("dialogs", "sort"));
+        }
+
+        @Override
+        public void actionPerformed(ActionEvent e) {
+            NoteSortDialog sortDialog = new NoteSortDialog(Main.parent, tr("Sort notes"), tr("Apply"));
+            sortDialog.showSortDialog(noteData.getCurrentSortMethod());
+            if (sortDialog.getValue() == 1) {
+                noteData.setSortMethod(sortDialog.getSelectedComparator());
+            }
+        }
+    }
 }