Changeset 9023 in josm for trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java

Timestamp:

2015-11-19T00:33:55+01:00 (8 years ago)

Author:

Don-vip

Message:

see #12102 - cleanup TagChecker

• code refactor/cleanup/simplification
• clean list of ignored tags by removing tags that have been added to internal presets during past years
• add unit test to detect these tags if we add new tags to internal presets that are currently being ignored

File:

• trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java

@@ -80 +80 @@
     private static final List<String> ignoreDataEquals = new ArrayList<>();
     private static final List<String> ignoreDataEndsWith = new ArrayList<>();
-    private static final List<IgnoreKeyPair> ignoreDataKeyPair = new ArrayList<>();
+    private static final List<Tag> ignoreDataTag = new ArrayList<>();
 
     /** The preferences prefix */
@@ -159 +159 @@
         ignoreDataEquals.clear();
         ignoreDataEndsWith.clear();
-        ignoreDataKeyPair.clear();
+        ignoreDataTag.clear();
         harmonizedKeys.clear();
 
@@ -207 +207 @@
                             break;
                         case "K:":
-                            IgnoreKeyPair tmp = new IgnoreKeyPair();
-                            int mid = line.indexOf('=');
-                            tmp.key = line.substring(0, mid);
-                            tmp.value = line.substring(mid+1);
-                            ignoreDataKeyPair.add(tmp);
+                            ignoreDataTag.add(Tag.ofString(line));
                         }
                     } else if (tagcheckerfile) {
@@ -309 +305 @@
 
     /**
+     * Determines if the given key is in internal presets.
+     * @param key key
+     * @return {@code true} if the given key is in internal presets
+     * @since 9023
+     */
+    public static boolean isKeyInPresets(String key) {
+        return presetsValueData.get(key) != null;
+    }
+
+    /**
+     * Determines if the given tag is in internal presets.
+     * @param key key
+     * @param value value
+     * @return {@code true} if the given tag is in internal presets
+     * @since 9023
+     */
+    public static boolean isTagInPresets(String key, String value) {
+        final Set<String> values = presetsValueData.get(key);
+        return values != null && (values.isEmpty() || values.contains(value));
+    }
+
+    /**
+     * Returns the list of ignored tags.
+     * @return the list of ignored tags
+     * @since 9023
+     */
+    public static List<Tag> getIgnoredTags() {
+        return new ArrayList<>(ignoreDataTag);
+    }
+
+    /**
+     * Determines if the given tag is ignored for checks "key/tag not in presets".
+     * @param key key
+     * @param value value
+     * @return {@code true} if the given tag is ignored
+     * @since 9023
+     */
+    public static boolean isTagIgnored(String key, String value) {
+        boolean tagInPresets = isTagInPresets(key, value);
+        boolean ignore = false;
+
+        for (String a : ignoreDataStartsWith) {
+            if (key.startsWith(a)) {
+                ignore = true;
+            }
+        }
+        for (String a : ignoreDataEquals) {
+            if (key.equals(a)) {
+                ignore = true;
+            }
+        }
+        for (String a : ignoreDataEndsWith) {
+            if (key.endsWith(a)) {
+                ignore = true;
+            }
+        }
+
+        if (!tagInPresets) {
+            for (Tag a : ignoreDataTag) {
+                if (key.equals(a.getKey()) && value.equals(a.getValue())) {
+                    ignore = true;
+                }
+            }
+        }
+        return ignore;
+    }
+
+    /**
      * Checks the primitive tags
      * @param p The primitive to check
@@ -373 +437 @@
             }
             if (checkValues && key != null && value != null && !value.isEmpty() && presetsValueData != null) {
-                final Set<String> values = presetsValueData.get(key);
-                final boolean keyInPresets = values != null;
-                final boolean tagInPresets = values != null && (values.isEmpty() || values.contains(prop.getValue()));
-
-                boolean ignore = false;
-                for (String a : ignoreDataStartsWith) {
-                    if (key.startsWith(a)) {
-                        ignore = true;
-                    }
-                }
-                for (String a : ignoreDataEquals) {
-                    if (key.equals(a)) {
-                        ignore = true;
-                    }
-                }
-                for (String a : ignoreDataEndsWith) {
-                    if (key.endsWith(a)) {
-                        ignore = true;
-                    }
-                }
-
-                if (!tagInPresets) {
-                    for (IgnoreKeyPair a : ignoreDataKeyPair) {
-                        if (key.equals(a.key) && value.equals(a.value)) {
-                            ignore = true;
-                        }
-                    }
-                }
-
-                if (!ignore) {
-                    if (!keyInPresets) {
+                if (!isTagIgnored(key, value)) {
+                    if (!isKeyInPresets(key)) {
                         String prettifiedKey = harmonizeKey(key);
                         String fixedKey = harmonizedKeys.get(prettifiedKey);
@@ -420 +455 @@
                             withErrors.put(p, "UPK");
                         }
-                    } else if (!tagInPresets) {
+                    } else if (!isTagInPresets(key, value)) {
                         // try to fix common typos and check again if value is still unknown
                         String fixedValue = harmonizeValue(prop.getValue());
-                        Map<String, String> possibleValues = getPossibleValues(values);
+                        Map<String, String> possibleValues = getPossibleValues(presetsValueData.get(key));
                         if (possibleValues.containsKey(fixedValue)) {
                             fixedValue = possibleValues.get(fixedValue);
@@ -642 +677 @@
 
         return false;
-    }
-
-    protected static class IgnoreKeyPair {
-        public String key;
-        public String value;
     }