allTests;
+
+ public void addGui(PreferenceDialog gui)
+ {
+ JPanel testPanel = new JPanel(new GridBagLayout());
+ testPanel.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
+
+ allTests = OSMValidatorPlugin.getTests(false);
+ for(final Test test: allTests)
+ {
+ final JCheckBox testCheck = new JCheckBox(test.name, test.enabled);
+ testCheck.setToolTipText(test.description);
+ testPanel.add(testCheck, GBC.eop().insets(20,0,0,0));
+ test.addGui(testPanel);
+
+ testCheck.addActionListener(new ActionListener(){
+ public void actionPerformed(ActionEvent e) {
+ test.enabled = testCheck.isSelected();
+ }
+ });
+ }
+
+ JScrollPane testPane = new JScrollPane(testPanel, JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED, JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
+ testPane.setBorder(null);
+
+ Version ver = Util.getVersion();
+ String description = tr("A OSM data validator that checks for common errors made by users and editor programs.");
+ if( ver != null )
+ description += "
" + tr("Version: {0}
Last change at {1}", ver.revision, ver.time);
+ JPanel tab = gui.createPreferenceTab("validator", tr("Data validator"), description);
+ tab.add(testPane, GBC.eol().fill(GBC.BOTH));
+ tab.add(GBC.glue(0,10), GBC.eol());
+ }
+
+ public void ok()
+ {
+ String tests = "";
+
+ for (Test test : allTests)
+ {
+ boolean enabled = test.enabled;
+ String name = test.getClass().getSimpleName();
+ tests += name + "=" + enabled + ",";
+
+ if (enabled)
+ {
+ test.ok();
+ }
+ }
+
+ if (tests.endsWith(","))
+ tests = tests.substring(0, tests.length() - 1);
+
+ OSMValidatorPlugin.getPlugin().initializeTests( allTests );
+
+ Main.pref.put("tests", tests);
+ }
+
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/Severity.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/Severity.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/Severity.java (revision 2453)
@@ -0,0 +1,46 @@
+package org.openstreetmap.josm.plugins.validator;
+
+/** The error severity */
+public enum Severity {
+ /** Error messages */
+ ERROR("Errors", "error.gif"),
+ /** Warning messages */
+ WARNING("Warnings", "warning.gif"),
+ /** Other messages */
+ OTHER("Other", "other.gif");
+
+ /** Description of the severity code */
+ private final String message;
+
+ /** Associated icon */
+ private final String icon;
+
+ /**
+ * Constructor
+ *
+ * @param message Description
+ * @param icon Associated icon
+ */
+ Severity(String message, String icon)
+ {
+ this.message = message;
+ this.icon = icon;
+ }
+
+ @Override
+ public String toString()
+ {
+ return message;
+ }
+
+ /**
+ * Gets the associated icon
+ * @return the associated icon
+ */
+ public String getIcon()
+ {
+ return icon;
+ }
+
+
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/Test.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/Test.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/Test.java (revision 2453)
@@ -0,0 +1,118 @@
+package org.openstreetmap.josm.plugins.validator;
+
+import java.util.*;
+
+import javax.swing.JPanel;
+
+import org.openstreetmap.josm.data.osm.*;
+import org.openstreetmap.josm.data.osm.visitor.Visitor;
+
+/**
+ * Parent class for all validation tests.
+ *
+ * A test is a primitive visitor, so that it can access to all data to be
+ * validated. These primitives are always visited in the same order: nodes
+ * first, then segments, and ways last.
+ *
+ * @author frsantos
+ */
+public class Test implements Visitor
+{
+ /** Name of the test */
+ protected String name;
+
+ /** Description of the test */
+ protected String description;
+
+ /** Whether this test is enabled. Used by peferences */
+ protected boolean enabled;
+
+ /** The list of errors */
+ protected List errors = new ArrayList(30);
+
+ /**
+ * Constructor
+ * @param name Name of the test
+ * @param description Description of the test
+ */
+ public Test(String name, String description)
+ {
+ this.name = name;
+ this.description = description;
+ }
+
+ /**
+ * Constructor
+ * @param name Name of the test
+ */
+ public Test(String name)
+ {
+ this.name = name;
+ }
+
+ /**
+ * Initializes any global data used this tester.
+ * @param plugin The plugin
+ * @throws Exception When cannot initialize the test
+ */
+ public static void initialize(@SuppressWarnings("unused") OSMValidatorPlugin plugin) throws Exception {}
+
+ /**
+ * Notification of the start of the test. The tester can initialize the
+ * structures it may need for this test
+ */
+ public void startTest()
+ {
+ errors = new ArrayList(30);
+ }
+
+ /**
+ * Gets the validation errors accumulated until this moment.
+ * @return The list of errors
+ */
+ public List getErrors()
+ {
+ return errors;
+ }
+
+ /**
+ * Notification of the end of the test. The tester may perform additional
+ * actions and destroy the used structures
+ */
+ public void endTest() {}
+
+ /**
+ * Visits all primitives to be tested. These primitives are always visited
+ * in the same order: nodes first, then segments, and ways last.
+ *
+ * @param selection The primitives to be tested
+ */
+ public void visit(Collection selection)
+ {
+ for (OsmPrimitive p : selection)
+ {
+ p.visit(this);
+ }
+ }
+
+ public void visit(Node n) {}
+
+ public void visit(Segment s) {}
+
+ public void visit(Way w) {}
+
+ /**
+ * Allow the tester to manage its own preferences
+ * @param testPanel The panel to add any preferences component
+ */
+ public void addGui(@SuppressWarnings("unused") JPanel testPanel)
+ {
+ }
+
+ /**
+ * Called when the used submits the preferences
+ */
+ public void ok()
+ {
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/TestError.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/TestError.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/TestError.java (revision 2453)
@@ -0,0 +1,112 @@
+package org.openstreetmap.josm.plugins.validator;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
+
+/**
+ * Validation error
+ * @author frsantos
+ */
+public class TestError
+{
+ /** Severity */
+ private Severity severity;
+ /** The error message */
+ private String message;
+ /** The affected primitives */
+ private List primitives;
+
+ /**
+ * Constructor
+ */
+ public TestError()
+ {
+ }
+
+ /**
+ * Constructor
+ * @param severity The severity of this error
+ * @param message The error message
+ * @param primitives The affected primitives
+ */
+ public TestError(Severity severity, String message, List primitives)
+ {
+ this.severity = severity;
+ this.message = message;
+ this.primitives = primitives;
+ }
+
+ /**
+ * Constructor
+ * @param severity The severity of this error
+ * @param message The error message
+ * @param primitive The affected primitive
+ */
+ public TestError(Severity severity, String message, OsmPrimitive primitive)
+ {
+ this.severity = severity;
+ this.message = message;
+
+ List primitives = new ArrayList();
+ primitives.add(primitive);
+
+ this.primitives = primitives;
+ }
+
+ /**
+ * Gets the error message
+ * @return the error message
+ */
+ public String getMessage()
+ {
+ return message;
+ }
+
+ /**
+ * Sets the error message
+ * @param message The error message
+ */
+ public void setMessage(String message)
+ {
+ this.message = message;
+ }
+
+ /**
+ * Gets the list of primitives affected by this error
+ * @return the list of primitives affected by this error
+ */
+ public List getPrimitives()
+ {
+ return primitives;
+ }
+
+ /**
+ * Sets the list of primitives affected by this error
+ * @param primitives the list of primitives affected by this error
+ */
+
+ public void setPrimitives(List primitives)
+ {
+ this.primitives = primitives;
+ }
+
+ /**
+ * Gets the severity of this error
+ * @return the severity of this error
+ */
+ public Severity getSeverity()
+ {
+ return severity;
+ }
+
+ /**
+ * Sets the severity of this error
+ * @param severity the severity of this error
+ */
+ public void setSeverity(Severity severity)
+ {
+ this.severity = severity;
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/ValidateAction.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/ValidateAction.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/ValidateAction.java (revision 2453)
@@ -0,0 +1,64 @@
+package org.openstreetmap.josm.plugins.validator;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
+import java.util.ArrayList;
+import java.util.Collection;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.actions.JosmAction;
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
+import org.openstreetmap.josm.plugins.validator.util.AgregatePrimitivesVisitor;
+
+/**
+ * The action that does the validate thing.
+ *
+ * This action iterates through all active tests and give them the data, so that
+ * each one can test it.
+ *
+ * @author frsantos
+ */
+public class ValidateAction extends JosmAction
+{
+ /** Serializable ID */
+ private static final long serialVersionUID = -2304521273582574603L;
+
+ /**
+ * Constructor
+ */
+ public ValidateAction()
+ {
+ super("Validation", "validator", "Performs the data validation", KeyEvent.VK_V, KeyEvent.CTRL_DOWN_MASK + KeyEvent.ALT_MASK, true);
+ }
+
+ public void actionPerformed(ActionEvent ev)
+ {
+ OSMValidatorPlugin plugin = OSMValidatorPlugin.getPlugin();
+ plugin.errors = new ArrayList();
+ plugin.validationDialog.setVisible(true);
+
+ Collection tests = OSMValidatorPlugin.getTests(true);
+ if( tests.isEmpty() )
+ return;
+
+ Collection selection = Main.ds.getSelected();
+ if( selection.isEmpty() )
+ selection = Main.ds.allNonDeletedPrimitives();
+ else
+ {
+ AgregatePrimitivesVisitor v = new AgregatePrimitivesVisitor();
+ selection = v.visit(selection);
+ }
+
+ for(Test test : tests)
+ {
+ test.startTest();
+ test.visit(selection);
+ test.endTest();
+ plugin.errors.addAll( test.getErrors() );
+ }
+ tests = null;
+
+ plugin.validationDialog.refresh();
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/ValidatorDialog.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/ValidatorDialog.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/ValidatorDialog.java (revision 2453)
@@ -0,0 +1,214 @@
+package org.openstreetmap.josm.plugins.validator;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.awt.BorderLayout;
+import java.awt.GridLayout;
+import java.awt.event.*;
+import java.util.*;
+import java.util.Map.Entry;
+
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JTree;
+import javax.swing.tree.*;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
+import org.openstreetmap.josm.gui.dialogs.ToggleDialog;
+import org.openstreetmap.josm.plugins.validator.util.Bag;
+import org.openstreetmap.josm.plugins.validator.util.Util;
+
+/**
+ * A small tool dialog for displaying the current selection. The selection manager
+ * respects clicks into the selection list. Ctrl-click will remove entries from
+ * the list while single click will make the clicked entry the only selection.
+ *
+ * @author imi
+ */
+public class ValidatorDialog extends ToggleDialog implements ActionListener
+{
+ /** Serializable ID */
+ private static final long serialVersionUID = 2952292777351992696L;
+
+ /**
+ * The validation data.
+ */
+ private DefaultTreeModel treeModel = new DefaultTreeModel(new DefaultMutableTreeNode());
+
+ /**
+ * The display tree.
+ */
+ protected JTree tree = new JTree(treeModel);
+
+
+ /**
+ * Constructor
+ */
+ public ValidatorDialog()
+ {
+ super(tr("Validation errors"), "validator", tr("Open the validation window."), KeyEvent.VK_V, 150);
+
+ tree.setRootVisible(false);
+ tree.setShowsRootHandles(true);
+ tree.expandRow(0);
+ tree.setVisibleRowCount(8);
+ tree.addMouseListener(new DblClickWatch());
+ tree.setCellRenderer(new ErrorTreeRenderer());
+ tree.getSelectionModel().setSelectionMode(TreeSelectionModel.DISCONTIGUOUS_TREE_SELECTION);
+
+ add(new JScrollPane(tree), BorderLayout.CENTER);
+
+ JPanel buttonPanel = new JPanel(new GridLayout(1,2));
+
+ buttonPanel.add(Util.createButton("Select", "mapmode/selection/select", "Set the selected elements on the map to the selected items in the list above.", this));
+ add(buttonPanel, BorderLayout.SOUTH);
+ buttonPanel.add(Util.createButton("Validate", "dialogs/refresh", "Validate the data.", this));
+ add(buttonPanel, BorderLayout.SOUTH);
+ }
+
+ @Override
+ public void setVisible(boolean v) {
+ if (v)
+ buildTree();
+ else if (tree != null)
+ treeModel.setRoot(new DefaultMutableTreeNode());
+ if( action != null && action.button != null )
+ action.button.setSelected(v);
+ super.setVisible(v);
+ }
+
+
+ /**
+ * Builds the errors tree
+ */
+ private void buildTree()
+ {
+ DefaultMutableTreeNode rootNode = new DefaultMutableTreeNode();
+
+ List errorList = OSMValidatorPlugin.getPlugin().errors;
+ if( errorList == null || errorList.isEmpty() )
+ {
+ treeModel.setRoot(rootNode);
+ return;
+ }
+
+ Map> errorTree = new HashMap>();
+ for(Severity s : Severity.values())
+ {
+ errorTree.put(s, new Bag(20));
+ }
+
+ for(TestError e : errorList)
+ {
+ errorTree.get(e.getSeverity()).add(e.getMessage(), e);
+ }
+
+ for(Severity s : Severity.values())
+ {
+ Bag severityErrors = errorTree.get(s);
+ if( severityErrors.isEmpty() )
+ continue;
+
+ // Severity node
+ DefaultMutableTreeNode severityNode = new DefaultMutableTreeNode(s);
+ rootNode.add(severityNode);
+
+ for(Entry> msgErrors : severityErrors.entrySet() )
+ {
+ // Message node
+ List errors = msgErrors.getValue();
+ String msg = msgErrors.getKey() + " (" + errors.size() + ")";
+ DefaultMutableTreeNode messageNode = new DefaultMutableTreeNode(msg);
+ severityNode.add(messageNode);
+
+ for (TestError error : errors)
+ {
+ // Error node
+ DefaultMutableTreeNode errorNode = new DefaultMutableTreeNode(error);
+ messageNode.add(errorNode);
+ }
+ }
+ }
+
+ treeModel.setRoot(rootNode);
+ tree.scrollRowToVisible(treeModel.getChildCount(rootNode)-1);
+ }
+
+ /**
+ * Sets the selection of the map to the current selected items.
+ */
+ @SuppressWarnings("unchecked")
+ public void setSelectedItems()
+ {
+ Collection sel = new HashSet(40);
+
+ TreePath[] selectedPaths = tree.getSelectionPaths();
+ for( TreePath path : selectedPaths)
+ {
+ DefaultMutableTreeNode node = (DefaultMutableTreeNode)path.getLastPathComponent();
+ Enumeration children = node.breadthFirstEnumeration();
+ while( children.hasMoreElements() )
+ {
+ DefaultMutableTreeNode childNode = children.nextElement();
+ Object nodeInfo = childNode.getUserObject();
+ if( nodeInfo instanceof TestError)
+ {
+ TestError error = (TestError)nodeInfo;
+ sel.addAll( error.getPrimitives() );
+ }
+ }
+ }
+ Main.ds.setSelected(sel);
+ }
+
+ public void actionPerformed(ActionEvent e)
+ {
+ if( e.getActionCommand().equals("Select"))
+ setSelectedItems();
+ else if( e.getActionCommand().equals("Validate"))
+ OSMValidatorPlugin.getPlugin().validateAction.actionPerformed(e);
+ }
+
+ /**
+ * Refresh the error messages display
+ */
+ public void refresh()
+ {
+ buildTree();
+ }
+
+ /**
+ * Watches for double clicks and from editing or new property, depending on the
+ * location, the click was.
+ * @author imi
+ */
+ public class DblClickWatch extends MouseAdapter
+ {
+ @SuppressWarnings("unchecked")
+ @Override
+ public void mouseClicked(MouseEvent e)
+ {
+ if (e.getClickCount() < 2 || e.getSource() instanceof JScrollPane)
+ return;
+ else
+ {
+ Collection sel = new HashSet(40);
+
+ DefaultMutableTreeNode node = (DefaultMutableTreeNode)tree.getLastSelectedPathComponent();
+ Enumeration children = node.breadthFirstEnumeration();
+ while( children.hasMoreElements() )
+ {
+ DefaultMutableTreeNode childNode = children.nextElement();
+ Object nodeInfo = childNode.getUserObject();
+ if( nodeInfo instanceof TestError)
+ {
+ TestError error = (TestError)nodeInfo;
+ sel.addAll( error.getPrimitives() );
+ }
+ }
+ Main.ds.setSelected(sel);
+ }
+ }
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/DuplicateNode.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/DuplicateNode.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/DuplicateNode.java (revision 2453)
@@ -0,0 +1,57 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.util.List;
+
+import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.osm.Node;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+import org.openstreetmap.josm.plugins.validator.util.Bag;
+/**
+ * Tests if there are duplicate nodes
+ *
+ * @author frsantos
+ */
+public class DuplicateNode extends Test
+{
+ /** Bag of all nodes */
+ Bag nodes;
+
+ /**
+ * Constructor
+ */
+ public DuplicateNode()
+ {
+ super(tr("Duplicated nodes."),
+ tr("This test checks that there are no nodes at the very same location."));
+ }
+
+
+ @Override
+ public void startTest()
+ {
+ nodes = new Bag(1000);
+ }
+
+ @Override
+ public void endTest()
+ {
+ for(List duplicated : nodes.values() )
+ {
+ if( duplicated.size() > 1)
+ {
+ errors.add( new TestError(Severity.ERROR, tr("Duplicated nodes"), duplicated) );
+ }
+ }
+ nodes = null;
+ }
+
+ @Override
+ public void visit(Node n)
+ {
+ nodes.add(n.coor, n);
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/DuplicateSegment.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/DuplicateSegment.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/DuplicateSegment.java (revision 2453)
@@ -0,0 +1,97 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.util.List;
+
+import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.osm.Segment;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+import org.openstreetmap.josm.plugins.validator.util.Bag;
+/**
+ * Tests if there are duplicate segments
+ *
+ * @author frsantos
+ */
+public class DuplicateSegment extends Test
+{
+ /** Bag of all segments */
+ Bag segments;
+
+ /**
+ * Constructor
+ */
+ public DuplicateSegment()
+ {
+ super(tr("Duplicated segments."),
+ tr("This test checks that two nodes are not used by more than one segment."));
+
+ }
+
+
+ @Override
+ public void startTest()
+ {
+ segments = new Bag(1000);
+ }
+
+ @Override
+ public void endTest()
+ {
+ for(List duplicated : segments.values() )
+ {
+ if( duplicated.size() > 1)
+ {
+ errors.add( new TestError(Severity.ERROR, tr("Duplicated segments"), duplicated) );
+ }
+ }
+ segments = null;
+ }
+
+ @Override
+ public void visit(Segment s)
+ {
+ if( !s.incomplete ) segments.add( new CompoundLatLon(s), s);
+ }
+
+ /**
+ * Compound LatLong for easy duplicity check
+ * @author frsantos
+ */
+ class CompoundLatLon
+ {
+ /** From position */
+ LatLon from;
+ /** To position */
+ LatLon to;
+
+ /**
+ * Constructor
+ * @param s The segment
+ */
+ public CompoundLatLon(Segment s)
+ {
+ this.from = s.from.coor;
+ this.to = s.to.coor;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (obj == null || getClass() != obj.getClass() )
+ return super.equals(obj);
+
+ CompoundLatLon other = (CompoundLatLon)obj;
+ return from.equals(other.from) && to.equals(other.to) ||
+ to.equals(other.from) && from.equals(other.to);
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return from.hashCode() + to.hashCode();
+ }
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/OrphanSegment.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/OrphanSegment.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/OrphanSegment.java (revision 2453)
@@ -0,0 +1,61 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import org.openstreetmap.josm.data.osm.Segment;
+import org.openstreetmap.josm.data.osm.Way;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+
+/**
+ * Check that every segment is in a way
+ *
+ * @author frsantos
+ */
+public class OrphanSegment extends Test
+{
+ /** Bag of all nodes */
+ Set segments;
+
+ /**
+ * Constructor
+ */
+ public OrphanSegment()
+ {
+ super(tr("Orphaned segments."),
+ tr("This test checks that every segment is in a way."));
+ }
+
+
+ @Override
+ public void startTest()
+ {
+ segments = new HashSet(1000);
+ }
+
+ @Override
+ public void endTest()
+ {
+ for(Segment segment : segments )
+ {
+ errors.add( new TestError(Severity.OTHER, tr("Segments not in a way"), segment) );
+ }
+ segments = null;
+ }
+
+ @Override
+ public void visit(Segment s)
+ {
+ segments.add(s);
+ }
+
+ @Override
+ public void visit(Way w)
+ {
+ segments.removeAll(w.segments);
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/SingleNodeSegment.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/SingleNodeSegment.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/SingleNodeSegment.java (revision 2453)
@@ -0,0 +1,36 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import org.openstreetmap.josm.data.osm.Segment;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+
+/**
+ * Checks that from/to nodes in a segment are different
+ *
+ * @author frsantos
+ */
+public class SingleNodeSegment extends Test
+{
+ /** Tags allowed in a segment */
+ public static String[] allowedTags = new String[] { "created_by" };
+ /**
+ * Constructor
+ */
+ public SingleNodeSegment()
+ {
+ super(tr("Single node segments."),
+ tr("This test checks that there are no segments with the same node as start and destination."));
+ }
+
+ @Override
+ public void visit(Segment s)
+ {
+ if( !s.incomplete && s.from.equals(s.to) )
+ {
+ errors.add( new TestError(Severity.ERROR, tr("Single node segments"), s) );
+ }
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/SpellCheck.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/SpellCheck.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/SpellCheck.java (revision 2453)
@@ -0,0 +1,281 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.io.*;
+import java.net.URL;
+import java.util.*;
+import java.util.Map.Entry;
+
+import javax.swing.JCheckBox;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.osm.*;
+import org.openstreetmap.josm.gui.annotation.AnnotationPreset;
+import org.openstreetmap.josm.gui.annotation.AnnotationPreset.*;
+import org.openstreetmap.josm.gui.preferences.AnnotationPresetPreference;
+import org.openstreetmap.josm.plugins.validator.*;
+import org.openstreetmap.josm.plugins.validator.util.Bag;
+import org.openstreetmap.josm.tools.GBC;
+import org.openstreetmap.josm.tools.XmlObjectParser;
+import org.xml.sax.SAXException;
+
+/**
+ * Check for mispelled properties
+ *
+ * @author frsantos
+ */
+public class SpellCheck extends Test
+{
+ /** The spell check key substitutions: the key should be substituted by the value */
+ protected static Map spellCheckKeyData;
+
+ /** The spell check preset values */
+ protected static Bag spellCheckValueData;
+
+ /** Preference name for checking values */
+ public static final String PREF_CHECK_VALUES = "tests." + SpellCheck.class.getSimpleName() + ".checkValues";
+
+ /** Whether to check values too */
+ protected boolean checkValues = false;
+
+ /** Preferences checkbox */
+ protected JCheckBox prefCheckValues;
+
+ /**
+ * Constructor
+ */
+ public SpellCheck()
+ {
+ super(tr("Spell checker."),
+ tr("This plugin checks misspelled property keys and values."));
+ }
+
+ public static void initialize(OSMValidatorPlugin plugin) throws Exception
+ {
+ initializeSpellCheck(plugin);
+ initializePresets(plugin);
+ }
+
+ /**
+ * Reads the spellcheck file into a HashMap.
+ *
+ * The data file is a list of words, beginning with +/-. If it starts with +,
+ * the word is valid, but if it starts with -, the word should be replaced
+ * by the nearest + word before this.
+ *
+ * @param plugin The validator plugin
+ * @throws FileNotFoundException
+ * @throws IOException
+ */
+ private static void initializeSpellCheck(OSMValidatorPlugin plugin) throws FileNotFoundException, IOException
+ {
+ plugin.copy("/resources/spellCheck.data", "spellCheck.data");
+ BufferedReader reader = new BufferedReader( new FileReader(plugin.getPluginDir() + "/spellCheck.data") );
+
+ spellCheckKeyData = new HashMap();
+ String okValue = null;
+ do
+ {
+ String line = reader.readLine();
+ if( line == null || line.length() == 0 )
+ break;
+
+ if( line.charAt(0) == '+' )
+ {
+ okValue = line.substring(1);
+ }
+ else if( line.charAt(0) == '-' && okValue != null )
+ {
+ spellCheckKeyData.put(line.substring(1), okValue);
+ }
+ else
+ {
+ System.err.println("Invalid spellcheck line:" + line);
+ }
+ }
+ while( true );
+ }
+
+ /**
+ * Reads the presets data.
+ *
+ * @param plugin The validator plugin
+ * @throws Exception
+ */
+ public static void initializePresets(@SuppressWarnings("unused") OSMValidatorPlugin plugin) throws Exception
+ {
+ if( Main.pref.getBoolean(PREF_CHECK_VALUES) )
+ return;
+
+ Collection presets = AnnotationPresetPreference.annotationPresets;
+ if( presets == null || presets.isEmpty() )
+ {
+ // Skip re-reading presets if there are none available
+ return;
+ }
+
+ spellCheckValueData = new Bag();
+ readPresetFromPreferences();
+
+ // TODO: allow per user word definitions
+ }
+
+
+ @Override
+ public void visit(Node n)
+ {
+ checkPrimitive(n);
+ }
+
+
+ @Override
+ public void visit(Segment s)
+ {
+ checkPrimitive(s);
+ }
+
+
+ @Override
+ public void visit(Way w)
+ {
+ checkPrimitive(w);
+ }
+
+ /**
+ * Checks the spelling of the primitive properties
+ * @param p The primitive to check
+ */
+ private void checkPrimitive(OsmPrimitive p)
+ {
+ // Just a collection to know if a primitive has been already marked with error
+ Bag withErrors = new Bag();
+
+ Map props = (p.keys == null) ? Collections.emptyMap() : p.keys;
+ for(Entry prop: props.entrySet() )
+ {
+ String key = prop.getKey();
+ String value = prop.getValue();
+ if( (value==null || value.trim().length() == 0) && !withErrors.contains(p, "EV"))
+ {
+ errors.add( new TestError(Severity.WARNING, tr("Tags with empty value"), p) );
+ withErrors.add(p, "EV");
+ }
+ if( spellCheckKeyData.containsKey(key) && !withErrors.contains(p, "IPK"))
+ {
+ errors.add( new TestError(Severity.WARNING, tr("Invalid property key"), p) );
+ withErrors.add(p, "IPK");
+ }
+ if( checkValues && value != null && value.length() > 0 )
+ {
+ List values = spellCheckValueData.get(key);
+ if( values != null && !values.contains(prop.getValue()) && !withErrors.contains(p, "UPV"))
+ {
+ errors.add( new TestError(Severity.OTHER, tr("Unknown property value"), p) );
+ withErrors.add(p, "UPV");
+ }
+ }
+ }
+ }
+
+ /**
+ * Parse an anotation preset from a stream
+ *
+ * @param inStream The stream of the anotstion preset
+ * @throws SAXException
+ */
+ public static void readPresets(InputStream inStream) throws SAXException
+ {
+ BufferedReader in = null;
+ try
+ {
+ in = new BufferedReader(new InputStreamReader(inStream, "UTF-8"));
+ }
+ catch (UnsupportedEncodingException e)
+ {
+ e.printStackTrace();
+ in = new BufferedReader(new InputStreamReader(inStream));
+ }
+
+ XmlObjectParser parser = new XmlObjectParser();
+ parser.mapOnStart("item", AnnotationPreset.class);
+ parser.map("text", Text.class);
+ parser.map("check", Check.class);
+ parser.map("combo", Combo.class);
+ parser.map("label", Label.class);
+ parser.map("key", Key.class);
+ parser.start(in);
+
+ while(parser.hasNext())
+ {
+ Object obj = parser.next();
+ if (obj instanceof Combo) {
+ Combo combo = (Combo)obj;
+ for(String value : combo.values.split(",") )
+ spellCheckValueData.add(combo.key, value);
+ }
+ }
+ }
+
+ /**
+ * Reads the annotations presets
+ */
+ public static void readPresetFromPreferences()
+ {
+ String allAnnotations = Main.pref.get("annotation.sources");
+ StringTokenizer st = new StringTokenizer(allAnnotations, ";");
+ while (st.hasMoreTokens())
+ {
+ InputStream in = null;
+ String source = st.nextToken();
+ try
+ {
+ if (source.startsWith("http") || source.startsWith("ftp") || source.startsWith("file"))
+ in = new URL(source).openStream();
+ else if (source.startsWith("resource://"))
+ in = Main.class.getResourceAsStream(source.substring("resource:/".length()));
+ else
+ in = new FileInputStream(source);
+ readPresets(in);
+ in.close();
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace();
+ JOptionPane.showMessageDialog(Main.parent, tr("Could not read annotation preset source: {0}",source));
+ }
+ catch (SAXException e)
+ {
+ e.printStackTrace();
+ JOptionPane.showMessageDialog(Main.parent, tr("Error parsing {0}: ", source)+e.getMessage());
+ }
+ }
+ }
+
+ @Override
+ public void startTest()
+ {
+ checkValues = Main.pref.getBoolean("tests." + getClass().getSimpleName() + ".checkValues");
+ }
+
+ @Override
+ public void addGui(JPanel testPanel)
+ {
+ boolean checkValues = Main.pref.getBoolean(PREF_CHECK_VALUES);
+
+ String text = tr("Check also property values from presets");
+ prefCheckValues = new JCheckBox(text, checkValues);
+ prefCheckValues.setToolTipText(text);
+ testPanel.add(prefCheckValues, GBC.eop().insets(40,0,0,0));
+ }
+
+ @Override
+ public void ok()
+ {
+ Main.pref.put(PREF_CHECK_VALUES, prefCheckValues.isSelected());
+ }
+}
+
+
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/TaggedSegment.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/TaggedSegment.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/TaggedSegment.java (revision 2453)
@@ -0,0 +1,47 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.util.Map;
+
+import org.openstreetmap.josm.data.osm.Segment;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+
+/**
+ * Check if a segment has tags
+ *
+ * @author frsantos
+ */
+public class TaggedSegment extends Test
+{
+ /** Tags allowed in a segment */
+ public static String[] allowedTags = new String[] { "created_by", "converted_by", "source" };
+
+ /**
+ * Constructor
+ */
+ public TaggedSegment()
+ {
+ super(tr("Tagged segments"),
+ tr("This test checks that no segment segment is tagged. Only ways should be tagged."));
+ }
+
+ @Override
+ public void visit(Segment s)
+ {
+ Map tags = s.keys;
+ if( tags == null )
+ return;
+
+ int numAllowedTags = 0;
+ for( String tag : allowedTags)
+ if( tags.containsKey(tag) ) numAllowedTags++;
+
+ if( tags.size() - numAllowedTags > 0 )
+ {
+ errors.add( new TestError(Severity.WARNING, tr("Segments with tags"), s) );
+ }
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/UnorderedWay.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/UnorderedWay.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/UnorderedWay.java (revision 2453)
@@ -0,0 +1,41 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import org.openstreetmap.josm.data.osm.Segment;
+import org.openstreetmap.josm.data.osm.Way;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+
+/**
+ * Check for unordered ways
+ *
+ * @author frsantos
+ */
+public class UnorderedWay extends Test
+{
+ /**
+ * Constructor
+ */
+ public UnorderedWay()
+ {
+ super(tr("Unordered ways."),
+ tr("This test checks that all segments in a way are properly ordered."));
+ }
+
+ @Override
+ public void visit(Way w)
+ {
+ Segment last = null;
+ for(Segment s: w.segments)
+ {
+ if( last != null && !last.incomplete && !s.incomplete && !last.to.equals(s.from) )
+ {
+ errors.add( new TestError(Severity.WARNING, tr("Unordered ways"), w) );
+ break;
+ }
+ last = s;
+ }
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/UntaggedNode.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/UntaggedNode.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/tests/UntaggedNode.java (revision 2453)
@@ -0,0 +1,76 @@
+package org.openstreetmap.josm.plugins.validator.tests;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import org.openstreetmap.josm.data.osm.Node;
+import org.openstreetmap.josm.data.osm.Segment;
+import org.openstreetmap.josm.plugins.validator.Severity;
+import org.openstreetmap.josm.plugins.validator.Test;
+import org.openstreetmap.josm.plugins.validator.TestError;
+/**
+ * Checks for untagged nodes that are in no segment
+ *
+ * @author frsantos
+ */
+public class UntaggedNode extends Test
+{
+ /** Tags allowed in a segment */
+ public static String[] allowedTags = new String[] { "created_by" };
+
+ /** Bag of all nodes */
+ Set emptyNodes;
+
+ /**
+ * Constructor
+ */
+ public UntaggedNode()
+ {
+ super(tr("Untagged nodes."),
+ tr("This test checks for untagged nodes that are not part of any segment."));
+ }
+
+ @Override
+ public void startTest()
+ {
+ emptyNodes = new HashSet(100);
+ }
+
+ @Override
+ public void visit(Node n)
+ {
+ int numTags = 0;
+ Map tags = n.keys;
+ if( tags != null )
+ {
+ numTags = tags.size();
+ for( String tag : allowedTags)
+ if( tags.containsKey(tag) ) numTags--;
+ }
+
+ if( numTags == 0 )
+ {
+ emptyNodes.add(n);
+ }
+ }
+
+ @Override
+ public void visit(Segment s)
+ {
+ emptyNodes.remove(s.from);
+ emptyNodes.remove(s.to);
+ }
+
+ @Override
+ public void endTest()
+ {
+ for(Node node : emptyNodes)
+ {
+ errors.add( new TestError(Severity.OTHER, tr("Untagged and unconnected nodes"), node) );
+ }
+ emptyNodes = null;
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/AgregatePrimitivesVisitor.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/AgregatePrimitivesVisitor.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/AgregatePrimitivesVisitor.java (revision 2453)
@@ -0,0 +1,90 @@
+package org.openstreetmap.josm.plugins.validator.util;
+
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.TreeSet;
+
+import org.openstreetmap.josm.data.osm.*;
+import org.openstreetmap.josm.data.osm.visitor.Visitor;
+
+/**
+ * A visitor that aggregates all primitives it visits.
+ *
+ * The primitives are sorted according to their tyep: first Nodes, then
+ * Segments, and Ways last.
+ *
+ * @author frsantos
+ */
+public class AgregatePrimitivesVisitor implements Visitor
+{
+ /** Aggregated data */
+ Collection aggregatedData;
+
+ /**
+ * Constructor
+ */
+ public AgregatePrimitivesVisitor()
+ {
+ aggregatedData = new TreeSet( new PrimitiveComparator());
+ }
+
+ /**
+ * Visits a collection of primitives
+ * @param data The collection of primitives
+ * @return The aggregated primitives
+ */
+ public Collection visit(Collection data)
+ {
+ for (OsmPrimitive osm : data)
+ {
+ osm.visit(this);
+ }
+
+ return aggregatedData;
+ }
+
+ public void visit(Node n)
+ {
+ aggregatedData.add(n);
+ }
+
+ public void visit(Segment s)
+ {
+ aggregatedData.add(s);
+ if( s.from != null ) visit(s.from);
+ if( s.to != null ) visit(s.to);
+ }
+
+ public void visit(Way w)
+ {
+ aggregatedData.add(w);
+ for(Segment s : w.segments)
+ visit(s);
+ }
+
+ /**
+ * A comparator that orders Nodes first, then Segments and Ways last.
+ *
+ * @author frsantos
+ */
+ class PrimitiveComparator implements Comparator
+ {
+ public int compare(OsmPrimitive o1, OsmPrimitive o2)
+ {
+ if( o1 instanceof Node)
+ {
+ return o2 instanceof Node ? o1.compareTo(o2) : -1;
+ }
+ else if( o1 instanceof Way)
+ {
+ return o2 instanceof Way ? o1.compareTo(o2) : 1;
+ }
+ else // o1 is a segment
+ {
+ if( o2 instanceof Node ) return 1;
+ if( o2 instanceof Way ) return -1;
+ return o1.compareTo(o2);
+ }
+ }
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/Bag.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/Bag.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/Bag.java (revision 2453)
@@ -0,0 +1,78 @@
+package org.openstreetmap.josm.plugins.validator.util;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+/**
+ *
+ * A very simple bag to store multiple occurences of a same key.
+ *
+ * The bag will keep, for each key, a list of values.
+ *
+ * @author frsantos
+ *
+ * @param The key class
+ * @param The value class
+ */
+public class Bag extends HashMap>
+{
+ /** Serializable ID */
+ private static final long serialVersionUID = 5374049172859211610L;
+
+ /**
+ * Returns the list of elements with the same key
+ * @param key The key to obtain the elements
+ * @return the list of elements with the same key
+ */
+ public List get(K key)
+ {
+ return super.get(key);
+ }
+
+ /**
+ * Adds an element to the bag
+ * @param key The key of the element
+ * @param value The element to add
+ */
+ public void add(K key, V value)
+ {
+ List values = get(key);
+ if( values == null )
+ {
+ values = new ArrayList();
+ put(key, values);
+ }
+ values.add(value);
+ }
+
+ /**
+ * Constructor
+ */
+ public Bag()
+ {
+ super();
+ }
+
+ /**
+ * Constructor
+ *
+ * @param initialCapacity The initial capacity
+ */
+ public Bag(int initialCapacity)
+ {
+ super(initialCapacity);
+ }
+
+ /**
+ * Returns true if the bag contains a value for a key
+ * @param key The key
+ * @param value The value
+ * @return true if the key contains the value
+ */
+ public boolean contains(K key, V value)
+ {
+ List values = get(key);
+ return (values == null) ? false : values.contains(value);
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/MultipleNameVisitor.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/MultipleNameVisitor.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/MultipleNameVisitor.java (revision 2453)
@@ -0,0 +1,76 @@
+package org.openstreetmap.josm.plugins.validator.util;
+
+import static org.openstreetmap.josm.tools.I18n.trn;
+
+import java.util.Collection;
+
+import javax.swing.Icon;
+import javax.swing.JLabel;
+
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
+import org.openstreetmap.josm.data.osm.visitor.NameVisitor;
+import org.openstreetmap.josm.tools.ImageProvider;
+
+/**
+ * Able to create a name and an icon for a collection of elements.
+ *
+ * @author frsantos
+ */
+public class MultipleNameVisitor extends NameVisitor
+{
+ /** The class name of the combined primitives */
+ String multipleClassname;
+ /** Size of the collection */
+ int size;
+
+ /**
+ * Visits a collection of primitives
+ * @param data The collection of primitives
+ */
+ public void visit(Collection data)
+ {
+ size = data.size();
+ multipleClassname = null;
+ for (OsmPrimitive osm : data)
+ {
+ osm.visit(this);
+ if (multipleClassname == null)
+ multipleClassname = className;
+ else if (!multipleClassname.equals(className))
+ multipleClassname = "object";
+ }
+ }
+
+ @Override
+ public JLabel toLabel()
+ {
+ if( size == 1 )
+ return super.toLabel();
+ else
+ return new JLabel( size + " " + trn(multipleClassname, multipleClassname + "s", size), ImageProvider.get("data", multipleClassname), JLabel.HORIZONTAL);
+ }
+
+ /**
+ * Gets the name of the items
+ * @return the name of the items
+ */
+ public String getText()
+ {
+ if( size == 1 )
+ return name;
+ else
+ return size + " " + trn(multipleClassname, multipleClassname + "s", size);
+ }
+
+ /**
+ * Gets the icon of the items
+ * @return the icon of the items
+ */
+ public Icon getIcon()
+ {
+ if( size == 1 )
+ return icon;
+ else
+ return ImageProvider.get("data", multipleClassname);
+ }
+}
Index: utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/Util.java
===================================================================
--- utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/Util.java (revision 2453)
+++ utils/josm/plugins/validator/src/org/openstreetmap/josm/plugins/validator/util/Util.java (revision 2453)
@@ -0,0 +1,166 @@
+package org.openstreetmap.josm.plugins.validator.util;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.awt.event.ActionListener;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.net.URL;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.swing.JButton;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.plugins.Plugin;
+import org.openstreetmap.josm.plugins.PluginProxy;
+import org.openstreetmap.josm.tools.ImageProvider;
+
+/**
+ * Utility class
+ *
+ * @author frsantos
+ */
+public class Util
+{
+
+ /**
+ * Utility method to retrieve the plugin for classes that can't access to the plugin object directly.
+ *
+ * @param clazz The plugin class
+ * @return The YWMS plugin
+ */
+ public static Plugin getPlugin(Class clazz)
+ {
+ String classname = clazz.getName();
+ for (PluginProxy plugin : Main.plugins)
+ {
+ if( plugin.info.className.equals(classname) )
+ {
+ return (Plugin)plugin.plugin;
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Returns the plugin's directory of a plugin
+ *
+ * Utility method for classes that can't acces the plugin object
+ *
+ * @param clazz The plugin class to look for
+ * @return The directory of the plugin
+ */
+ public static String getStaticPluginDir(Class clazz)
+ {
+ Plugin plugin = getPlugin(clazz);
+ return ( plugin != null ) ? plugin.getPluginDir() : null;
+ }
+
+ /**
+ * Utility method for creating buttons
+ * @param name The name of the button
+ * @param icon Icon of the button
+ * @param tooltip Tooltip
+ * @param action The action performed when clicking the button
+ * @return The created button
+ */
+ public static JButton createButton(String name, String icon, String tooltip, ActionListener action)
+ {
+ JButton button = new JButton(tr(name), ImageProvider.get(icon));
+ button.setActionCommand(name);
+ button.addActionListener(action);
+ button.setToolTipText(tr(tooltip));
+ button.putClientProperty("help", "Dialog/SelectionList/" + name);
+ return button;
+ }
+
+
+ /**
+ * Returns the version
+ * @return The version of the application
+ */
+ public static Version getVersion()
+ {
+ String revision;
+ try
+ {
+ revision = loadFile(Util.class.getResource("/resources/REVISION"));
+ }
+ catch (Exception e)
+ {
+ return null;
+ }
+
+ Pattern versionPattern = Pattern.compile(".*?Revision: ([0-9]*).*", Pattern.CASE_INSENSITIVE|Pattern.DOTALL);
+ Matcher match = versionPattern.matcher(revision);
+ String version = match.matches() ? match.group(1) : "UNKNOWN";
+
+ Pattern timePattern = Pattern.compile(".*?Last Changed Date: ([^\n]*).*", Pattern.CASE_INSENSITIVE|Pattern.DOTALL);
+ match = timePattern.matcher(revision);
+ String time = match.matches() ? match.group(1) : "UNKNOWN";
+
+ return new Version(version, time);
+ }
+
+ /**
+ * Utility class for displaying versions
+ *
+ * @author frsantos
+ */
+ public static class Version
+ {
+ /** The revision */
+ public String revision;
+ /** The build time */
+ public String time;
+
+ /**
+ * Constructor
+ * @param revision
+ * @param time
+ */
+ public Version(String revision, String time)
+ {
+ this.revision = revision;
+ this.time = time;
+ }
+ }
+
+
+ /**
+ * Loads a text file in a String
+ *
+ * @param resource The URL of the file
+ * @return A String with the file contents
+ * @throws IOException when error reading the file
+ */
+ public static String loadFile(URL resource) throws IOException
+ {
+ BufferedReader in = null;
+ try
+ {
+ in = new BufferedReader(new InputStreamReader(resource.openStream()));
+ StringBuilder sb = new StringBuilder();
+ for (String line = in.readLine(); line != null; line = in.readLine())
+ {
+ sb.append(line);
+ sb.append('\n');
+ }
+ return sb.toString();
+ }
+ finally
+ {
+ if( in != null )
+ {
+ try {
+ in.close();
+ } catch (IOException e) {
+ e.printStackTrace();
+ }
+ }
+ }
+ }
+}