source: josm/trunk/src/org/openstreetmap/josm/data/osm/DefaultNameFormatter.java @ 14306

Last change on this file since 14306 was 14306, checked in by Don-vip, 2 months ago

fix #16816 - new option to show object version in lists, similar to object ID

  • Property svn:eol-style set to native
File size: 24.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.data.osm;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trc;
6import static org.openstreetmap.josm.tools.I18n.trcLazy;
7import static org.openstreetmap.josm.tools.I18n.trn;
8
9import java.awt.ComponentOrientation;
10import java.util.ArrayList;
11import java.util.Arrays;
12import java.util.Collection;
13import java.util.Collections;
14import java.util.Comparator;
15import java.util.HashSet;
16import java.util.LinkedList;
17import java.util.List;
18import java.util.Locale;
19import java.util.Map;
20import java.util.Set;
21import java.util.stream.Collectors;
22
23import org.openstreetmap.josm.data.coor.LatLon;
24import org.openstreetmap.josm.data.coor.conversion.CoordinateFormatManager;
25import org.openstreetmap.josm.data.osm.history.HistoryNameFormatter;
26import org.openstreetmap.josm.data.osm.history.HistoryNode;
27import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
28import org.openstreetmap.josm.data.osm.history.HistoryRelation;
29import org.openstreetmap.josm.data.osm.history.HistoryWay;
30import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
31import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetNameTemplateList;
32import org.openstreetmap.josm.spi.preferences.Config;
33import org.openstreetmap.josm.tools.AlphanumComparator;
34import org.openstreetmap.josm.tools.I18n;
35import org.openstreetmap.josm.tools.Utils;
36import org.openstreetmap.josm.tools.template_engine.TemplateEngineDataProvider;
37
38/**
39 * This is the default implementation of a {@link NameFormatter} for names of {@link IPrimitive}s
40 * and {@link HistoryOsmPrimitive}s.
41 * @since 12663 (moved from {@code gui} package)
42 * @since 1990
43 */
44public class DefaultNameFormatter implements NameFormatter, HistoryNameFormatter {
45
46    private static DefaultNameFormatter instance;
47
48    private static final List<NameFormatterHook> formatHooks = new LinkedList<>();
49
50    /**
51     * Replies the unique instance of this formatter
52     *
53     * @return the unique instance of this formatter
54     */
55    public static synchronized DefaultNameFormatter getInstance() {
56        if (instance == null) {
57            instance = new DefaultNameFormatter();
58        }
59        return instance;
60    }
61
62    /**
63     * Registers a format hook. Adds the hook at the first position of the format hooks.
64     * (for plugins)
65     *
66     * @param hook the format hook. Ignored if null.
67     */
68    public static void registerFormatHook(NameFormatterHook hook) {
69        if (hook == null) return;
70        if (!formatHooks.contains(hook)) {
71            formatHooks.add(0, hook);
72        }
73    }
74
75    /**
76     * Unregisters a format hook. Removes the hook from the list of format hooks.
77     *
78     * @param hook the format hook. Ignored if null.
79     */
80    public static void unregisterFormatHook(NameFormatterHook hook) {
81        if (hook == null) return;
82        if (formatHooks.contains(hook)) {
83            formatHooks.remove(hook);
84        }
85    }
86
87    /** The default list of tags which are used as naming tags in relations.
88     * A ? prefix indicates a boolean value, for which the key (instead of the value) is used.
89     */
90    private static final String[] DEFAULT_NAMING_TAGS_FOR_RELATIONS = {"name", "ref", "restriction", "landuse", "natural",
91        "leisure", "amenity", "public_transport", ":LocationCode", "note", "?building"};
92
93    /** the current list of tags used as naming tags in relations */
94    private static List<String> namingTagsForRelations;
95
96    /**
97     * Replies the list of naming tags used in relations. The list is given (in this order) by:
98     * <ul>
99     *   <li>by the tag names in the preference <code>relation.nameOrder</code></li>
100     *   <li>by the default tags in {@link #DEFAULT_NAMING_TAGS_FOR_RELATIONS}
101     * </ul>
102     *
103     * @return the list of naming tags used in relations
104     */
105    public static synchronized List<String> getNamingtagsForRelations() {
106        if (namingTagsForRelations == null) {
107            namingTagsForRelations = new ArrayList<>(
108                    Config.getPref().getList("relation.nameOrder", Arrays.asList(DEFAULT_NAMING_TAGS_FOR_RELATIONS))
109                    );
110        }
111        return namingTagsForRelations;
112    }
113
114    /**
115     * Decorates the name of primitive with its id and version, if the preferences
116     * <code>osm-primitives.showid</code> and <code>osm-primitives.showversion</code> are set.
117     * Shows unique id if <code>osm-primitives.showid.new-primitives</code> is set
118     *
119     * @param name the name without the id
120     * @param primitive the primitive
121     */
122    protected void decorateNameWithId(StringBuilder name, IPrimitive primitive) {
123        if (Config.getPref().getBoolean("osm-primitives.showid")) {
124            long id = Config.getPref().getBoolean("osm-primitives.showid.new-primitives") ?
125                    primitive.getUniqueId() : primitive.getId();
126            if (Config.getPref().getBoolean("osm-primitives.showversion")) {
127                name.append(tr(" [id: {0}, v{1}]", id, primitive.getVersion()));
128            } else {
129                name.append(tr(" [id: {0}]", id));
130            }
131        } else if (Config.getPref().getBoolean("osm-primitives.showversion")) {
132            name.append(tr(" [v{0}]", primitive.getVersion()));
133        }
134    }
135
136    /**
137     * Formats a name for an {@link IPrimitive}.
138     *
139     * @param osm the primitive
140     * @return the name
141     * @since 10991
142     * @since 13564 (signature)
143     */
144    public String format(IPrimitive osm) {
145        if (osm instanceof INode) {
146            return format((INode) osm);
147        } else if (osm instanceof IWay) {
148            return format((IWay<?>) osm);
149        } else if (osm instanceof IRelation) {
150            return format((IRelation<?>) osm);
151        }
152        return null;
153    }
154
155    @Override
156    public String format(INode node) {
157        StringBuilder name = new StringBuilder();
158        if (node.isIncomplete()) {
159            name.append(tr("incomplete"));
160        } else {
161            TaggingPreset preset = TaggingPresetNameTemplateList.getInstance().findPresetTemplate(node);
162            if (preset == null || !(node instanceof TemplateEngineDataProvider)) {
163                String n;
164                if (Config.getPref().getBoolean("osm-primitives.localize-name", true)) {
165                    n = node.getLocalName();
166                } else {
167                    n = node.getName();
168                }
169                if (n == null) {
170                    String s = node.get("addr:housename");
171                    if (s != null) {
172                        /* I18n: name of house as parameter */
173                        n = tr("House {0}", s);
174                    }
175                    if (n == null && (s = node.get("addr:housenumber")) != null) {
176                        String t = node.get("addr:street");
177                        if (t != null) {
178                            /* I18n: house number, street as parameter, number should remain
179                        before street for better visibility */
180                            n = tr("House number {0} at {1}", s, t);
181                        } else {
182                            /* I18n: house number as parameter */
183                            n = tr("House number {0}", s);
184                        }
185                    }
186                }
187
188                if (n == null) {
189                    n = node.isNew() ? tr("node") : Long.toString(node.getId());
190                }
191                name.append(n);
192            } else {
193                preset.nameTemplate.appendText(name, (TemplateEngineDataProvider) node);
194            }
195            if (node.isLatLonKnown() && Config.getPref().getBoolean("osm-primitives.showcoor")) {
196                name.append(" \u200E(")
197                    .append(CoordinateFormatManager.getDefaultFormat().latToString(node)).append(", ")
198                    .append(CoordinateFormatManager.getDefaultFormat().lonToString(node)).append(')');
199            }
200        }
201        decorateNameWithId(name, node);
202
203        String result = name.toString();
204        for (NameFormatterHook hook: formatHooks) {
205            String hookResult = hook.checkFormat(node, result);
206            if (hookResult != null)
207                return hookResult;
208        }
209
210        return result;
211    }
212
213    private final Comparator<INode> nodeComparator = (n1, n2) -> format(n1).compareTo(format(n2));
214
215    @Override
216    public Comparator<INode> getNodeComparator() {
217        return nodeComparator;
218    }
219
220    @Override
221    public String format(IWay<?> way) {
222        StringBuilder name = new StringBuilder();
223
224        char mark;
225        // If current language is left-to-right (almost all languages)
226        if (ComponentOrientation.getOrientation(Locale.getDefault()).isLeftToRight()) {
227            // will insert Left-To-Right Mark to ensure proper display of text in the case when object name is right-to-left
228            mark = '\u200E';
229        } else {
230            // otherwise will insert Right-To-Left Mark to ensure proper display in the opposite case
231            mark = '\u200F';
232        }
233        // Initialize base direction of the string
234        name.append(mark);
235
236        if (way.isIncomplete()) {
237            name.append(tr("incomplete"));
238        } else {
239            TaggingPreset preset = TaggingPresetNameTemplateList.getInstance().findPresetTemplate(way);
240            if (preset == null || !(way instanceof TemplateEngineDataProvider)) {
241                String n;
242                if (Config.getPref().getBoolean("osm-primitives.localize-name", true)) {
243                    n = way.getLocalName();
244                } else {
245                    n = way.getName();
246                }
247                if (n == null) {
248                    n = way.get("ref");
249                }
250                if (n == null) {
251                    n = way.hasKey("highway") ? tr("highway") :
252                        way.hasKey("railway") ? tr("railway") :
253                        way.hasKey("waterway") ? tr("waterway") :
254                        way.hasKey("landuse") ? tr("landuse") : null;
255                }
256                if (n == null) {
257                    String s = way.get("addr:housename");
258                    if (s != null) {
259                        /* I18n: name of house as parameter */
260                        n = tr("House {0}", s);
261                    }
262                    if (n == null && (s = way.get("addr:housenumber")) != null) {
263                        String t = way.get("addr:street");
264                        if (t != null) {
265                            /* I18n: house number, street as parameter, number should remain
266                        before street for better visibility */
267                            n = tr("House number {0} at {1}", s, t);
268                        } else {
269                            /* I18n: house number as parameter */
270                            n = tr("House number {0}", s);
271                        }
272                    }
273                }
274                if (n == null && way.hasKey("building")) {
275                    n = tr("building");
276                }
277                if (n == null || n.isEmpty()) {
278                    n = String.valueOf(way.getId());
279                }
280
281                name.append(n);
282            } else {
283                preset.nameTemplate.appendText(name, (TemplateEngineDataProvider) way);
284            }
285
286            int nodesNo = way.getRealNodesCount();
287            /* note: length == 0 should no longer happen, but leave the bracket code
288               nevertheless, who knows what future brings */
289            /* I18n: count of nodes as parameter */
290            String nodes = trn("{0} node", "{0} nodes", nodesNo, nodesNo);
291            name.append(mark).append(" (").append(nodes).append(')');
292        }
293        decorateNameWithId(name, way);
294
295        String result = name.toString();
296        for (NameFormatterHook hook: formatHooks) {
297            String hookResult = hook.checkFormat(way, result);
298            if (hookResult != null)
299                return hookResult;
300        }
301
302        return result;
303    }
304
305    private final Comparator<IWay<?>> wayComparator = (w1, w2) -> format(w1).compareTo(format(w2));
306
307    @Override
308    public Comparator<IWay<?>> getWayComparator() {
309        return wayComparator;
310    }
311
312    @Override
313    public String format(IRelation<?> relation) {
314        StringBuilder name = new StringBuilder();
315        if (relation.isIncomplete()) {
316            name.append(tr("incomplete"));
317        } else {
318            TaggingPreset preset = TaggingPresetNameTemplateList.getInstance().findPresetTemplate(relation);
319
320            formatRelationNameAndType(relation, name, preset);
321
322            int mbno = relation.getMembersCount();
323            name.append(trn("{0} member", "{0} members", mbno, mbno));
324
325            if (relation.hasIncompleteMembers()) {
326                name.append(", ").append(tr("incomplete"));
327            }
328
329            name.append(')');
330        }
331        decorateNameWithId(name, relation);
332
333        String result = name.toString();
334        for (NameFormatterHook hook: formatHooks) {
335            String hookResult = hook.checkFormat(relation, result);
336            if (hookResult != null)
337                return hookResult;
338        }
339
340        return result;
341    }
342
343    private static StringBuilder formatRelationNameAndType(IRelation<?> relation, StringBuilder result, TaggingPreset preset) {
344        if (preset == null || !(relation instanceof TemplateEngineDataProvider)) {
345            result.append(getRelationTypeName(relation));
346            String relationName = getRelationName(relation);
347            if (relationName == null) {
348                relationName = Long.toString(relation.getId());
349            } else {
350                relationName = '\"' + relationName + '\"';
351            }
352            result.append(" (").append(relationName).append(", ");
353        } else {
354            preset.nameTemplate.appendText(result, (TemplateEngineDataProvider) relation);
355            result.append('(');
356        }
357        return result;
358    }
359
360    private final Comparator<IRelation<?>> relationComparator = (r1, r2) -> {
361        //TODO This doesn't work correctly with formatHooks
362
363        TaggingPreset preset1 = TaggingPresetNameTemplateList.getInstance().findPresetTemplate(r1);
364        TaggingPreset preset2 = TaggingPresetNameTemplateList.getInstance().findPresetTemplate(r2);
365
366        if (preset1 != null || preset2 != null) {
367            String name11 = formatRelationNameAndType(r1, new StringBuilder(), preset1).toString();
368            String name21 = formatRelationNameAndType(r2, new StringBuilder(), preset2).toString();
369
370            int comp1 = AlphanumComparator.getInstance().compare(name11, name21);
371            if (comp1 != 0)
372                return comp1;
373        } else {
374
375            String type1 = getRelationTypeName(r1);
376            String type2 = getRelationTypeName(r2);
377
378            int comp2 = AlphanumComparator.getInstance().compare(type1, type2);
379            if (comp2 != 0)
380                return comp2;
381
382            String name12 = getRelationName(r1);
383            String name22 = getRelationName(r2);
384
385            comp2 = AlphanumComparator.getInstance().compare(name12, name22);
386            if (comp2 != 0)
387                return comp2;
388        }
389
390        int comp3 = Integer.compare(r1.getMembersCount(), r2.getMembersCount());
391        if (comp3 != 0)
392            return comp3;
393
394
395        comp3 = Boolean.compare(r1.hasIncompleteMembers(), r2.hasIncompleteMembers());
396        if (comp3 != 0)
397            return comp3;
398
399        return Long.compare(r1.getUniqueId(), r2.getUniqueId());
400    };
401
402    @Override
403    public Comparator<IRelation<?>> getRelationComparator() {
404        return relationComparator;
405    }
406
407    private static String getRelationTypeName(IRelation<?> relation) {
408        String name = trc("Relation type", relation.get("type"));
409        if (name == null) {
410            name = relation.hasKey("public_transport") ? tr("public transport") : null;
411        }
412        if (name == null) {
413            String building = relation.get("building");
414            if (OsmUtils.isTrue(building)) {
415                name = tr("building");
416            } else if (building != null) {
417                name = tr(building); // translate tag!
418            }
419        }
420        if (name == null) {
421            name = trc("Place type", relation.get("place"));
422        }
423        if (name == null) {
424            name = tr("relation");
425        }
426        String adminLevel = relation.get("admin_level");
427        if (adminLevel != null) {
428            name += '['+adminLevel+']';
429        }
430
431        for (NameFormatterHook hook: formatHooks) {
432            String hookResult = hook.checkRelationTypeName(relation, name);
433            if (hookResult != null)
434                return hookResult;
435        }
436
437        return name;
438    }
439
440    private static String getNameTagValue(IRelation<?> relation, String nameTag) {
441        if ("name".equals(nameTag)) {
442            if (Config.getPref().getBoolean("osm-primitives.localize-name", true))
443                return relation.getLocalName();
444            else
445                return relation.getName();
446        } else if (":LocationCode".equals(nameTag)) {
447            for (String m : relation.keySet()) {
448                if (m.endsWith(nameTag))
449                    return relation.get(m);
450            }
451            return null;
452        } else if (nameTag.startsWith("?") && OsmUtils.isTrue(relation.get(nameTag.substring(1)))) {
453            return tr(nameTag.substring(1));
454        } else if (nameTag.startsWith("?") && OsmUtils.isFalse(relation.get(nameTag.substring(1)))) {
455            return null;
456        } else if (nameTag.startsWith("?")) {
457            return trcLazy(nameTag, I18n.escape(relation.get(nameTag.substring(1))));
458        } else {
459            return trcLazy(nameTag, I18n.escape(relation.get(nameTag)));
460        }
461    }
462
463    private static String getRelationName(IRelation<?> relation) {
464        String nameTag;
465        for (String n : getNamingtagsForRelations()) {
466            nameTag = getNameTagValue(relation, n);
467            if (nameTag != null)
468                return nameTag;
469        }
470        return null;
471    }
472
473    @Override
474    public String format(Changeset changeset) {
475        return tr("Changeset {0}", changeset.getId());
476    }
477
478    /**
479     * Builds a default tooltip text for the primitive <code>primitive</code>.
480     *
481     * @param primitive the primitmive
482     * @return the tooltip text
483     */
484    public String buildDefaultToolTip(IPrimitive primitive) {
485        return buildDefaultToolTip(primitive.getId(), primitive.getKeys());
486    }
487
488    private static String buildDefaultToolTip(long id, Map<String, String> tags) {
489        StringBuilder sb = new StringBuilder(128);
490        sb.append("<html><strong>id</strong>=")
491          .append(id)
492          .append("<br>");
493        List<String> keyList = new ArrayList<>(tags.keySet());
494        Collections.sort(keyList);
495        for (int i = 0; i < keyList.size(); i++) {
496            if (i > 0) {
497                sb.append("<br>");
498            }
499            String key = keyList.get(i);
500            sb.append("<strong>")
501              .append(Utils.escapeReservedCharactersHTML(key))
502              .append("</strong>=");
503            String value = tags.get(key);
504            while (!value.isEmpty()) {
505                sb.append(Utils.escapeReservedCharactersHTML(value.substring(0, Math.min(50, value.length()))));
506                if (value.length() > 50) {
507                    sb.append("<br>");
508                    value = value.substring(50);
509                } else {
510                    value = "";
511                }
512            }
513        }
514        sb.append("</html>");
515        return sb.toString();
516    }
517
518    /**
519     * Decorates the name of primitive with its id, if the preference
520     * <code>osm-primitives.showid</code> is set.
521     *
522     * The id is append to the {@link StringBuilder} passed in <code>name</code>.
523     *
524     * @param name  the name without the id
525     * @param primitive the primitive
526     */
527    protected void decorateNameWithId(StringBuilder name, HistoryOsmPrimitive primitive) {
528        if (Config.getPref().getBoolean("osm-primitives.showid")) {
529            name.append(tr(" [id: {0}]", primitive.getId()));
530        }
531    }
532
533    @Override
534    public String format(HistoryNode node) {
535        StringBuilder sb = new StringBuilder();
536        String name;
537        if (Config.getPref().getBoolean("osm-primitives.localize-name", true)) {
538            name = node.getLocalName();
539        } else {
540            name = node.getName();
541        }
542        if (name == null) {
543            sb.append(node.getId());
544        } else {
545            sb.append(name);
546        }
547        LatLon coord = node.getCoords();
548        if (coord != null) {
549            sb.append(" (")
550            .append(CoordinateFormatManager.getDefaultFormat().latToString(coord))
551            .append(", ")
552            .append(CoordinateFormatManager.getDefaultFormat().lonToString(coord))
553            .append(')');
554        }
555        decorateNameWithId(sb, node);
556        return sb.toString();
557    }
558
559    @Override
560    public String format(HistoryWay way) {
561        StringBuilder sb = new StringBuilder();
562        String name;
563        if (Config.getPref().getBoolean("osm-primitives.localize-name", true)) {
564            name = way.getLocalName();
565        } else {
566            name = way.getName();
567        }
568        if (name != null) {
569            sb.append(name);
570        }
571        if (sb.length() == 0 && way.get("ref") != null) {
572            sb.append(way.get("ref"));
573        }
574        if (sb.length() == 0) {
575            sb.append(
576                    way.hasKey("highway") ? tr("highway") :
577                    way.hasKey("railway") ? tr("railway") :
578                    way.hasKey("waterway") ? tr("waterway") :
579                    way.hasKey("landuse") ? tr("landuse") : ""
580                    );
581        }
582
583        int nodesNo = way.isClosed() ? (way.getNumNodes() -1) : way.getNumNodes();
584        String nodes = trn("{0} node", "{0} nodes", nodesNo, nodesNo);
585        if (sb.length() == 0) {
586            sb.append(way.getId());
587        }
588        /* note: length == 0 should no longer happen, but leave the bracket code
589           nevertheless, who knows what future brings */
590        sb.append((sb.length() > 0) ? (" ("+nodes+')') : nodes);
591        decorateNameWithId(sb, way);
592        return sb.toString();
593    }
594
595    @Override
596    public String format(HistoryRelation relation) {
597        StringBuilder sb = new StringBuilder();
598        String type = relation.get("type");
599        if (type != null) {
600            sb.append(type);
601        } else {
602            sb.append(tr("relation"));
603        }
604        sb.append(" (");
605        String nameTag = null;
606        Set<String> namingTags = new HashSet<>(getNamingtagsForRelations());
607        for (String n : relation.getTags().keySet()) {
608            // #3328: "note " and " note" are name tags too
609            if (namingTags.contains(n.trim())) {
610                if (Config.getPref().getBoolean("osm-primitives.localize-name", true)) {
611                    nameTag = relation.getLocalName();
612                } else {
613                    nameTag = relation.getName();
614                }
615                if (nameTag == null) {
616                    nameTag = relation.get(n);
617                }
618            }
619            if (nameTag != null) {
620                break;
621            }
622        }
623        if (nameTag == null) {
624            sb.append(Long.toString(relation.getId())).append(", ");
625        } else {
626            sb.append('\"').append(nameTag).append("\", ");
627        }
628
629        int mbno = relation.getNumMembers();
630        sb.append(trn("{0} member", "{0} members", mbno, mbno)).append(')');
631
632        decorateNameWithId(sb, relation);
633        return sb.toString();
634    }
635
636    /**
637     * Builds a default tooltip text for an HistoryOsmPrimitive <code>primitive</code>.
638     *
639     * @param primitive the primitmive
640     * @return the tooltip text
641     */
642    public String buildDefaultToolTip(HistoryOsmPrimitive primitive) {
643        return buildDefaultToolTip(primitive.getId(), primitive.getTags());
644    }
645
646    /**
647     * Formats the given collection of primitives as an HTML unordered list.
648     * @param primitives collection of primitives to format
649     * @param maxElements the maximum number of elements to display
650     * @return HTML unordered list
651     */
652    public String formatAsHtmlUnorderedList(Collection<? extends OsmPrimitive> primitives, int maxElements) {
653        Collection<String> displayNames = primitives.stream().map(x -> x.getDisplayName(this)).collect(Collectors.toList());
654        return Utils.joinAsHtmlUnorderedList(Utils.limit(displayNames, maxElements, "..."));
655    }
656
657    /**
658     * Formats the given primitive as an HTML unordered list.
659     * @param primitive primitive to format
660     * @return HTML unordered list
661     */
662    public String formatAsHtmlUnorderedList(OsmPrimitive primitive) {
663        return formatAsHtmlUnorderedList(Collections.singletonList(primitive), 1);
664    }
665}
Note: See TracBrowser for help on using the repository browser.