Changeset 6670 in josm for trunk/src/org/openstreetmap/josm/gui

Timestamp:

2014-01-11T02:21:08+01:00 (10 years ago)

Author:

Don-vip

Message:

fix #9508 - Centralized service for validator rules

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• mappaint/MapPaintStyles.java (modified) (1 diff)
• mappaint/mapcss/MapCSSStyleSource.java (modified) (1 diff)
• mappaint/mapcss/Selector.java (modified) (1 diff)
• preferences/PreferenceTabbedPane.java (modified) (2 diffs)
• preferences/SourceEditor.java (modified) (24 diffs)
• preferences/SourceEntry.java (modified) (1 diff)
• preferences/SourceType.java (added)
• preferences/map/MapPaintPreference.java (modified) (6 diffs)
• preferences/map/TaggingPresetPreference.java (modified) (7 diffs)
• preferences/validator/ValidatorTagCheckerRulesPreference.java (added)
• preferences/validator/ValidatorTestsPreference.java (modified) (3 diffs)
• tagging/TaggingPresetReader.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java

@@ -42 +42 @@
     private static ElemStyles styles = new ElemStyles();
 
+    /**
+     * Returns the {@link ElemStyles} instance.
+     * @return the {@code ElemStyles} instance
+     */
     public static ElemStyles getStyles() {
         return styles;

trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSStyleSource.java

@@ -34 +34 @@
 
 public class MapCSSStyleSource extends StyleSource {
-    final public List<MapCSSRule> rules;
+    public final List<MapCSSRule> rules;
     private Color backgroundColorOverride;
     private String css = null;

trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Selector.java

@@ -346 +346 @@
 
         public List<Condition> getConditions() {
+            if (conds == null) {
+                return Collections.emptyList();
+            }
             return Collections.unmodifiableList(conds);
         }

trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceTabbedPane.java

@@ -53 +53 @@
 import org.openstreetmap.josm.gui.preferences.shortcut.ShortcutPreference;
 import org.openstreetmap.josm.gui.preferences.validator.ValidatorPreference;
+import org.openstreetmap.josm.gui.preferences.validator.ValidatorTagCheckerRulesPreference;
 import org.openstreetmap.josm.gui.preferences.validator.ValidatorTestsPreference;
 import org.openstreetmap.josm.plugins.PluginDownloadTask;
@@ -514 +515 @@
         settingsFactory.add(new ValidatorPreference.Factory());
         settingsFactory.add(new ValidatorTestsPreference.Factory());
+        settingsFactory.add(new ValidatorTagCheckerRulesPreference.Factory());
         settingsFactory.add(new RemoteControlPreference.Factory());
         settingsFactory.add(new ImageryPreference.Factory());

trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java

@@ -33 +33 @@
 import java.util.EventObject;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.regex.Matcher;
@@ -64 +66 @@
 import javax.swing.event.CellEditorListener;
 import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
@@ -93 +96 @@
 public abstract class SourceEditor extends JPanel {
 
-    final protected boolean isMapPaint;
+    protected final SourceType sourceType;
+    protected final boolean canEnable;
 
     protected final JTable tblActiveSources;
@@ -99 +103 @@
     protected final JList lstAvailableSources;
     protected final AvailableSourcesListModel availableSourcesModel;
-    protected final JTable tblIconPaths;
-    protected final IconPathTableModel iconPathsModel;
     protected final String availableSourcesUrl;
     protected final List<SourceProvider> sourceProviders;
 
+    protected JTable tblIconPaths;
+    protected IconPathTableModel iconPathsModel;
+
     protected boolean sourcesInitiallyLoaded;
 
     /**
-     * constructor
-     * @param isMapPaint true for MapPaintPreference subclass, false
-     *  for TaggingPresetPreference subclass
+     * Constructs a new {@code SourceEditor}.
+     * @param sourceType the type of source managed by this editor
      * @param availableSourcesUrl the URL to the list of available sources
      * @param sourceProviders the list of additional source providers, from plugins
+     * @param handleIcons {@code true} if icons may be managed, {@code false} otherwise
      */
-    public SourceEditor(final boolean isMapPaint, final String availableSourcesUrl, final List<SourceProvider> sourceProviders) {
-
-        this.isMapPaint = isMapPaint;
+    public SourceEditor(SourceType sourceType, String availableSourcesUrl, List<SourceProvider> sourceProviders, boolean handleIcons) {
+
+        this.sourceType = sourceType;
+        this.canEnable = sourceType.equals(SourceType.MAP_PAINT_STYLE) || sourceType.equals(SourceType.TAGCHECKER_RULE);
+        
         DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
-        this.lstAvailableSources = new JList(availableSourcesModel = new AvailableSourcesListModel(selectionModel));
+        this.availableSourcesModel = new AvailableSourcesListModel(selectionModel);
+        this.lstAvailableSources = new JList(availableSourcesModel);
         this.lstAvailableSources.setSelectionModel(selectionModel);
         this.lstAvailableSources.setCellRenderer(new SourceEntryListCellRenderer());
@@ -124 +132 @@
 
         selectionModel = new DefaultListSelectionModel();
-        tblActiveSources = new JTable(activeSourcesModel = new ActiveSourcesModel(selectionModel)) {
+        activeSourcesModel = new ActiveSourcesModel(selectionModel);
+        tblActiveSources = new JTable(activeSourcesModel) {
             // some kind of hack to prevent the table from scrolling slightly to the
             // right when clicking on the text
@@ -140 +149 @@
         tblActiveSources.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
         SourceEntryTableCellRenderer sourceEntryRenderer = new SourceEntryTableCellRenderer();
-        if (isMapPaint) {
+        if (canEnable) {
             tblActiveSources.getColumnModel().getColumn(0).setMaxWidth(1);
             tblActiveSources.getColumnModel().getColumn(0).setResizable(false);
@@ -153 +162 @@
             @Override
             public void tableChanged(TableModelEvent e) {
-                TableHelper.adjustColumnWidth(tblActiveSources, isMapPaint ? 1 : 0, 800);
+                TableHelper.adjustColumnWidth(tblActiveSources, canEnable ? 1 : 0, 800);
             }
         });
@@ -168 +177 @@
                     if (row < 0 || row >= tblActiveSources.getRowCount())
                         return;
-                    if (isMapPaint  && col != 1)
+                    if (canEnable && col != 1)
                         return;
                     editActiveSourceAction.actionPerformed(null);
@@ -182 +191 @@
         MoveUpDownAction moveUp = null;
         MoveUpDownAction moveDown = null;
-        if (isMapPaint) {
+        if (sourceType.equals(SourceType.MAP_PAINT_STYLE)) {
             moveUp = new MoveUpDownAction(false);
             moveDown = new MoveUpDownAction(true);
@@ -259 +268 @@
         sideButtonTB.add(removeActiveSourcesAction);
         sideButtonTB.addSeparator(new Dimension(12, 30));
-        if (isMapPaint) {
+        if (sourceType.equals(SourceType.MAP_PAINT_STYLE)) {
             sideButtonTB.add(moveUp);
             sideButtonTB.add(moveDown);
@@ -297 +306 @@
          **/
 
-        selectionModel = new DefaultListSelectionModel();
-        tblIconPaths = new JTable(iconPathsModel = new IconPathTableModel(selectionModel));
+        if (handleIcons) {
+            buildIcons(gbc);
+        }
+    }
+
+    private void buildIcons(GridBagConstraints gbc) {
+        DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
+        iconPathsModel = new IconPathTableModel(selectionModel);
+        tblIconPaths = new JTable(iconPathsModel);
         tblIconPaths.setSelectionModel(selectionModel);
         tblIconPaths.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
@@ -334 +350 @@
         gbc.insets = new Insets(0, 11, 0, 0);
 
-        add(sp = new JScrollPane(tblIconPaths), gbc);
+        JScrollPane sp = new JScrollPane(tblIconPaths);
+        add(sp, gbc);
         sp.setColumnHeaderView(null);
 
@@ -485 +502 @@
         @Override
         public int getColumnCount() {
-            return isMapPaint ? 2 : 1;
+            return canEnable ? 2 : 1;
         }
 
@@ -495 +512 @@
         @Override
         public Object getValueAt(int rowIndex, int columnIndex) {
-            if (isMapPaint && columnIndex == 0)
+            if (canEnable && columnIndex == 0)
                 return data.get(rowIndex).active;
             else
@@ -503 +520 @@
         @Override
         public boolean isCellEditable(int rowIndex, int columnIndex) {
-            return isMapPaint && columnIndex == 0;
+            return canEnable && columnIndex == 0;
         }
 
         @Override
         public Class<?> getColumnClass(int column) {
-            if (isMapPaint && column == 0)
+            if (canEnable && column == 0)
                 return Boolean.class;
             else return SourceEntry.class;
@@ -517 +534 @@
             if (row < 0 || row >= getRowCount() || aValue == null)
                 return;
-            if (isMapPaint && column == 0) {
+            if (canEnable && column == 0) {
                 data.get(row).active = ! data.get(row).active;
             }
@@ -709 +726 @@
             }
 
-            if (isMapPaint) {
+            if (canEnable) {
                 cbActive = new JCheckBox(tr("active"), e != null ? e.active : true);
                 p.add(cbActive, GBC.eol().insets(15, 0, 5, 0));
@@ -752 +769 @@
             public void actionPerformed(ActionEvent e) {
                 FileFilter ff;
-                if (isMapPaint) {
+                switch (sourceType) {
+                case MAP_PAINT_STYLE:
                     ff = new ExtensionFileFilter("xml,mapcss,css,zip", "xml", tr("Map paint style file (*.xml, *.mapcss, *.zip)"));
-                } else {
+                    break;
+                case TAGGING_PRESET:
                     ff = new ExtensionFileFilter("xml,zip", "xml", tr("Preset definition file (*.xml, *.zip)"));
+                    break;
+                case TAGCHECKER_RULE:
+                    ff = new ExtensionFileFilter("validator.mapcss,zip", "validator.mapcss", tr("Tag checker rule (*.validator.mapcss, *.zip)"));
+                    break;
+                default:
+                    Main.error("Unsupported source type: "+sourceType);
+                    return;
                 }
                 JFileChooserManager fcm = new JFileChooserManager(true)
@@ -777 +803 @@
 
         public boolean active() {
-            if (!isMapPaint)
+            if (!canEnable)
                 throw new UnsupportedOperationException();
             return cbActive.isSelected();
@@ -799 +825 @@
             if (editEntryDialog.getValue() == 1) {
                 boolean active = true;
-                if (isMapPaint) {
+                if (canEnable) {
                     active = editEntryDialog.active();
                 }
@@ -870 +896 @@
                 }
                 e.url = editEntryDialog.getURL();
-                if (isMapPaint) {
+                if (canEnable) {
                     e.active = editEntryDialog.active();
                 }
@@ -1495 +1521 @@
         private final String pref;
 
+        /**
+         * Constructs a new {@code SourcePrefHelper} for the given preference key.
+         * @param pref The preference key
+         */
         public SourcePrefHelper(String pref) {
             this.pref = pref;
         }
 
+        /**
+         * Returns the default sources provided by JOSM core.
+         * @return the default sources provided by JOSM core
+         */
         abstract public Collection<ExtendedSourceEntry> getDefault();
 
@@ -1505 +1539 @@
         abstract public SourceEntry deserialize(Map<String, String> entryStr);
 
+        /**
+         * Returns the list of sources.
+         * @return The list of sources
+         */
         public List<SourceEntry> get() {
 
@@ -1528 +1566 @@
             return Main.pref.putListOfStructs(pref, setting);
         }
-    }
-
+
+        /**
+         * Returns the set of active source URLs.
+         * @return The set of active source URLs.
+         */
+        public final Set<String> getActiveUrls() {
+            Set<String> urls = new HashSet<String>();
+            for (SourceEntry e : get()) {
+                if (e.active) {
+                    urls.add(e.url);
+                }
+            }
+            return urls;
+        }
+    }
+    
+    /**
+     * Defers loading of sources to the first time the adequate tab is selected.
+     * @param tab The preferences tab
+     * @param component The tab component
+     * @since 6670
+     */
+    public final void deferLoading(final DefaultTabPreferenceSetting tab, final Component component) {
+        tab.getTabPane().addChangeListener(
+                new ChangeListener() {
+                    @Override
+                    public void stateChanged(ChangeEvent e) {
+                        if (tab.getTabPane().getSelectedComponent() == component) {
+                            SourceEditor.this.initiallyLoadAvailableSources();
+                        }
+                    }
+                }
+                );
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/SourceEntry.java

@@ -50 +50 @@
 
     /**
-     * active is a boolean flag that can be used to turn the style on or off
-     * at runtime.
+     * active is a boolean flag that can be used to turn the source on or off at runtime.
      */
     public boolean active;

trunk/src/org/openstreetmap/josm/gui/preferences/map/MapPaintPreference.java

@@ -26 +26 @@
 import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane;
 import org.openstreetmap.josm.gui.preferences.SourceEditor;
+import org.openstreetmap.josm.gui.preferences.SourceType;
 import org.openstreetmap.josm.gui.preferences.SourceEditor.ExtendedSourceEntry;
 import org.openstreetmap.josm.gui.preferences.SourceEntry;
@@ -41 +42 @@
     private static final List<SourceProvider> styleSourceProviders = new ArrayList<SourceProvider>();
 
+    /**
+     * Registers a new additional style source provider.
+     * @param provider The style source provider
+     * @return {@code true}, if the provider has been added, {@code false} otherwise
+     */
     public static boolean registerSourceProvider(SourceProvider provider) {
         if (provider != null)
@@ -58 +64 @@
 
     @Override
-    public void addGui(final PreferenceTabbedPane gui) {
+    public void addGui(PreferenceTabbedPane gui) {
         enableIconDefault = new JCheckBox(tr("Enable built-in icon defaults"),
                 Main.pref.getBoolean("mappaint.icon.enable-defaults", true));
@@ -70 +76 @@
         panel.add(enableIconDefault, GBC.eol().insets(11,2,5,0));
 
-        gui.getMapPreference().addSubTab(this, tr("Map Paint Styles"), panel);
-
-        // this defers loading of style sources to the first time the tab
-        // with the map paint preferences is selected by the user
-        //
-        gui.getMapPreference().getTabPane().addChangeListener(
-                new ChangeListener() {
-                    @Override
-                    public void stateChanged(ChangeEvent e) {
-                        if (gui.getMapPreference().getTabPane().getSelectedComponent() == panel) {
-                            sources.initiallyLoadAvailableSources();
-                        }
-                    }
-                }
-                );
+        final MapPreference mapPref = gui.getMapPreference();
+        mapPref.addSubTab(this, tr("Map Paint Styles"), panel);
+        sources.deferLoading(mapPref, panel);
     }
 
@@ -92 +86 @@
 
         public MapPaintSourceEditor() {
-            super(true, Main.JOSM_WEBSITE+"/styles", styleSourceProviders);
+            super(SourceType.MAP_PAINT_STYLE, Main.JOSM_WEBSITE+"/styles", styleSourceProviders, true);
         }
 
@@ -186 +180 @@
     }
 
+    /**
+     * Helper class for map paint styles preferences.
+     */
     public static class MapPaintPrefHelper extends SourceEditor.SourcePrefHelper {
 

trunk/src/org/openstreetmap/josm/gui/preferences/map/TaggingPresetPreference.java

@@ -35 +35 @@
 import org.openstreetmap.josm.gui.preferences.SourceEntry;
 import org.openstreetmap.josm.gui.preferences.SourceProvider;
+import org.openstreetmap.josm.gui.preferences.SourceType;
 import org.openstreetmap.josm.gui.preferences.SubPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.TabPreferenceSetting;
@@ -67 +68 @@
     private JCheckBox sortMenu;
 
+    /**
+     * Registers a new additional preset source provider.
+     * @param provider The preset source provider
+     * @return {@code true}, if the provider has been added, {@code false} otherwise
+     */
     public static final boolean registerSourceProvider(SourceProvider provider) {
         if (provider != null)
@@ -161 +167 @@
 
     @Override
-    public void addGui(final PreferenceTabbedPane gui) {
+    public void addGui(PreferenceTabbedPane gui) {
         sortMenu = new JCheckBox(tr("Sort presets menu"),
                 Main.pref.getBoolean("taggingpreset.sortmenu", false));
@@ -170 +176 @@
         sources = new TaggingPresetSourceEditor();
         panel.add(sources, GBC.eol().fill(GBC.BOTH));
-        gui.getMapPreference().addSubTab(this, tr("Tagging Presets"), panel);
-
-        // this defers loading of tagging preset sources to the first time the tab
-        // with the tagging presets is selected by the user
-        //
-        gui.getMapPreference().getTabPane().addChangeListener(
-                new ChangeListener() {
-                    @Override
-                    public void stateChanged(ChangeEvent e) {
-                        if (gui.getMapPreference().getTabPane().getSelectedComponent() == panel) {
-                            sources.initiallyLoadAvailableSources();
-                        }
-                    }
-                }
-                );
+        final MapPreference mapPref = gui.getMapPreference();
+        mapPref.addSubTab(this, tr("Tagging Presets"), panel);
+        sources.deferLoading(mapPref, panel);
         gui.addValidationListener(validationListener);
     }
@@ -193 +187 @@
 
         public TaggingPresetSourceEditor() {
-            super(false, Main.JOSM_WEBSITE+"/presets", presetSourceProviders);
+            super(SourceType.TAGGING_PRESET, Main.JOSM_WEBSITE+"/presets", presetSourceProviders, true);
         }
 
@@ -274 +268 @@
     }
 
+    /**
+     * Initializes tagging presets from preferences.
+     */
     public static void readFromPreferences() {
         taggingPresets = TaggingPresetReader.readFromPreferences(false);
     }
 
-        /**
-         * Initialize the tagging presets (load and may display error)
-         */
+    /**
+     * Initialize the tagging presets (load and may display error)
+     */
     public static void initialize() {
         readFromPreferences();
@@ -315 +312 @@
     }
 
+    /**
+     * Helper class for tagging presets preferences.
+     */
     public static class PresetPrefHelper extends SourceEditor.SourcePrefHelper {
 

trunk/src/org/openstreetmap/josm/gui/preferences/validator/ValidatorTestsPreference.java

@@ -7 +7 @@
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.LinkedList;
+import java.util.List;
 
 import javax.swing.BorderFactory;
@@ -18 +20 @@
 import org.openstreetmap.josm.data.validation.OsmValidator;
 import org.openstreetmap.josm.data.validation.Test;
+import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSettingFactory;
@@ -108 +111 @@
                 testsBeforeUpload.add(name);
         }
-        OsmValidator.initializeTests(allTests);
+        
+        // Initializes all tests but MapCSSTagChecker because it is initialized
+        // later in ValidatorTagCheckerRulesPreference.ok(),
+        // after its list of rules has been saved to preferences
+        List<Test> testsToInitialize = new ArrayList<Test>(allTests);
+        testsToInitialize.remove(OsmValidator.getTest(MapCSSTagChecker.class));
+        OsmValidator.initializeTests(testsToInitialize);
 
         Main.pref.putCollection(ValidatorPreference.PREF_SKIP_TESTS, tests);

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetReader.java

@@ -17 +17 @@
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.Stack;
 
@@ -22 +23 @@
 
 import org.openstreetmap.josm.Main;
-import org.openstreetmap.josm.gui.preferences.SourceEntry;
 import org.openstreetmap.josm.gui.preferences.map.TaggingPresetPreference;
 import org.openstreetmap.josm.io.MirroredInputStream;
@@ -41 +41 @@
     private static File zipIcons = null;
     
-    public static List<String> getPresetSources() {
-        LinkedList<String> sources = new LinkedList<String>();
-
-        for (SourceEntry e : (new TaggingPresetPreference.PresetPrefHelper()).get()) {
-            sources.add(e.url);
-        }
-
-        return sources;
-    }
-
     /**
-     * Holds a reference to a chunk of  items/objects.
+     * Returns the set of preset source URLs.
+     * @return The set of preset source URLs.
+     */
+    public static Set<String> getPresetSources() {
+        return new TaggingPresetPreference.PresetPrefHelper().getActiveUrls();
+    }
+
+    /**
+     * Holds a reference to a chunk of items/objects.
      */
     public static class Chunk {
+        /** The chunk id, can be referenced later */
         public String id;
     }
@@ -62 +61 @@
      */
     public static class Reference {
+        /** Reference matching a chunk id defined earlier **/
         public String ref;
     }