Changeset 17610 in josm

Timestamp:

2021-03-20T23:07:04+01:00 (4 years ago)

Author:

simon04

Message:

see #18949 - Tagging presets: value_template="..." for <text>

Use value_template to generate the value automatically based on other <text> values of this preset. For instance, "Bus {ref}: {from} → {to}" can be used to generate the name of a bus route relation.

Location:

trunk

Files:

• resources/data/tagging-preset.xsd (modified) (1 diff)
• src/org/openstreetmap/josm/gui/tagging/presets/TaggingPreset.java (modified) (2 diffs)
• src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetItemGuiSupport.java (modified) (4 diffs)
• src/org/openstreetmap/josm/gui/tagging/presets/items/KeyedItem.java (modified) (2 diffs)
• src/org/openstreetmap/josm/gui/tagging/presets/items/Text.java (modified) (6 diffs)
• src/org/openstreetmap/josm/tools/template_engine/TemplateEntry.java (modified) (1 diff)

trunk/resources/data/tagging-preset.xsd

@@ -332 +332 @@
             <annotation>
                 <documentation><![CDATA[
-                    A comma separated list of alternative keys to use for auto completion of <text<.
+                    A comma separated list of alternative keys to use for auto completion of <text>.
+                ]]></documentation>
+            </annotation>
+        </attribute>
+        <attribute name="value_template" type="string">
+            <annotation>
+                <documentation><![CDATA[
+                    A template to generate the value automatically based on other <text> values of this preset.
+                    For instance, "Bus {ref}: {from} → {to}" can be used to generate the name of a bus route relation.
                 ]]></documentation>
             </annotation>

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPreset.java

@@ -329 +329 @@
 
         boolean presetInitiallyMatches = !selected.isEmpty() && selected.stream().allMatch(this);
-        final TaggingPresetItemGuiSupport itemGuiSupport = TaggingPresetItemGuiSupport.create(presetInitiallyMatches, selected);
+        final TaggingPresetItemGuiSupport itemGuiSupport = TaggingPresetItemGuiSupport.create(
+                presetInitiallyMatches, selected, this::getChangedTags);
         JPanel items = new JPanel(new GridBagLayout());
         TaggingPresetItem previous = null;
@@ -363 +364 @@
         tb.setFocusable(false);
         p.add(tb, GBC.std(1, 0).anchor(GBC.LINE_END));
+
+        // Trigger initial updates
+        itemGuiSupport.fireItemValueModified(null, null, null);
         return p;
     }

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetItemGuiSupport.java

@@ -3 +3 @@
 
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
+import org.openstreetmap.josm.data.osm.Tag;
+import org.openstreetmap.josm.data.osm.search.SearchCompiler;
+import org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem;
+import org.openstreetmap.josm.tools.ListenerList;
+import org.openstreetmap.josm.tools.template_engine.TemplateEngineDataProvider;
 
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.function.Supplier;
+import java.util.stream.Collectors;
 
 /**
@@ -12 +20 @@
  * @since xxx
  */
-public class TaggingPresetItemGuiSupport {
+public final class TaggingPresetItemGuiSupport implements TemplateEngineDataProvider {
 
     private final Collection<OsmPrimitive> selected;
     private final boolean presetInitiallyMatches;
+    private final Supplier<Collection<Tag>> changedTagsSupplier;
+    private final ListenerList<ChangeListener> listeners = ListenerList.create();
 
-    private TaggingPresetItemGuiSupport(boolean presetInitiallyMatches, Collection<OsmPrimitive> selected) {
+    /**
+     * Interface to notify listeners that a preset item input as changed.
+     * @since xxx
+     */
+    public interface ChangeListener {
+        /**
+         * Notifies this listener that a preset item input as changed.
+         * @param source the source of this event
+         * @param key the tag key
+         * @param newValue the new tag value
+         */
+        void itemValueModified(TaggingPresetItem source, String key, String newValue);
+    }
+
+    private TaggingPresetItemGuiSupport(
+            boolean presetInitiallyMatches, Collection<OsmPrimitive> selected, Supplier<Collection<Tag>> changedTagsSupplier) {
         this.selected = selected;
         this.presetInitiallyMatches = presetInitiallyMatches;
+        this.changedTagsSupplier = changedTagsSupplier;
     }
 
@@ -47 +73 @@
      * @return the new {@code TaggingPresetItemGuiSupport}
      */
-    public static TaggingPresetItemGuiSupport create(boolean presetInitiallyMatches, Collection<OsmPrimitive> selected) {
-        return new TaggingPresetItemGuiSupport(presetInitiallyMatches, selected);
+    public static TaggingPresetItemGuiSupport create(
+            boolean presetInitiallyMatches, Collection<OsmPrimitive> selected, Supplier<Collection<Tag>> changedTagsSupplier) {
+        return new TaggingPresetItemGuiSupport(presetInitiallyMatches, selected, changedTagsSupplier);
     }
 
@@ -58 +85 @@
      * @return the new {@code TaggingPresetItemGuiSupport}
      */
-    public static TaggingPresetItemGuiSupport create(boolean presetInitiallyMatches, OsmPrimitive... selected) {
-        return new TaggingPresetItemGuiSupport(presetInitiallyMatches, Arrays.asList(selected));
+    public static TaggingPresetItemGuiSupport create(
+            boolean presetInitiallyMatches, OsmPrimitive... selected) {
+        return new TaggingPresetItemGuiSupport(presetInitiallyMatches, Arrays.asList(selected), Collections::emptyList);
+    }
+
+    @Override
+    public Collection<String> getTemplateKeys() {
+        return changedTagsSupplier.get().stream().map(Tag::getKey).collect(Collectors.toList());
+    }
+
+    @Override
+    public Object getTemplateValue(String key, boolean special) {
+        return changedTagsSupplier.get().stream()
+                .filter(tag -> key.equals(tag.getKey()))
+                .findFirst().map(Tag::getValue).orElseGet(() -> {
+                    KeyedItem.Usage usage = KeyedItem.determineTextUsage(getSelected(), key);
+                    return usage.hasUniqueValue() ? usage.getFirst() : null;
+                });
+    }
+
+    @Override
+    public boolean evaluateCondition(SearchCompiler.Match condition) {
+        throw new UnsupportedOperationException();
+    }
+
+    /**
+     * Adds a new change listener
+     * @param listener the listener to add
+     */
+    public void addListener(ChangeListener listener) {
+        listeners.addListener(listener);
+    }
+
+    /**
+     * Notifies all listeners that a preset item input as changed.
+     * @param source the source of this event
+     * @param key the tag key
+     * @param newValue the new tag value
+     */
+    public void fireItemValueModified(TaggingPresetItem source, String key, String newValue) {
+        listeners.fireEvent(e -> e.itemValueModified(source, key, newValue));
     }
 }

trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/KeyedItem.java

@@ -96 +96 @@
     /**
      * Usage information on a key
-     */
-    protected static class Usage {
+     *
+     * TODO merge with {@link org.openstreetmap.josm.data.osm.TagCollection}
+     */
+    public static class Usage {
         /**
          * A set of values that were used for this key.
@@ -139 +141 @@
     }
 
-    protected static Usage determineTextUsage(Collection<OsmPrimitive> sel, String key) {
+    /**
+     * Computes the tag usage for the given key from the given primitives
+     * @param sel the primitives
+     * @param key the key
+     * @return the tag usage
+     */
+    public static Usage determineTextUsage(Collection<OsmPrimitive> sel, String key) {
         Usage returnValue = new Usage();
         for (OsmPrimitive s : sel) {

trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/Text.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.awt.Color;
 import java.awt.Component;
 import java.awt.GridBagLayout;
@@ -21 +22 @@
 import javax.swing.JPanel;
 import javax.swing.JToggleButton;
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
 
 import org.openstreetmap.josm.data.osm.Tag;
@@ -32 +35 @@
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Utils;
+import org.openstreetmap.josm.tools.template_engine.ParseError;
+import org.openstreetmap.josm.tools.template_engine.TemplateEntry;
+import org.openstreetmap.josm.tools.template_engine.TemplateParser;
+import org.xml.sax.SAXException;
 
 /**
@@ -59 +66 @@
 
     private JComponent value;
+    private transient TemplateEntry valueTemplate;
 
     @Override
@@ -114 +122 @@
         }
         initializeLocaleText(null);
+
+        setupListeners(textField, support);
 
         // if there's an auto_increment setting, then wrap the text field
@@ -229 +239 @@
         return Collections.singleton(default_);
     }
+
+    public void setValue_template(String pattern) throws SAXException {
+        try {
+            this.valueTemplate = new TemplateParser(pattern).parse();
+        } catch (ParseError e) {
+            Logging.error("Error while parsing " + pattern + ": " + e.getMessage());
+            throw new SAXException(e);
+        }
+    }
+
+    private void setupListeners(AutoCompletingTextField textField, TaggingPresetItemGuiSupport support) {
+        textField.getDocument().addDocumentListener(new DocumentListener() {
+            @Override
+            public void insertUpdate(DocumentEvent e) {
+                support.fireItemValueModified(Text.this, key, textField.getText());
+            }
+
+            @Override
+            public void removeUpdate(DocumentEvent e) {
+                support.fireItemValueModified(Text.this, key, textField.getText());
+            }
+
+            @Override
+            public void changedUpdate(DocumentEvent e) {
+                support.fireItemValueModified(Text.this, key, textField.getText());
+            }
+        });
+
+        if (valueTemplate != null) {
+            textField.setForeground(Color.BLUE);
+            support.addListener((source, key, newValue) -> {
+                if (source != this) {
+                    textField.setItem(valueTemplate.getText(support));
+                }
+            });
+        }
+    }
 }

trunk/src/org/openstreetmap/josm/tools/template_engine/TemplateEntry.java

@@ -10 +10 @@
  */
 public interface TemplateEntry {
+
+    /**
+     * Execute this template by generating text for a given data provider.
+     * @param dataProvider the data provider from which information should be compiled to a string
+     * @return the generated text
+     */
+    default String getText(TemplateEngineDataProvider dataProvider) {
+        StringBuilder sb = new StringBuilder();
+        appendText(sb, dataProvider);
+        return sb.toString();
+    }
+
     /**
      * Execute this template by generating text for a given data provider.