source: josm/trunk/src/org/openstreetmap/josm/gui/layer/ValidatorLayer.java @ 12671

Last change on this file since 12671 was 12671, checked in by Don-vip, 7 weeks ago

see #15182 - move file importers/exporters from io package to gui.io.importexport package, as they rely heavily on GUI and are mainly used from Open/Save actions

  • Property svn:eol-style set to native
File size: 6.2 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.layer;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Graphics2D;
7import java.io.File;
8import java.util.Collections;
9import java.util.Enumeration;
10import java.util.List;
11
12import javax.swing.Action;
13import javax.swing.Icon;
14import javax.swing.tree.DefaultMutableTreeNode;
15import javax.swing.tree.TreeNode;
16
17import org.openstreetmap.josm.actions.RenameLayerAction;
18import org.openstreetmap.josm.actions.SaveActionBase;
19import org.openstreetmap.josm.data.Bounds;
20import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
21import org.openstreetmap.josm.data.validation.OsmValidator;
22import org.openstreetmap.josm.data.validation.PaintVisitor;
23import org.openstreetmap.josm.data.validation.Severity;
24import org.openstreetmap.josm.data.validation.TestError;
25import org.openstreetmap.josm.gui.MainApplication;
26import org.openstreetmap.josm.gui.MapView;
27import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
28import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
29import org.openstreetmap.josm.gui.io.importexport.ValidatorErrorExporter;
30import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
31import org.openstreetmap.josm.gui.layer.LayerManager.LayerChangeListener;
32import org.openstreetmap.josm.gui.layer.LayerManager.LayerOrderChangeEvent;
33import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
34import org.openstreetmap.josm.tools.ImageProvider;
35import org.openstreetmap.josm.tools.MultiMap;
36
37/**
38 * A layer showing error messages.
39 *
40 * @author frsantos
41 *
42 * @since  3669 (creation)
43 * @since 10386 (new LayerChangeListener interface)
44 */
45public class ValidatorLayer extends Layer implements LayerChangeListener {
46    private final Runnable invalidator = this::invalidate;
47
48    /**
49     * Constructs a new Validator layer
50     */
51    public ValidatorLayer() {
52        super(tr("Validation errors"));
53        MainApplication.getLayerManager().addLayerChangeListener(this);
54        MainApplication.getMap().validatorDialog.tree.addInvalidationListener(invalidator);
55    }
56
57    /**
58     * Return a static icon.
59     */
60    @Override
61    public Icon getIcon() {
62        return ImageProvider.get("layer", "validator_small");
63    }
64
65    /**
66     * Draw all primitives in this layer but do not draw modified ones (they
67     * are drawn by the edit layer).
68     * Draw nodes last to overlap the ways they belong to.
69     */
70    @SuppressWarnings("unchecked")
71    @Override
72    public void paint(final Graphics2D g, final MapView mv, Bounds bounds) {
73        DefaultMutableTreeNode root = MainApplication.getMap().validatorDialog.tree.getRoot();
74        if (root == null || root.getChildCount() == 0)
75            return;
76
77        PaintVisitor paintVisitor = new PaintVisitor(g, mv);
78
79        DefaultMutableTreeNode severity = (DefaultMutableTreeNode) root.getLastChild();
80        while (severity != null) {
81            Enumeration<TreeNode> errorMessages = severity.breadthFirstEnumeration();
82            while (errorMessages.hasMoreElements()) {
83                Object tn = ((DefaultMutableTreeNode) errorMessages.nextElement()).getUserObject();
84                if (tn instanceof TestError) {
85                    paintVisitor.visit((TestError) tn);
86                }
87            }
88
89            // Severities in inverse order
90            severity = severity.getPreviousSibling();
91        }
92
93        paintVisitor.clearPaintedObjects();
94    }
95
96    @Override
97    public String getToolTipText() {
98        MultiMap<Severity, TestError> errorTree = new MultiMap<>();
99        List<TestError> errors = MainApplication.getMap().validatorDialog.tree.getErrors();
100        for (TestError e : errors) {
101            errorTree.put(e.getSeverity(), e);
102        }
103
104        StringBuilder b = new StringBuilder();
105        for (Severity s : Severity.values()) {
106            if (errorTree.containsKey(s)) {
107                b.append(tr(s.toString())).append(": ").append(errorTree.get(s).size()).append("<br>");
108            }
109        }
110
111        if (b.length() == 0)
112            return "<html>" + tr("No validation errors") + "</html>";
113        else
114            return "<html>" + tr("Validation errors") + ":<br>" + b + "</html>";
115    }
116
117    @Override
118    public void mergeFrom(Layer from) {
119        // Do nothing
120    }
121
122    @Override
123    public boolean isMergable(Layer other) {
124        return false;
125    }
126
127    @Override
128    public void visitBoundingBox(BoundingXYVisitor v) {
129        // Do nothing
130    }
131
132    @Override
133    public Object getInfoComponent() {
134        return getToolTipText();
135    }
136
137    @Override
138    public Action[] getMenuEntries() {
139        return new Action[] {
140                LayerListDialog.getInstance().createShowHideLayerAction(),
141                LayerListDialog.getInstance().createDeleteLayerAction(),
142                SeparatorLayerAction.INSTANCE,
143                new RenameLayerAction(null, this),
144                SeparatorLayerAction.INSTANCE,
145                new LayerListPopup.InfoAction(this),
146                new LayerSaveAsAction(this)
147                };
148    }
149
150    @Override
151    public File createAndOpenSaveFileChooser() {
152        return SaveActionBase.createAndOpenSaveFileChooser(tr("Save Validation errors file"), ValidatorErrorExporter.FILE_FILTER);
153    }
154
155    @Override
156    public void layerOrderChanged(LayerOrderChangeEvent e) {
157        // Do nothing
158    }
159
160    @Override
161    public void layerAdded(LayerAddEvent e) {
162        // Do nothing
163    }
164
165    /**
166     * If layer is the OSM Data layer, remove all errors
167     */
168    @Override
169    public void layerRemoving(LayerRemoveEvent e) {
170        // Removed layer is still in that list.
171        if (e.getRemovedLayer() instanceof OsmDataLayer && e.getSource().getLayersOfType(OsmDataLayer.class).size() <= 1) {
172            e.scheduleRemoval(Collections.singleton(this));
173        } else if (e.getRemovedLayer() == this) {
174            OsmValidator.resetErrorLayer();
175        }
176    }
177
178    @Override
179    public LayerPositionStrategy getDefaultLayerPosition() {
180        return LayerPositionStrategy.IN_FRONT;
181    }
182
183    @Override
184    public synchronized void destroy() {
185        MainApplication.getMap().validatorDialog.tree.removeInvalidationListener(invalidator);
186        MainApplication.getLayerManager().removeLayerChangeListener(this);
187        super.destroy();
188    }
189}
Note: See TracBrowser for help on using the repository browser.