Changeset 13940 in josm for trunk/src

Timestamp:

2018-06-17T14:14:33+02:00 (6 years ago)

Author:

Don-vip

Message:

refactor/cleanup validator tree API

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• dialogs/ValidatorDialog.java (modified) (11 diffs)
• dialogs/validator/ValidatorTreePanel.java (modified) (3 diffs)
• layer/ValidatorLayer.java (modified) (5 diffs)

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

@@ -16 +16 @@
 import java.util.List;
 import java.util.Set;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 import javax.swing.AbstractAction;
@@ -207 +208 @@
      * Fix selected errors
      */
-    @SuppressWarnings("unchecked")
     private void fixErrors() {
         TreePath[] selectionPaths = tree.getSelectionPaths();
@@ -218 +218 @@
         for (TreePath path : selectionPaths) {
             DefaultMutableTreeNode node = (DefaultMutableTreeNode) path.getLastPathComponent();
-            if (node == null) {
-                continue;
-            }
-
-            Enumeration<TreeNode> children = node.breadthFirstEnumeration();
-            while (children.hasMoreElements()) {
-                DefaultMutableTreeNode childNode = (DefaultMutableTreeNode) children.nextElement();
-                if (processedNodes.contains(childNode)) {
-                    continue;
-                }
-
-                processedNodes.add(childNode);
-                Object nodeInfo = childNode.getUserObject();
-                if (nodeInfo instanceof TestError) {
-                    errorsToFix.add((TestError) nodeInfo);
-                }
+            if (node != null) {
+                ValidatorTreePanel.visitTestErrors(node, errorsToFix::add, processedNodes);
             }
         }
 
         // run fix task asynchronously
-        //
-        FixTask fixTask = new FixTask(errorsToFix);
-        MainApplication.worker.submit(fixTask);
+        MainApplication.worker.submit(new FixTask(errorsToFix));
     }
 
@@ -246 +230 @@
      * Set selected errors to ignore state
      */
-    @SuppressWarnings("unchecked")
     private void ignoreErrors() {
         int asked = JOptionPane.DEFAULT_OPTION;
-        boolean changed = false;
+        AtomicBoolean changed = new AtomicBoolean();
         TreePath[] selectionPaths = tree.getSelectionPaths();
         if (selectionPaths == null)
@@ -272 +255 @@
                 }
                 if (asked == JOptionPane.YES_NO_OPTION) {
-                    Enumeration<TreeNode> children = node.breadthFirstEnumeration();
-                    while (children.hasMoreElements()) {
-                        DefaultMutableTreeNode childNode = (DefaultMutableTreeNode) children.nextElement();
-                        if (processedNodes.contains(childNode)) {
-                            continue;
-                        }
-
-                        processedNodes.add(childNode);
-                        Object nodeInfo = childNode.getUserObject();
-                        if (nodeInfo instanceof TestError) {
-                            TestError err = (TestError) nodeInfo;
-                            err.setIgnored(true);
-                            changed = true;
-                            state.add(node.getDepth() == 1 ? err.getIgnoreSubGroup() : err.getIgnoreGroup());
-                        }
-                    }
+                    ValidatorTreePanel.visitTestErrors(node, err -> {
+                        err.setIgnored(true);
+                        changed.set(true);
+                        state.add(node.getDepth() == 1 ? err.getIgnoreSubGroup() : err.getIgnoreGroup());
+                    }, processedNodes);
                     for (String s : state) {
                         OsmValidator.addIgnoredError(s);
@@ -297 +269 @@
             }
 
-            Enumeration<TreeNode> children = node.breadthFirstEnumeration();
-            while (children.hasMoreElements()) {
-                DefaultMutableTreeNode childNode = (DefaultMutableTreeNode) children.nextElement();
-                if (processedNodes.contains(childNode)) {
-                    continue;
-                }
-
-                processedNodes.add(childNode);
-                Object nodeInfo = childNode.getUserObject();
-                if (nodeInfo instanceof TestError) {
-                    TestError error = (TestError) nodeInfo;
-                    String state = error.getIgnoreState();
-                    if (state != null) {
-                        OsmValidator.addIgnoredError(state);
-                    }
-                    changed = true;
-                    error.setIgnored(true);
-                }
-            }
-        }
-        if (changed) {
+            ValidatorTreePanel.visitTestErrors(node, error -> {
+                String state = error.getIgnoreState();
+                if (state != null) {
+                    OsmValidator.addIgnoredError(state);
+                }
+                changed.set(true);
+                error.setIgnored(true);
+            }, processedNodes);
+        }
+        if (changed.get()) {
             tree.resetErrors();
             OsmValidator.saveIgnoredErrors();
@@ -329 +290 @@
     @SuppressWarnings("unchecked")
     private void setSelectedItems() {
-        if (tree == null)
+        DataSet ds = MainApplication.getLayerManager().getActiveDataSet();
+        if (tree == null || ds == null)
             return;
-
-        Collection<OsmPrimitive> sel = new HashSet<>(40);
 
         TreePath[] selectedPaths = tree.getSelectionPaths();
@@ -338 +298 @@
             return;
 
+        Collection<OsmPrimitive> sel = new HashSet<>(40);
         for (TreePath path : selectedPaths) {
             DefaultMutableTreeNode node = (DefaultMutableTreeNode) path.getLastPathComponent();
@@ -352 +313 @@
             }
         }
-        DataSet ds = MainApplication.getLayerManager().getActiveDataSet();
-        if (ds != null) {
-            ds.setSelected(sel);
-        }
+        ds.setSelected(sel);
     }
 
@@ -368 +326 @@
      * @return whether the selected elements has any fix
      */
-    @SuppressWarnings("unchecked")
     private boolean setSelection(Collection<OsmPrimitive> sel, boolean addSelected) {
-        boolean hasFixes = false;
+        AtomicBoolean hasFixes = new AtomicBoolean();
 
         DefaultMutableTreeNode node = (DefaultMutableTreeNode) tree.getLastSelectedPathComponent();
         if (lastSelectedNode != null && !lastSelectedNode.equals(node)) {
-            Enumeration<TreeNode> children = lastSelectedNode.breadthFirstEnumeration();
-            while (children.hasMoreElements()) {
-                DefaultMutableTreeNode childNode = (DefaultMutableTreeNode) children.nextElement();
-                Object nodeInfo = childNode.getUserObject();
-                if (nodeInfo instanceof TestError) {
-                    TestError error = (TestError) nodeInfo;
-                    error.setSelected(false);
-                }
-            }
+            ValidatorTreePanel.visitTestErrors(lastSelectedNode, error -> error.setSelected(false));
         }
 
         lastSelectedNode = node;
-        if (node == null)
-            return hasFixes;
-
-        Enumeration<TreeNode> children = node.breadthFirstEnumeration();
-        while (children.hasMoreElements()) {
-            DefaultMutableTreeNode childNode = (DefaultMutableTreeNode) children.nextElement();
-            Object nodeInfo = childNode.getUserObject();
-            if (nodeInfo instanceof TestError) {
-                TestError error = (TestError) nodeInfo;
+        if (node != null) {
+            ValidatorTreePanel.visitTestErrors(node, error -> {
                 error.setSelected(true);
 
-                hasFixes = hasFixes || error.isFixable();
+                hasFixes.set(hasFixes.get() || error.isFixable());
                 if (addSelected) {
                     error.getPrimitives().stream()
@@ -403 +345 @@
                             .forEach(sel::add);
                 }
-            }
-        }
-        selectButton.setEnabled(true);
-        if (ignoreButton != null) {
-            ignoreButton.setEnabled(true);
-        }
-
-        return hasFixes;
+            });
+            selectButton.setEnabled(true);
+            if (ignoreButton != null) {
+                ignoreButton.setEnabled(true);
+            }
+        }
+
+        return hasFixes.get();
     }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/validator/ValidatorTreePanel.java

@@ -14 +14 @@
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
 
@@ -388 +389 @@
      * Expands complete tree
      */
-    @SuppressWarnings("unchecked")
     public void expandAll() {
-        DefaultMutableTreeNode root = getRoot();
-
-        int row = 0;
-        Enumeration<TreeNode> children = root.breadthFirstEnumeration();
-        while (children.hasMoreElements()) {
-            children.nextElement();
-            expandRow(row++);
-        }
+        visitTreeNodes(getRoot(), x -> expandPath(new TreePath(x.getPath())));
     }
 
@@ -423 +416 @@
     }
 
+    /**
+     * Visitor call for all tree nodes children of root, in breadth-first order.
+     * @param root Root node
+     * @param visitor Visitor
+     * @since 13940
+     */
+    public static void visitTreeNodes(DefaultMutableTreeNode root, Consumer<DefaultMutableTreeNode> visitor) {
+        @SuppressWarnings("unchecked")
+        Enumeration<TreeNode> errorMessages = root.breadthFirstEnumeration();
+        while (errorMessages.hasMoreElements()) {
+            visitor.accept(((DefaultMutableTreeNode) errorMessages.nextElement()));
+        }
+    }
+
+    /**
+     * Visitor call for all {@link TestError} nodes children of root, in breadth-first order.
+     * @param root Root node
+     * @param visitor Visitor
+     * @since 13940
+     */
+    public static void visitTestErrors(DefaultMutableTreeNode root, Consumer<TestError> visitor) {
+        visitTestErrors(root, visitor, null);
+    }
+
+    /**
+     * Visitor call for all {@link TestError} nodes children of root, in breadth-first order.
+     * @param root Root node
+     * @param visitor Visitor
+     * @param processedNodes Set of already visited nodes (optional)
+     * @since 13940
+     */
+    public static void visitTestErrors(DefaultMutableTreeNode root, Consumer<TestError> visitor,
+            Set<DefaultMutableTreeNode> processedNodes) {
+        visitTreeNodes(root, n -> {
+            if (processedNodes == null || !processedNodes.contains(n)) {
+                if (processedNodes != null) {
+                    processedNodes.add(n);
+                }
+                Object o = n.getUserObject();
+                if (o instanceof TestError) {
+                    visitor.accept((TestError) o);
+                }
+            }
+        });
+    }
+
     @Override public void primitivesRemoved(PrimitivesRemovedEvent event) {
         // Remove purged primitives (fix #8639)

trunk/src/org/openstreetmap/josm/gui/layer/ValidatorLayer.java

@@ -7 +7 @@
 import java.io.File;
 import java.util.Collections;
-import java.util.Enumeration;
 import java.util.List;
 
@@ -13 +12 @@
 import javax.swing.Icon;
 import javax.swing.tree.DefaultMutableTreeNode;
-import javax.swing.tree.TreeNode;
 
 import org.openstreetmap.josm.actions.RenameLayerAction;
@@ -26 +24 @@
 import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
 import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
+import org.openstreetmap.josm.gui.dialogs.validator.ValidatorTreePanel;
 import org.openstreetmap.josm.gui.io.importexport.ValidatorErrorExporter;
 import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
@@ -68 +67 @@
      * Draw nodes last to overlap the ways they belong to.
      */
-    @SuppressWarnings("unchecked")
     @Override
     public void paint(final Graphics2D g, final MapView mv, Bounds bounds) {
@@ -79 +77 @@
         DefaultMutableTreeNode severity = (DefaultMutableTreeNode) root.getLastChild();
         while (severity != null) {
-            Enumeration<TreeNode> errorMessages = severity.breadthFirstEnumeration();
-            while (errorMessages.hasMoreElements()) {
-                Object tn = ((DefaultMutableTreeNode) errorMessages.nextElement()).getUserObject();
-                if (tn instanceof TestError) {
-                    paintVisitor.visit((TestError) tn);
-                }
-            }
+            ValidatorTreePanel.visitTestErrors(severity, paintVisitor::visit);
 
             // Severities in inverse order