org.openstreetmap.josm.gui.mappaint.styleelement

Class LabelCompositionStrategy.DeriveLabelFromNameTagsCompositionStrategy

java.lang.Object

org.openstreetmap.josm.gui.mappaint.styleelement.LabelCompositionStrategy.DeriveLabelFromNameTagsCompositionStrategy

All Implemented Interfaces:

LabelCompositionStrategy, PreferenceChangedListener

Enclosing interface:

LabelCompositionStrategy

public static class LabelCompositionStrategy.DeriveLabelFromNameTagsCompositionStrategy
extends java.lang.Object
implements LabelCompositionStrategy, PreferenceChangedListener

Strategy where the label is given by the value of one of the configured "name tags". The list of relevant name tags can be configured in the JOSM preferences see the preference options mappaint.nameOrder and mappaint.nameComplementOrder

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.mappaint.styleelement.LabelCompositionStrategy

LabelCompositionStrategy.DeriveLabelFromNameTagsCompositionStrategy, LabelCompositionStrategy.StaticLabelCompositionStrategy, LabelCompositionStrategy.TagLookupCompositionStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	DEFAULT_NAME_COMPLEMENT_TAGS The list of default name complement tags from which a label candidate is derived.
private static java.lang.String[]	DEFAULT_NAME_TAGS The list of default name tags from which a label candidate is derived.
private java.util.List<java.lang.String>	nameComplementTags
private java.util.List<java.lang.String>	nameTags

Constructor Summary

Constructors

Constructor and Description
DeriveLabelFromNameTagsCompositionStrategy() Creates the strategy and initializes its name tags from the preferences.

Method Summary

Modifier and Type	Method and Description
private static java.util.List<java.lang.String>	buildNameTags(java.util.List<java.lang.String> nameTags)
java.lang.String	compose(IPrimitive primitive) Replies the text value to be rendered as label for the primitive primitive.
java.util.List<java.lang.String>	getNameComplementTags() Replies an unmodifiable list of the name complement tags used to compose the label.
java.util.List<java.lang.String>	getNameTags() Replies an unmodifiable list of the name tags used to compose the label.
private java.lang.String	getPrimitiveName(IPrimitive n)
void	initNameTagsFromPreferences() Initializes the name tags to use from a list of default name tags (see DEFAULT_NAME_TAGS and DEFAULT_NAME_COMPLEMENT_TAGS) and from name tags configured in the preferences using the keys mappaint.nameOrder and mappaint.nameComplementOrder.
void	preferenceChanged(PreferenceChangeEvent e) Triggered when a preference entry value changes.
void	setNameComplementTags(java.util.List<java.lang.String> nameComplementTags) Sets the name complement tags to be looked up in order to build up the label.
void	setNameTags(java.util.List<java.lang.String> nameTags) Sets the name tags to be looked up in order to build up the label.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME_TAGS

private static final java.lang.String[] DEFAULT_NAME_TAGS

The list of default name tags from which a label candidate is derived.

DEFAULT_NAME_COMPLEMENT_TAGS

private static final java.lang.String[] DEFAULT_NAME_COMPLEMENT_TAGS

The list of default name complement tags from which a label candidate is derived.

nameTags

private java.util.List<java.lang.String> nameTags

nameComplementTags

private java.util.List<java.lang.String> nameComplementTags

Constructor Detail

DeriveLabelFromNameTagsCompositionStrategy

public DeriveLabelFromNameTagsCompositionStrategy()

Creates the strategy and initializes its name tags from the preferences.

Method Detail

buildNameTags

private static java.util.List<java.lang.String> buildNameTags(java.util.List<java.lang.String> nameTags)

setNameTags

public void setNameTags(java.util.List<java.lang.String> nameTags)

Sets the name tags to be looked up in order to build up the label.

Parameters:

nameTags - the name tags. null values are ignored.

setNameComplementTags

public void setNameComplementTags(java.util.List<java.lang.String> nameComplementTags)

Sets the name complement tags to be looked up in order to build up the label.

Parameters:

nameComplementTags - the name complement tags. null values are ignored.

Since:

6541

getNameTags

public java.util.List<java.lang.String> getNameTags()

Replies an unmodifiable list of the name tags used to compose the label.

Returns:

the list of name tags

getNameComplementTags

public java.util.List<java.lang.String> getNameComplementTags()

Replies an unmodifiable list of the name complement tags used to compose the label.

Returns:

the list of name complement tags

Since:

6541

initNameTagsFromPreferences

public final void initNameTagsFromPreferences()

Initializes the name tags to use from a list of default name tags (see DEFAULT_NAME_TAGS and DEFAULT_NAME_COMPLEMENT_TAGS) and from name tags configured in the preferences using the keys mappaint.nameOrder and mappaint.nameComplementOrder.

getPrimitiveName

private java.lang.String getPrimitiveName(IPrimitive n)

compose

public java.lang.String compose(IPrimitive primitive)

Description copied from interface: LabelCompositionStrategy

Replies the text value to be rendered as label for the primitive primitive.

Specified by:

compose in interface LabelCompositionStrategy

Parameters:

primitive - the primitive

Returns:

the text value to be rendered or null, if primitive is null or if no suitable value could be composed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

preferenceChanged

public void preferenceChanged(PreferenceChangeEvent e)

Description copied from interface: PreferenceChangedListener

Triggered when a preference entry value changes.

Specified by:

preferenceChanged in interface PreferenceChangedListener

Parameters:

e - the preference change event