Module name
Package com.here.mom.component.name
Parts
Enums
Name
part Name
Module name
Subtypes RoadName
A component used by various named Map Object types.
Property | Type | Modifier | Description |
name | string | optional | Represents the name or description of a feature or object. |
shortName | string | optional | If a Base Name has more than 35 characters, add a second name (Short Name) byabbreviating the Base Name to a maximum of 35 characters |
languageCode | string | optional | Language Code indicates the language in which a string is provided and should be used. |
nameType | NameType | optional | Name Type identifies the type of name applied to a feature or object. |
transliterations | Transliteration | list | Transliteration Type is used to transliterate a non-Latin-1 name into a Latin-1 name. |
translations | Translation | list | Translation is the communication of text/name/description of a feature or an object from one language (thesource) to another language (the target).It describes the Translated Name and Language Code of a feature. |
isExonym | boolean | optional | Indicates that the language does not belong to one of the official languages in the country.Exonym is a name for a feature in another language(that is not the default language).Identifies if this is an Exonym. |
isPrimary | boolean | optional | Primary Name indicates that the base name referenced is the primary name of an entity.Indicates that the name is primary from a list of names. |
rmobExt | NameExt | optional | Deprecated. Deprecated since March 2021 in favor of publication-data |
publicationData | PublicationExtension | optional |
NameType
enum NameType
Module name
List of valid Name Types.
- Undefined: Name Type is not defined.
- Official: Official name is the name that is signposted or documented name of an entity.
- Synonym: Synonym is an alternative name for a feature in the same language as the Official name.
- Abbreviation: Abbreviation is a shortened representation as an alternative name for a feature in the same language as the Official name.
- Exonym: Exonym is a name for a feature in another language(that is not the default language).
- Unclassified: Unclassified is applied to a name whose representation does not fit in any of the Name Type definitions mentioned above.
- Fullname: Full Name is the complete name of an entity.
Value | Description |
UNDEFINED | |
OFFICIAL | |
SYNONYM | |
ABBREVIATION | |
EXONYM | |
UNCLASSIFIED | |
FULLNAME |
Text
part Text
Module name
A text (string) in a specific language. Use language code und
(undetermined) if the language is not explicitly language. This type can be used in contexts where the richer semantics of a name
are not required.
Property | Type | Modifier | Description |
value | string | | |
language | LanguageHere | |
Translation
part Translation
Module name
Translation is the communication of text/name/description of a feature or an object from one language (the source) to another language (the target).
Property | Type | Modifier | Description |
name | string | optional | Represents the translated name or description of a feature or object. |
languageCode | string | optional | Language Code indicates the language in which a string is provided and should be used. |
Transliteration
part Transliteration
Module name
Subtypes RoadNameTransliteration
Transliteration Type is used to transliterate a non-Latin-1 name into a Latin-1 name.
Property | Type | Modifier | Description |
name | string | optional | Represents the transliterated name or description of a feature or object. |
shortname | string | optional | Represents the transliterated short name or abbreviation of a feature or object. |
languageCode | string | optional | replaced oneOf/anyOf by commonType |
transliterationType | LanguageHere | optional | Transliteration Type indicates a generated Latin-1 representation of a word in a language that does not useLatin-1 characters. |