Changes in / [7499:7505] in josm

Location:

/trunk

Files:

• data/tagging-preset.xsd (modified) (7 diffs)
• src/org/openstreetmap/josm/data/osm/DataSet.java (modified) (5 diffs)
• src/org/openstreetmap/josm/data/osm/DatasetConsistencyTest.java (modified) (12 diffs)
• src/org/openstreetmap/josm/gui/tagging/TaggingPresetItems.java (modified) (3 diffs)
• src/org/openstreetmap/josm/gui/widgets/JosmTextField.java (modified) (4 diffs)

/trunk/data/tagging-preset.xsd

@@ -86 +86 @@
         </complexType>
 
-    <complexType name="chunk">
-        <sequence>
-            <choice minOccurs="1" maxOccurs="unbounded">
-                <group ref="tns:optional_elements" />
-                <element name="key" type="tns:key" />
-                <element name="optional" type="tns:optional" minOccurs="0" />
-            </choice>
-        </sequence>
-        <attribute name="id" type="ID" use="required" />
-    </complexType>
-
-    <complexType name="reference">
-        <attribute name="ref" type="IDREF" use="required" />
-    </complexType>
-
-    <group name="optional_elements">
+        <complexType name="chunk">
+                <choice minOccurs="1" maxOccurs="1">
+                        <sequence>
+                                <choice minOccurs="1" maxOccurs="unbounded">
+                                        <group ref="tns:optional_elements" />
+                                        <element name="key" type="tns:key" />
+                                        <element name="optional" type="tns:optional" minOccurs="0" />
+                                </choice>
+                        </sequence>
+                        <sequence>
+                                <!-- Cannot use tns:list_elements here because reference is present both in optional_elements and list_elements
+                                so it violates cos-nonambig: Unique Particle Attribution :
+                                <group ref="tns:list_elements" minOccurs="1" maxOccurs="unbounded" />-->
+                                <element name="list_entry" type="tns:list_entry" minOccurs="1" maxOccurs="unbounded" />
+                        </sequence>
+                </choice>
+                <attribute name="id" type="ID" use="required" />
+        </complexType>
+
+        <complexType name="reference">
+                <attribute name="ref" type="IDREF" use="required" />
+        </complexType>
+
+        <group name="optional_elements">
                 <choice>
                         <element name="label" type="tns:label" />
@@ -117 +125 @@
         </group>
 
+        <group name="list_elements">
+                <choice>
+                        <element name="list_entry" type="tns:list_entry" />
+                        <element name="reference" type="tns:reference" />
+                </choice>
+        </group>
+
         <complexType name="key">
                 <attribute name="key" type="string" use="required" />
@@ -122 +137 @@
                 <attribute name="match" type="string" />
         </complexType>
-
 
         <complexType name="link">
@@ -179 +193 @@
                 <!-- use either list_entry's or a combination of values/display_values -->
                 <sequence>
-                        <element name="list_entry" type="tns:list_entry" minOccurs="0" maxOccurs="unbounded" />
+                        <group ref="tns:list_elements" minOccurs="0" maxOccurs="unbounded" />
                 </sequence>
                 <attribute name="key" type="string" use="required" />
@@ -207 +221 @@
                 <!-- use either list_entry's or a combination of values/display_values -->
                 <sequence>
-                        <element name="list_entry" type="tns:list_entry" minOccurs="0" maxOccurs="unbounded" />
+                        <group ref="tns:list_elements" minOccurs="0" maxOccurs="unbounded" />
                 </sequence>
                 <attribute name="key" type="string" use="required" />
@@ -216 +230 @@
                 <attribute name="values_context" type="string" />
                 <attribute name="display_values" type="string" />
-        <attribute name="values_searchable" type="boolean" />
+                <attribute name="values_searchable" type="boolean" />
                 <attribute name="default" type="string" />
                 <attribute name="use_last_as_default" type="tns:last_default" />
@@ -247 +261 @@
                 <attribute name="value_on" type="string" />
                 <attribute name="value_off" type="string" />
-        <attribute name="disable_off" type="boolean" />
+                <attribute name="disable_off" type="boolean" />
                 <attribute name="match" type="tns:match" />
 

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

@@ -102 +102 @@
     private static final int MAX_EVENTS = 1000;
 
-    private Storage<OsmPrimitive> allPrimitives = new Storage<>(new Storage.PrimitiveIdHash(), true);
-    private Map<PrimitiveId, OsmPrimitive> primitivesMap = allPrimitives.foreignKey(new Storage.PrimitiveIdHash());
-    private CopyOnWriteArrayList<DataSetListener> listeners = new CopyOnWriteArrayList<>();
+    private final Storage<OsmPrimitive> allPrimitives = new Storage<>(new Storage.PrimitiveIdHash(), true);
+    private final Map<PrimitiveId, OsmPrimitive> primitivesMap = allPrimitives.foreignKey(new Storage.PrimitiveIdHash());
+    private final CopyOnWriteArrayList<DataSetListener> listeners = new CopyOnWriteArrayList<>();
 
     // provide means to highlight map elements that are not osm primitives
@@ -257 +257 @@
      * conversion of the whole DataSet by iterating over this data structure.
      */
-    private QuadBuckets<Node> nodes = new QuadBuckets<>();
+    private final QuadBuckets<Node> nodes = new QuadBuckets<>();
 
     private <T extends OsmPrimitive> Collection<T> getPrimitives(Predicate<OsmPrimitive> predicate) {
@@ -287 +287 @@
 
     /**
+     * Determines if the given node can be retrieved in the data set through its bounding box. Useful for dataset consistency test.
+     * For efficiency reasons this method does not lock the dataset, you have to lock it manually.
+     *
+     * @param n The node to search
+     * @return {@code true} if {@code n} ban be retrieved in this data set, {@code false} otherwise
+     * @since 7501
+     */
+    public boolean containsNode(Node n) {
+        return nodes.contains(n);
+    }
+
+    /**
      * All ways (Streets etc.) in the DataSet.
      *
      * The way nodes are stored only in the way list.
      */
-    private QuadBuckets<Way> ways = new QuadBuckets<>();
+    private final QuadBuckets<Way> ways = new QuadBuckets<>();
 
     /**
@@ -317 +329 @@
 
     /**
+     * Determines if the given way can be retrieved in the data set through its bounding box. Useful for dataset consistency test.
+     * For efficiency reasons this method does not lock the dataset, you have to lock it manually.
+     *
+     * @param w The way to search
+     * @return {@code true} if {@code w} ban be retrieved in this data set, {@code false} otherwise
+     * @since 7501
+     */
+    public boolean containsWay(Way w) {
+        return ways.contains(w);
+    }
+
+    /**
      * All relations/relationships
      */
-    private Collection<Relation> relations = new ArrayList<>();
+    private final Collection<Relation> relations = new ArrayList<>();
 
     /**
@@ -349 +373 @@
             lock.readLock().unlock();
         }
+    }
+
+    /**
+     * Determines if the given relation can be retrieved in the data set through its bounding box. Useful for dataset consistency test.
+     * For efficiency reasons this method does not lock the dataset, you have to lock it manually.
+     *
+     * @param r The relation to search
+     * @return {@code true} if {@code r} ban be retrieved in this data set, {@code false} otherwise
+     * @since 7501
+     */
+    public boolean containsRelation(Relation r) {
+        return relations.contains(r);
     }
 

/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.data.coor.LatLon;
+import org.openstreetmap.josm.Main;
+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 +24 @@
     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 +41 @@
     }
 
+    /**
+     * 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 +57 @@
         }
 
-        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 +66 @@
             }
         }
-    }
-
+        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 +83 @@
             }
         }
-    }
-
+        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()) {
-            if (!n.isIncomplete() && !n.isDeleted()) {
-                LatLon c = n.getCoor();
-                if (c != null) {
-                    BBox box = c.toBBox(0.0001);
-                    if (!dataSet.searchNodes(box).contains(n)) {
-                        printError("SEARCH NODES", "%s not found using Dataset.searchNodes()", n);
-                    }
-                }
-            }
-        }
-    }
-
+        long startTime = System.currentTimeMillis();
+        dataSet.getReadLock().lock();
+        try {
+            for (Node n : dataSet.getNodes()) {
+                // Call isDrawable() as an efficient replacement to previous checks (!deleted, !incomplete, getCoor() != null)
+                if (n.isDrawable() && !dataSet.containsNode(n)) {
+                    printError("SEARCH NODES", "%s not found using Dataset.containsNode()", n);
+                }
+            }
+        } finally {
+            dataSet.getReadLock().unlock();
+        }
+        printElapsedTime(startTime);
+    }
+
+    /**
+     * Checks that ways can be retrieved through their bounding box.
+     */
     public void searchWays() {
-        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);
-            }
-        }
+        long startTime = System.currentTimeMillis();
+        dataSet.getReadLock().lock();
+        try {
+            for (Way w : dataSet.getWays()) {
+                if (!w.isIncomplete() && !w.isDeleted() && w.getNodesCount() >= 2 && !dataSet.containsWay(w)) {
+                    printError("SEARCH WAYS", "%s not found using Dataset.containsWay()", w);
+                }
+            }
+        } finally {
+            dataSet.getReadLock().unlock();
+        }
+        printElapsedTime(startTime);
     }
 
@@ -112 +150 @@
     }
 
+    /**
+     * 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 +181 @@
             }
         }
-    }
-
+        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 +207 @@
             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 +218 @@
     }
 
+    /**
+     * 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 +228 @@
         return writer.toString();
     }
-
 }

/trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetItems.java

@@ -592 +592 @@
         private JComponent value;
 
-        @Override public boolean addToPanel(JPanel p, Collection<OsmPrimitive> sel, boolean presetInitiallyMatches) {
+        @Override
+        public boolean addToPanel(JPanel p, Collection<OsmPrimitive> sel, boolean presetInitiallyMatches) {
 
             // find out if our key is already used in the selection.
@@ -602 +603 @@
                 initAutoCompletionField(textField, key);
             }
+            textField.setHint(key);
             if (length != null && !length.isEmpty()) {
                 textField.setMaxChars(Integer.valueOf(length));
@@ -1219 +1221 @@
             AutoCompletingTextField tf = new AutoCompletingTextField();
             initAutoCompletionField(tf, key);
+            tf.setHint(key);
             if (length != null && !length.isEmpty()) {
                 tf.setMaxChars(Integer.valueOf(length));

/trunk/src/org/openstreetmap/josm/gui/widgets/JosmTextField.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.widgets;
+
+import java.awt.Color;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.Insets;
+import java.awt.RenderingHints;
+import java.awt.event.FocusEvent;
+import java.awt.event.FocusListener;
 
 import javax.swing.JTextField;
@@ -6 +15 @@
 
 /**
- * Subclass of {@link JTextField} that adds a "native" context menu (cut/copy/paste/select all).
+ * Subclass of {@link JTextField} that adds a "native" context menu (cut/copy/paste/select all)
+ * and an optional "hint" displayed when no text has been entered.
  * @since 5886
  */
-public class JosmTextField extends JTextField {
+public class JosmTextField extends JTextField implements FocusListener {
+
+    private String hint;
 
     /**
@@ -34 +46 @@
             setMinimumSize(getPreferredSize());
         }
+        addFocusListener(this);
     }
 
@@ -84 +97 @@
         this(null, null, 0);
     }
+
+    /**
+     * Replies the hint displayed when no text has been entered.
+     * @return the hint
+     * @since 7505
+     */
+    public final String getHint() {
+        return hint;
+    }
+
+    /**
+     * Sets the hint to display when no text has been entered.
+     * @param hint the hint to set
+     * @since 7505
+     */
+    public final void setHint(String hint) {
+        this.hint = hint;
+    }
+
+    @Override
+    public void paint(Graphics g) {
+        super.paint(g);
+        if (hint != null && !hint.isEmpty() && getText().isEmpty() && !isFocusOwner()) {
+            // Taken from http://stackoverflow.com/a/24571681/2257172
+            int h = getHeight();
+            ((Graphics2D)g).setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
+            Insets ins = getInsets();
+            FontMetrics fm = g.getFontMetrics();
+            int c0 = getBackground().getRGB();
+            int c1 = getForeground().getRGB();
+            int m = 0xfefefefe;
+            int c2 = ((c0 & m) >>> 1) + ((c1 & m) >>> 1);
+            g.setColor(new Color(c2, true));
+            g.drawString(hint, ins.left, h / 2 + fm.getAscent() / 2 - 2);
+        }
+    }
+
+    @Override
+    public void focusGained(FocusEvent e) {
+        repaint();
+    }
+
+    @Override
+    public void focusLost(FocusEvent e) {
+        repaint();
+    }
 }