Changeset 7500 in josm

Timestamp:

2014-09-05T14:14:11+02:00 (10 years ago)

Author:

Don-vip

Message:

see #10483 - print elapsed time of data consistency test + update javadoc

File:

• trunk/src/org/openstreetmap/josm/data/osm/DatasetConsistencyTest.java (modified) (13 diffs)

trunk/src/org/openstreetmap/josm/data/osm/DatasetConsistencyTest.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.data.osm;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
 
 import java.io.PrintWriter;
@@ -6 +8 @@
 import java.io.Writer;
 
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
- * This class can be used to run consistency tests on dataset. Any errors found will be written to provided PrintWriter
+ * This class can be used to run consistency tests on dataset. Any errors found will be written to provided PrintWriter.
  * <br>
- * Texts here should not be translated because they're not intended for users but for josm developers
- *
+ * Texts here should not be translated because they're not intended for users but for josm developers.
+ * @since 2500
  */
 public class DatasetConsistencyTest {
@@ -21 +25 @@
     private int errorCount;
 
+    /**
+     * Constructs a new {@code DatasetConsistencyTest}.
+     * @param dataSet The dataset to test
+     * @param writer The writer used to write results
+     */
     public DatasetConsistencyTest(DataSet dataSet, Writer writer) {
         this.dataSet = dataSet;
@@ -33 +42 @@
     }
 
+    /**
+     * Checks that parent primitive is referred from its child members
+     */
     public void checkReferrers() {
+        long startTime = System.currentTimeMillis();
         // It's also error when referred primitive's dataset is null but it's already covered by referredPrimitiveNotInDataset check
-        for (Way way:dataSet.getWays()) {
+        for (Way way : dataSet.getWays()) {
             if (!way.isDeleted()) {
-                for (Node n:way.getNodes()) {
+                for (Node n : way.getNodes()) {
                     if (n.getDataSet() != null && !n.getReferrers().contains(way)) {
                         printError("WAY NOT IN REFERRERS", "%s is part of %s but is not in referrers", n, way);
@@ -45 +58 @@
         }
 
-        for (Relation relation:dataSet.getRelations()) {
+        for (Relation relation : dataSet.getRelations()) {
             if (!relation.isDeleted()) {
-                for (RelationMember m:relation.getMembers()) {
+                for (RelationMember m : relation.getMembers()) {
                     if (m.getMember().getDataSet() != null && !m.getMember().getReferrers().contains(relation)) {
                         printError("RELATION NOT IN REFERRERS", "%s is part of %s but is not in referrers", m.getMember(), relation);
@@ -54 +67 @@
             }
         }
-    }
-
+        printElapsedTime(startTime);
+    }
+
+    /**
+     * Checks for womplete ways with incomplete nodes.
+     */
     public void checkCompleteWaysWithIncompleteNodes() {
-        for (Way way:dataSet.getWays()) {
+        long startTime = System.currentTimeMillis();
+        for (Way way : dataSet.getWays()) {
             if (way.isUsable()) {
-                for (Node node:way.getNodes()) {
+                for (Node node : way.getNodes()) {
                     if (node.isIncomplete()) {
                         printError("USABLE HAS INCOMPLETE", "%s is usable but contains incomplete node '%s'", way, node);
@@ -66 +84 @@
             }
         }
-    }
-
+        printElapsedTime(startTime);
+    }
+
+    /**
+     * Checks for complete nodes without coordinates.
+     */
     public void checkCompleteNodesWithoutCoordinates() {
-        for (Node node:dataSet.getNodes()) {
+        long startTime = System.currentTimeMillis();
+        for (Node node : dataSet.getNodes()) {
             if (!node.isIncomplete() && node.isVisible() && (node.getCoor() == null || node.getEastNorth() == null)) {
                 printError("COMPLETE WITHOUT COORDINATES", "%s is not incomplete but has null coordinates", node);
             }
         }
-    }
-
+        printElapsedTime(startTime);
+    }
+
+    /**
+     * Checks that nodes can be retrieved through their coordinates.
+     */
     public void searchNodes() {
-        for (Node n:dataSet.getNodes()) {
+        long startTime = System.currentTimeMillis();
+        for (Node n : dataSet.getNodes()) {
             if (!n.isIncomplete() && !n.isDeleted()) {
                 LatLon c = n.getCoor();
@@ -88 +116 @@
             }
         }
-    }
-
+        printElapsedTime(startTime);
+    }
+
+    /**
+     * Checks that ways can be retrieved through their bounding box.
+     */
     public void searchWays() {
-        for (Way w:dataSet.getWays()) {
+        long startTime = System.currentTimeMillis();
+        for (Way w : dataSet.getWays()) {
             if (!w.isIncomplete() && !w.isDeleted() && w.getNodesCount() >= 2 && !dataSet.searchWays(w.getBBox()).contains(w)) {
                 printError("SEARCH WAYS", "%s not found using Dataset.searchWays()", w);
             }
         }
+        printElapsedTime(startTime);
     }
 
@@ -112 +146 @@
     }
 
+    /**
+     * Checks that referred primitives are present in dataset.
+     */
     public void referredPrimitiveNotInDataset() {
-        for (Way way:dataSet.getWays()) {
-            for (Node node:way.getNodes()) {
+        long startTime = System.currentTimeMillis();
+        for (Way way : dataSet.getWays()) {
+            for (Node node : way.getNodes()) {
                 checkReferredPrimitive(node, way);
             }
         }
 
-        for (Relation relation:dataSet.getRelations()) {
-            for (RelationMember member:relation.getMembers()) {
+        for (Relation relation : dataSet.getRelations()) {
+            for (RelationMember member : relation.getMembers()) {
                 checkReferredPrimitive(member.getMember(), relation);
             }
         }
-    }
-
-
+        printElapsedTime(startTime);
+    }
+
+    /**
+     * Checks for zero and one-node ways.
+     */
     public void checkZeroNodesWays() {
-        for (Way way:dataSet.getWays()) {
+        long startTime = System.currentTimeMillis();
+        for (Way way : dataSet.getWays()) {
             if (way.isUsable() && way.getNodesCount() == 0) {
                 printError("WARN - ZERO NODES", "Way %s has zero nodes", way);
@@ -135 +177 @@
             }
         }
-    }
-
+        printElapsedTime(startTime);
+    }
+
+    private void printElapsedTime(long startTime) {
+        if (Main.isDebugEnabled()) {
+            StackTraceElement item = Thread.currentThread().getStackTrace()[2];
+            String operation = getClass().getSimpleName() + "." + item.getMethodName();
+            long elapsedTime = System.currentTimeMillis() - startTime;
+            Main.debug(tr("Test ''{0}'' completed in {1}",
+                    operation, Utils.getDurationString(elapsedTime)));
+        }
+    }
+
+    /**
+     * Runs test.
+     */
     public void runTest() {
         try {
+            long startTime = System.currentTimeMillis();
             referredPrimitiveNotInDataset();
             checkReferrers();
@@ -146 +203 @@
             searchWays();
             checkZeroNodesWays();
+            printElapsedTime(startTime);
             if (errorCount > MAX_ERRORS) {
                 writer.println((errorCount - MAX_ERRORS) + " more...");
             }
+
         } catch (Exception e) {
             writer.println("Exception during dataset integrity test:");
@@ -155 +214 @@
     }
 
+    /**
+     * Runs test on the given dataset.
+     * @param dataSet the dataset to test
+     * @return the errors as string
+     */
     public static String runTests(DataSet dataSet) {
         StringWriter writer = new StringWriter();
@@ -160 +224 @@
         return writer.toString();
     }
-
 }