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