org.openstreetmap.josm.data.osm

Class DefaultNameFormatter

java.lang.Object

org.openstreetmap.josm.data.osm.DefaultNameFormatter

All Implemented Interfaces:

HistoryNameFormatter, NameFormatter

public class DefaultNameFormatter
extends java.lang.Object
implements NameFormatter, HistoryNameFormatter

This is the default implementation of a NameFormatter for names of IPrimitives and HistoryOsmPrimitives.

Since:

12663 (moved from gui package), 1990

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	DEFAULT_NAMING_TAGS_FOR_RELATIONS The default list of tags which are used as naming tags in relations.
private static java.util.List<NameFormatterHook>	formatHooks
private static DefaultNameFormatter	instance
private static java.util.List<java.lang.String>	namingTagsForRelations the current list of tags used as naming tags in relations
private java.util.Comparator<INode>	nodeComparator
private java.util.Comparator<IRelation<?>>	relationComparator
private java.util.Comparator<IWay<?>>	wayComparator

Constructor Summary

Constructors

Constructor and Description
DefaultNameFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildDefaultToolTip(HistoryOsmPrimitive primitive) Builds a default tooltip text for an HistoryOsmPrimitive primitive.
java.lang.String	buildDefaultToolTip(IPrimitive primitive) Builds a default tooltip text for the primitive primitive.
private static java.lang.String	buildDefaultToolTip(long id, java.util.Map<java.lang.String,java.lang.String> tags)
protected void	decorateNameWithId(java.lang.StringBuilder name, HistoryOsmPrimitive primitive) Decorates the name of primitive with its id, if the preference osm-primitives.showid is set.
protected void	decorateNameWithId(java.lang.StringBuilder name, IPrimitive primitive) Decorates the name of primitive with its id and version, if the preferences osm-primitives.showid and osm-primitives.showversion are set.
java.lang.String	format(Changeset changeset) Formats a name for a Changeset.
java.lang.String	format(HistoryNode node) Formats a name for a HistoryNode.
java.lang.String	format(HistoryRelation relation) Formats a name for a HistoryRelation.
java.lang.String	format(HistoryWay way) Formats a name for a HistoryWay.
java.lang.String	format(INode node) Formats a name for a INode.
java.lang.String	format(IPrimitive osm) Formats a name for an IPrimitive.
java.lang.String	format(IRelation<?> relation) Formats a name for a IRelation.
java.lang.String	format(IWay<?> way) Formats a name for a IWay.
java.lang.String	formatAsHtmlUnorderedList(java.util.Collection<? extends OsmPrimitive> primitives, int maxElements) Formats the given collection of primitives as an HTML unordered list.
java.lang.String	formatAsHtmlUnorderedList(OsmPrimitive primitive) Formats the given primitive as an HTML unordered list.
private static java.lang.StringBuilder	formatRelationNameAndType(IRelation<?> relation, java.lang.StringBuilder result, TaggingPreset preset)
static DefaultNameFormatter	getInstance() Replies the unique instance of this formatter
private static java.lang.String	getNameTagValue(IRelation<?> relation, java.lang.String nameTag)
static java.util.List<java.lang.String>	getNamingtagsForRelations() Replies the list of naming tags used in relations.
java.util.Comparator<INode>	getNodeComparator() Gets a comparator that sorts the nodes by the string that this formatter would create for them
java.util.Comparator<IRelation<?>>	getRelationComparator() Gets a comparator that sorts the relations by the string that this formatter would create for them
private static java.lang.String	getRelationName(IRelation<?> relation)
private static java.lang.String	getRelationTypeName(IRelation<?> relation)
java.util.Comparator<IWay<?>>	getWayComparator() Gets a comparator that sorts the ways by the string that this formatter would create for them
static void	registerFormatHook(NameFormatterHook hook) Registers a format hook.
static void	unregisterFormatHook(NameFormatterHook hook) Unregisters a format hook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

private static DefaultNameFormatter instance

formatHooks

private static final java.util.List<NameFormatterHook> formatHooks

DEFAULT_NAMING_TAGS_FOR_RELATIONS

private static final java.lang.String[] DEFAULT_NAMING_TAGS_FOR_RELATIONS

The default list of tags which are used as naming tags in relations. A ? prefix indicates a boolean value, for which the key (instead of the value) is used.

namingTagsForRelations

private static java.util.List<java.lang.String> namingTagsForRelations

the current list of tags used as naming tags in relations

nodeComparator

private final java.util.Comparator<INode> nodeComparator

wayComparator

private final java.util.Comparator<IWay<?>> wayComparator

relationComparator

private final java.util.Comparator<IRelation<?>> relationComparator

Constructor Detail

DefaultNameFormatter

public DefaultNameFormatter()

Method Detail

getInstance

public static DefaultNameFormatter getInstance()

Replies the unique instance of this formatter

Returns:

the unique instance of this formatter

registerFormatHook

public static void registerFormatHook(NameFormatterHook hook)

Registers a format hook. Adds the hook at the first position of the format hooks. (for plugins)

Parameters:

hook - the format hook. Ignored if null.

unregisterFormatHook

public static void unregisterFormatHook(NameFormatterHook hook)

Unregisters a format hook. Removes the hook from the list of format hooks.

Parameters:

hook - the format hook. Ignored if null.

getNamingtagsForRelations

public static java.util.List<java.lang.String> getNamingtagsForRelations()

Replies the list of naming tags used in relations. The list is given (in this order) by:

• by the tag names in the preference relation.nameOrder
• by the default tags in DEFAULT_NAMING_TAGS_FOR_RELATIONS

Returns:

the list of naming tags used in relations

decorateNameWithId

protected void decorateNameWithId(java.lang.StringBuilder name,
                                  IPrimitive primitive)

Decorates the name of primitive with its id and version, if the preferences osm-primitives.showid and osm-primitives.showversion are set. Shows unique id if osm-primitives.showid.new-primitives is set

Parameters:

name - the name without the id

primitive - the primitive

format

public java.lang.String format(IPrimitive osm)

Formats a name for an IPrimitive.

Parameters:

osm - the primitive

Returns:

the name

Since:

10991, 13564 (signature)

format

public java.lang.String format(INode node)

Description copied from interface: NameFormatter

Formats a name for a INode.

Specified by:

format in interface NameFormatter

Parameters:

node - the node

Returns:

the name

getNodeComparator

public java.util.Comparator<INode> getNodeComparator()

Description copied from interface: NameFormatter

Gets a comparator that sorts the nodes by the string that this formatter would create for them

Specified by:

getNodeComparator in interface NameFormatter

Returns:

That comparator

format

public java.lang.String format(IWay<?> way)

Description copied from interface: NameFormatter

Formats a name for a IWay.

Specified by:

format in interface NameFormatter

Parameters:

way - the way

Returns:

the name

getWayComparator

public java.util.Comparator<IWay<?>> getWayComparator()

Description copied from interface: NameFormatter

Gets a comparator that sorts the ways by the string that this formatter would create for them

Specified by:

getWayComparator in interface NameFormatter

Returns:

That comparator

format

public java.lang.String format(IRelation<?> relation)

Description copied from interface: NameFormatter

Formats a name for a IRelation.

Specified by:

format in interface NameFormatter

Parameters:

relation - the relation

Returns:

the name

formatRelationNameAndType

private static java.lang.StringBuilder formatRelationNameAndType(IRelation<?> relation,
                                                                 java.lang.StringBuilder result,
                                                                 TaggingPreset preset)

getRelationComparator

public java.util.Comparator<IRelation<?>> getRelationComparator()

Description copied from interface: NameFormatter

Gets a comparator that sorts the relations by the string that this formatter would create for them

Specified by:

getRelationComparator in interface NameFormatter

Returns:

That comparator

getRelationTypeName

private static java.lang.String getRelationTypeName(IRelation<?> relation)

getNameTagValue

private static java.lang.String getNameTagValue(IRelation<?> relation,
                                                java.lang.String nameTag)

getRelationName

private static java.lang.String getRelationName(IRelation<?> relation)

format

public java.lang.String format(Changeset changeset)

Description copied from interface: NameFormatter

Formats a name for a Changeset.

Specified by:

format in interface NameFormatter

Parameters:

changeset - the changeset

Returns:

the name

buildDefaultToolTip

public java.lang.String buildDefaultToolTip(IPrimitive primitive)

Builds a default tooltip text for the primitive primitive.

Parameters:

primitive - the primitmive

Returns:

the tooltip text

buildDefaultToolTip

private static java.lang.String buildDefaultToolTip(long id,
                                                    java.util.Map<java.lang.String,java.lang.String> tags)

decorateNameWithId

protected void decorateNameWithId(java.lang.StringBuilder name,
                                  HistoryOsmPrimitive primitive)

Decorates the name of primitive with its id, if the preference osm-primitives.showid is set. The id is append to the StringBuilder passed in name.

Parameters:

name - the name without the id

primitive - the primitive

format

public java.lang.String format(HistoryNode node)

Description copied from interface: HistoryNameFormatter

Formats a name for a HistoryNode.

Specified by:

format in interface HistoryNameFormatter

Parameters:

node - the node

Returns:

the name

format

public java.lang.String format(HistoryWay way)

Description copied from interface: HistoryNameFormatter

Formats a name for a HistoryWay.

Specified by:

format in interface HistoryNameFormatter

Parameters:

way - the way

Returns:

the name

format

public java.lang.String format(HistoryRelation relation)

Description copied from interface: HistoryNameFormatter

Formats a name for a HistoryRelation.

Specified by:

format in interface HistoryNameFormatter

Parameters:

relation - the relation

Returns:

the name

buildDefaultToolTip

public java.lang.String buildDefaultToolTip(HistoryOsmPrimitive primitive)

Builds a default tooltip text for an HistoryOsmPrimitive primitive.

Parameters:

primitive - the primitmive

Returns:

the tooltip text

formatAsHtmlUnorderedList

public java.lang.String formatAsHtmlUnorderedList(java.util.Collection<? extends OsmPrimitive> primitives,
                                                  int maxElements)

Formats the given collection of primitives as an HTML unordered list.

Parameters:

primitives - collection of primitives to format

maxElements - the maximum number of elements to display

Returns:

HTML unordered list

formatAsHtmlUnorderedList

public java.lang.String formatAsHtmlUnorderedList(OsmPrimitive primitive)

Formats the given primitive as an HTML unordered list.

Parameters:

primitive - primitive to format

Returns:

HTML unordered list