Changeset 7556 in josm

Timestamp:

2014-09-18T02:23:15+02:00 (10 years ago)

Author:

Don-vip

Message:

fix #8262 - Relation editor: filter autocompletion of roles by relation type

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/osm/Relation.java (modified) (4 diffs)
• gui/dialogs/relation/GenericRelationEditor.java (modified) (8 diffs)
• gui/dialogs/relation/MemberRoleCellEditor.java (modified) (5 diffs)
• gui/dialogs/relation/MemberTable.java (modified) (4 diffs)
• gui/dialogs/relation/MemberTableColumnModel.java (modified) (2 diffs)
• gui/tagging/ac/AutoCompletionManager.java (modified) (3 diffs)
• tools/Utils.java (modified) (2 diffs)

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

@@ -163 +163 @@
     }
 
-    @Override public void accept(Visitor visitor) {
+    @Override
+    public void accept(Visitor visitor) {
         visitor.visit(this);
     }
 
-    @Override public void accept(PrimitiveVisitor visitor) {
+    @Override
+    public void accept(PrimitiveVisitor visitor) {
         visitor.visit(this);
     }
@@ -223 +225 @@
     }
 
-    @Override public void cloneFrom(OsmPrimitive osm) {
+    @Override
+    public void cloneFrom(OsmPrimitive osm) {
         boolean locked = writeLock();
         try {
@@ -234 +237 @@
     }
 
-    @Override public void load(PrimitiveData data) {
+    @Override
+    public void load(PrimitiveData data) {
         boolean locked = writeLock();
         try {
@@ -548 +552 @@
         return false;
     }
+
+    /**
+     * Returns the set of roles used in this relation.
+     * @return the set of roles used in this relation. Can be empty but never null
+     * @since 7556
+     */
+    public Set<String> getMemberRoles() {
+        Set<String> result = new HashSet<>();
+        for (RelationMember rm : members) {
+            String role = rm.getRole();
+            if (!role.isEmpty()) {
+                result.add(role);
+            }
+        }
+        return result;
+    }
 }

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java

@@ -92 +92 @@
 /**
  * This dialog is for editing relations.
- *
+ * @since 343
  */
 public class GenericRelationEditor extends RelationEditor  {
@@ -172 +172 @@
         tagEditorPanel.getModel().ensureOneTag();
 
-        JSplitPane pane = buildSplitPane();
+        JSplitPane pane = buildSplitPane(relation);
         pane.setPreferredSize(new Dimension(100, 100));
 
@@ -293 +293 @@
      */
     protected JPanel buildMemberEditorPanel() {
-        final JPanel pnl = new JPanel();
-        pnl.setLayout(new GridBagLayout());
+        final JPanel pnl = new JPanel(new GridBagLayout());
         // setting up the member table
-        memberTable = new MemberTable(getLayer(),memberTableModel);
+        memberTable = new MemberTable(getLayer(), getRelation(), memberTableModel);
         memberTable.addMouseListener(new MemberTableDblClickAdapter());
         memberTableModel.addMemberModelListener(memberTable);
@@ -350 +349 @@
                         if (list != null) {
                             list.clear();
-                            getLayer().data.getAutoCompletionManager().populateWithMemberRoles(list);
+                            getLayer().data.getAutoCompletionManager().populateWithMemberRoles(list, getRelation());
                         }
                     }
@@ -454 +453 @@
      * @return the split panel
      */
-    protected JSplitPane buildSplitPane() {
+    protected JSplitPane buildSplitPane(Relation relation) {
         final JSplitPane pane = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
         pane.setTopComponent(buildTagEditorPanel());
@@ -1603 +1602 @@
 
     /**
-     * Creates a new relation with a copy of the current editor state
-     *
+     * Creates a new relation with a copy of the current editor state.
      */
     class DuplicateRelationAction extends AbstractAction {
@@ -1626 +1624 @@
 
     /**
-     * Action for editing the currently selected relation
-     *
-     *
+     * Action for editing the currently selected relation.
      */
     class EditAction extends AbstractAction implements ListSelectionListener {
@@ -1736 +1732 @@
             }
         }
-
     }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberRoleCellEditor.java

@@ -10 +10 @@
 
 import org.openstreetmap.josm.data.osm.DataSet;
+import org.openstreetmap.josm.data.osm.Relation;
 import org.openstreetmap.josm.gui.tagging.ac.AutoCompletingTextField;
 import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionList;
@@ -15 +16 @@
 public class MemberRoleCellEditor extends AbstractCellEditor implements TableCellEditor {
     private AutoCompletingTextField editor = null;
-    private DataSet ds;
+    private final DataSet ds;
+    private final Relation relation;
 
     /** user input is matched against this list of auto completion items */
@@ -21 +23 @@
 
     /**
-     * constructor
+     * Constructs a new {@code MemberRoleCellEditor}.
+     * @param ds the data set. Must not be null
+     * @param relation the relation. Can be null
      */
-    public MemberRoleCellEditor(DataSet ds) {
+    public MemberRoleCellEditor(DataSet ds, Relation relation) {
         this.ds = ds;
+        this.relation = relation;
         editor = new AutoCompletingTextField();
         editor.setBorder(BorderFactory.createEmptyBorder(1,1,1,1));
@@ -31 +36 @@
     }
 
-    /**
-     * replies the table cell editor
-     */
     @Override
     public Component getTableCellEditorComponent(JTable table,
@@ -41 +43 @@
         editor.setText(role);
         autoCompletionList.clear();
-        ds.getAutoCompletionManager().populateWithMemberRoles(autoCompletionList);
+        ds.getAutoCompletionManager().populateWithMemberRoles(autoCompletionList, relation);
         return editor;
     }

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java

@@ -29 +29 @@
 import org.openstreetmap.josm.actions.ZoomToAction;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
+import org.openstreetmap.josm.data.osm.Relation;
 import org.openstreetmap.josm.data.osm.RelationMember;
 import org.openstreetmap.josm.data.osm.Way;
@@ -50 +51 @@
      * constructor for relation member table
      *
-     * @param layer the data layer of the relation
+     * @param layer the data layer of the relation. Must not be null
+     * @param relation the relation. Can be null
      * @param model the table model
      */
-    public MemberTable(OsmDataLayer layer, MemberTableModel model) {
-        super(model, new MemberTableColumnModel(layer.data), model.getSelectionModel());
+    public MemberTable(OsmDataLayer layer, Relation relation, MemberTableModel model) {
+        super(model, new MemberTableColumnModel(layer.data, relation), model.getSelectionModel());
         setLayer(layer);
         model.addMemberModelListener(this);
@@ -157 +159 @@
      * <li>it jumps over cells in the first column</li> <li>it automatically add a new empty row
      * when the user leaves the last cell in the table</li></ul>
-     *
-     *
      */
     class SelectNextColumnCellAction extends AbstractAction {
@@ -191 +191 @@
      * Action to be run when the user navigates to the previous cell in the table, for instance by
      * pressing Shift-TAB
-     *
      */
     private class SelectPreviousColumnCellAction extends AbstractAction {

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableColumnModel.java

@@ -8 +8 @@
 
 import org.openstreetmap.josm.data.osm.DataSet;
+import org.openstreetmap.josm.data.osm.Relation;
 
 public class MemberTableColumnModel extends DefaultTableColumnModel {
 
-    public MemberTableColumnModel(DataSet ds) {
+    /**
+     * Constructs a new {@code MemberTableColumnModel}.
+     * @param ds the data set. Must not be null
+     * @param relation the relation. Can be null
+     */
+    public MemberTableColumnModel(DataSet ds, Relation relation) {
         TableColumn col = null;
 
@@ -20 +26 @@
         col.setPreferredWidth(100);
         col.setCellRenderer(new MemberTableRoleCellRenderer());
-        col.setCellEditor(new MemberRoleCellEditor(ds));
+        col.setCellEditor(new MemberRoleCellEditor(ds, relation));
         addColumn(col);
 

trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionManager.java

@@ -29 +29 @@
 import org.openstreetmap.josm.gui.tagging.TaggingPresetItem;
 import org.openstreetmap.josm.gui.tagging.TaggingPresetItems;
+import org.openstreetmap.josm.gui.tagging.TaggingPresetItems.Role;
+import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.MultiMap;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -210 +213 @@
 
     /**
-     * Populates the an {@link AutoCompletionList} with the currently cached
+     * Populates the {@link AutoCompletionList} with the currently cached
      * member roles.
      *
@@ -218 +221 @@
         list.add(presetRoleCache, AutoCompletionItemPriority.IS_IN_STANDARD);
         list.add(getRoleCache(), AutoCompletionItemPriority.IS_IN_DATASET);
+    }
+
+    /**
+     * Populates the {@link AutoCompletionList} with the roles used in this relation
+     * plus the ones defined in its applicable presets, if any. If the relation type is unknown,
+     * then all the roles known globally will be added, as in {@link #populateWithMemberRoles(AutoCompletionList)}.
+     *
+     * @param list the list to populate
+     * @param r the relation to get roles from
+     * @throws IllegalArgumentException if list is null
+     * @since 7556
+     */
+    public void populateWithMemberRoles(AutoCompletionList list, Relation r) {
+        CheckParameterUtil.ensureParameterNotNull(list, "list");
+        Collection<TaggingPreset> presets = r != null ? TaggingPreset.getMatchingPresets(null, r.getKeys(), false) : null;
+        if (r != null && presets != null && !presets.isEmpty()) {
+            for (TaggingPreset tp : presets) {
+                if (tp.roles != null) {
+                    list.add(Utils.transform(tp.roles.roles, new Utils.Function<Role, String>() {
+                        public String apply(Role x) {
+                            return x.key;
+                        }
+                    }), AutoCompletionItemPriority.IS_IN_STANDARD);
+                }
+            }
+            list.add(r.getMemberRoles(), AutoCompletionItemPriority.IS_IN_DATASET);
+        } else {
+            populateWithMemberRoles(list);
+        }
     }
 

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -625 +625 @@
         return new AbstractList<B>() {
 
-
             @Override
             public int size() {
@@ -635 +634 @@
                 return f.apply(l.get(index));
             }
-
-
         };
     }