Module address

Package com.here.mom.feature.address

Features

Parts

Enums

Address

feature Address extends MomFeature

Module address

Definition of a Generic Address in Map Objects schema. Addresses are numeric or alphanumeric ranges of house numbers that are associated with a link.

Property Type Modifier Description
momType "Address"
id string
bbox BoundingBox optional
geometry Geometry Represents Geometry types.

Example: Point, LineString, Polygon, MultiPoint, etc.
properties AddressProperties Represents the Address Properties i.e., Micro Point Address and Point Address.
referencePoint Point optional This is the location of this feature, collapsed to a single point.

This is for any application where an approximate, but deterministic and consistent, location is useful. One

example is deciding where to "anchor" a feature within a tiled map database.

Any Reference to this feature should include this point.
nonSpatialPartitionKey string optional The partition id for a generically partitioned feature.

Generically partitioned features fall into two categories:

1. Features that have a spatial component but may not make sense to partition based on that geometry.

2. Features that don't have a strong spatial component.

How keys will be assigned and what value ranges will be used are not specified.

Examples of generically partitioned features are admin, zone, postal, phonetics, metadata, etc.
Constraint Expression Description
atMostOneDefinedProperty (is-empty(.referencePoint) is-empty(.nonSpatialPartitionKey)) At most one of non-spatial-partition-key and reference-point can be defined.

AddressProperties

abstract part AddressProperties extends Common

Module address

Subtypes MicroPa, PointAddress

Base class for all address property classes.

Property Type Modifier Description
@ns:com:here:mom:meta Metadata optional
@ns:com:here:mom:rmob string optional Currently not specified - may be specified by each Feature individually in future
featureType FeatureType optional Deprecated. This property is redundant to MomFeature.momType and should not be used.

MOM clients before 2.6 release had this deprecated property set to required, so

if data needs to be JSON schema validated by clients before 2.6 this property must be

set by the writer.
isoCountryCode Country optional Deprecated. This indicates which country a Feature is in, with a couple caveats.

- It may be unknown ("NONE" is a valid value, in addition to "UNDEFINED" like all MOM enums) simply because the

writer has not tried to figure it out or has otherwise not had the means to do so.

- It may be outright incorrect or a simplification of reality, specifically when a Feature is close to a country

border or in a disputed area (e.g., two or more countries claim the same area).

In all cases, writers and readers of this data should understand that the semantics of this property must be

agreed upon (if it is used at all). The preferred method of relating a Feature to a Country is through a

(direct or transitive) Reference from the Feature to an Admin.
@ns:com:here:mom:delta Branch optional
@ns:com:here:mom:mapcreator MapCreator optional
@ns:com:here:xyz Xyz optional Generic Data Hub namespace
extensionOSM MomOsm optional Optional extension for OSM (Open Street Map) metadata,

in case the object came from OSM
@ns:com:here:groundTruth GroundTruth optional Ground truth namespace
confidence ConfidenceData optional Confidence of a feature, optional only for the features

that are not participating in Quality Index.
publicationData PublicationExtension optional For HERE classic products (e.g. RDF) this is the point address PVID (aka road-point PVID).
sourceType SourceType optional Source Type indicates how the Point Address has been generated or the level in which it has been manipulated.

Example: Estimated, External Update/Estimated Creation, External Update and Creation, etc.

Category

enum Category

Module address

Discriminants for AddressProperties > category

Value Description
MICRO_PA
POINT_ADDRESS

DisplayPointType

enum DisplayPointType

Module address

Display Point Types.

Value Description
UNDEFINED
BLD_CENTROID
PARCEL_CENTROID
AREA_CENTROID
FRONT_DOOR
INHERITED
UNKNOWN
INDOOR_SPACE_CENTROID

LocationDetail

part LocationDetail

Module address

Location Details describes the name and type of location.

Property Type Modifier Description
names Name list Represents the name or description of a location.
locationType LocationType Location Type indicates the type of object a location represents with respect mainly to its form.

Example: Building, Apartment, Office, Lobby, Floor, etc.
customLocationType string optional In case the location-type does not provide a sufficient key for location types (location-type is set as

custom-type),

this optional string enables to define custom keys

LocationType

enum LocationType

Module address

Location Type Attributes.

Value Description
UNDEFINED
BUILDING
UNIT
LEVEL
SUITE
ROOM
UNKNOWN
APARTMENT
BASEMENT
DEPARTMENT
FRONT
LOBBY
UPPER
LOWER
OFFICE
REAR
SIDE
STOP
FLOOR
SPACE
PENTHOUSE
HANGER
TRAILER
PIER
LOT
SLIP
CUBICLE
SECTION
BOOTH
ZONE
ROW
AREA
SEAT
CHAIR
DESK
TABLE
WORKSTATION
BIN
SHELF
LOCKER
RACK
GATE
BATHROOM
BAY
ENTRANCE
HALL
HALLWAY
AISLE
CORRIDOR
STAIR
ELEVATOR
PARKING_LOT
PARKING_SECTION
PARKING_SPOT
CUSTOM_TYPE

MicroPa

part MicroPa extends Common, AddressProperties

Module address

A Micro Point Address represents additional address information to an existing street level Point Address, with the inclusion of a building unit name, floor(level), and/or unit(suite,apartment,flat, etc.).

Property Type Modifier Description
category "MicroPA"
@ns:com:here:mom:meta Metadata optional
@ns:com:here:mom:rmob string optional Currently not specified - may be specified by each Feature individually in future
featureType FeatureType optional Deprecated. This property is redundant to MomFeature.momType and should not be used.

MOM clients before 2.6 release had this deprecated property set to required, so

if data needs to be JSON schema validated by clients before 2.6 this property must be

set by the writer.
isoCountryCode Country optional Deprecated. This indicates which country a Feature is in, with a couple caveats.

- It may be unknown ("NONE" is a valid value, in addition to "UNDEFINED" like all MOM enums) simply because the

writer has not tried to figure it out or has otherwise not had the means to do so.

- It may be outright incorrect or a simplification of reality, specifically when a Feature is close to a country

border or in a disputed area (e.g., two or more countries claim the same area).

In all cases, writers and readers of this data should understand that the semantics of this property must be

agreed upon (if it is used at all). The preferred method of relating a Feature to a Country is through a

(direct or transitive) Reference from the Feature to an Admin.
@ns:com:here:mom:delta Branch optional
@ns:com:here:mom:mapcreator MapCreator optional
@ns:com:here:xyz Xyz optional Generic Data Hub namespace
extensionOSM MomOsm optional Optional extension for OSM (Open Street Map) metadata,

in case the object came from OSM
@ns:com:here:groundTruth GroundTruth optional Ground truth namespace
confidence ConfidenceData optional Confidence of a feature, optional only for the features

that are not participating in Quality Index.
publicationData PublicationExtension optional For HERE classic products (e.g. RDF) this is the point address PVID (aka road-point PVID).
sourceType SourceType optional Source Type indicates how the Point Address has been generated or the level in which it has been manipulated.

Example: Estimated, External Update/Estimated Creation, External Update and Creation, etc.
parentPointAddressId Address Generic Reference to Address.

It indicates the unique identification value for Parent Point Address.
parentMicroPointAddressId Address optional Generic Reference to Address.

It indicates the unique identification value for Parent Micro Point Address.
locationDetails LocationDetail list Location Details describes the name and type of location.
defaultDisplayPointType DisplayPointType Display Point Type represents a point offset from the road network such as a parcel centroid, a building

centroid, or building entrance.
otherDisplayPoints OtherDisplayPoint list Describes the type and position of the Display Point.
routingPoints RoutePoint list Routing Point represents the drive-to location of the Point Address and is the position used for arrival

notification.

It defines the Road Id, Routing Side, Routing Point and Layer Id.

OtherDisplayPoint

part OtherDisplayPoint

Module address

Display Point represents a point offset from the road network. Describes the other Display Point attributes.

Property Type Modifier Description
type DisplayPointType Represents the Display Point Types.

Example: Parcel Centroid, Building Centroid, Front Door, etc.
geometry Point Represents the Position i.e. latitude and longitude of Display Point.

PointAddress

part PointAddress extends Common, AddressProperties

Module address

A Point Address represents an individual address as a point object.

Property Type Modifier Description
category "PointAddress"
@ns:com:here:mom:meta Metadata optional
@ns:com:here:mom:rmob string optional Currently not specified - may be specified by each Feature individually in future
featureType FeatureType optional Deprecated. This property is redundant to MomFeature.momType and should not be used.

MOM clients before 2.6 release had this deprecated property set to required, so

if data needs to be JSON schema validated by clients before 2.6 this property must be

set by the writer.
isoCountryCode Country optional Deprecated. This indicates which country a Feature is in, with a couple caveats.

- It may be unknown ("NONE" is a valid value, in addition to "UNDEFINED" like all MOM enums) simply because the

writer has not tried to figure it out or has otherwise not had the means to do so.

- It may be outright incorrect or a simplification of reality, specifically when a Feature is close to a country

border or in a disputed area (e.g., two or more countries claim the same area).

In all cases, writers and readers of this data should understand that the semantics of this property must be

agreed upon (if it is used at all). The preferred method of relating a Feature to a Country is through a

(direct or transitive) Reference from the Feature to an Admin.
@ns:com:here:mom:delta Branch optional
@ns:com:here:mom:mapcreator MapCreator optional
@ns:com:here:xyz Xyz optional Generic Data Hub namespace
extensionOSM MomOsm optional Optional extension for OSM (Open Street Map) metadata,

in case the object came from OSM
@ns:com:here:groundTruth GroundTruth optional Ground truth namespace
confidence ConfidenceData optional Confidence of a feature, optional only for the features

that are not participating in Quality Index.
publicationData PublicationExtension optional For HERE classic products (e.g. RDF) this is the point address PVID (aka road-point PVID).
sourceType SourceType optional Source Type indicates how the Point Address has been generated or the level in which it has been manipulated.

Example: Estimated, External Update/Estimated Creation, External Update and Creation, etc.
houseNumbers Name list The House Number provides the address that distinctly identifies the associated Point Address.
addressType AddressType optional The Address Type identifies the type of the House Number Point Address.
roadName Name optional A Road Name is an identifying name given to a road.
buildingNames Name list A Building Name is a textual address that represents a building or property name.
addressRoadId string optional Deprecated. Unique Identification value given to address road.

Use `address-road` instead. `address-road` is an explicit feature reference.

The deprecated property, address-road-id, is an "old-style" weak reference by id value only.
routePoint RoutePoint optional Routing Point represents the drive-to location of the Point Address and is the position used for arrival

notification.

It defines the Road ID, Routing Side, Routing Point and Layer ID.
alternativeHouseNumber Name optional Defines an alternative to a House Number.

Building Name may be an alternative to a house number or may be in addition to a house number.
adminId string optional Unique Identification administrative value.
postalCode string optional A Postal Code represents the code generated by the government to facilitate mail delivery.
addressFormat AddressFormat optional Address Format is the representation format of the house number range on the left/right side of the road.
addressRoad LinearRoadNetworkElement optional Road or topology segment for this address. The road network element's

name, administrative area and postal code are consistent with the address.

The route-point provides more precise routing information for the address

but may be on a different road network element than the address-road.
addressedLinkPublicationData PublicationExtension optional For HERE classic products (e.g. RDF) this is the link pvid of the addressed-road.
addressedRoadLinkPublicationData PublicationExtension optional For HERE classic products (e.g. RDF) this is the road link pvid of the addressed-road.
addressedSide Side optional The side of the address-road to which this address is attached.

The side is relative to the linear orientation of the road (or topology segment) geometry.

The property is defined if and only if the address-road is defined.
Constraint Expression Description
addressRoadOrId (non-empty(.addressRoadId) != non-empty(.addressRoad)) Either address-road or address-road-id should be present, not both.
addressedPropsAreConsistent (non-empty(.addressedSide) == non-empty(.addressRoad)) addressed-side is defined if and only if address-road is defined.

SourceType

enum SourceType

Module address

Source Type Attributes.

  • Undefined: Source Type is not defined.
  • Estimated: Created by estimating the POI location.
  • External_Update_Estimated_Creation: Bulk loaded point.
  • External_Update_And_Creation: Created via bulk loader and/or updated by bulk loader.
  • External_Update_Field_Creation: Initially applied manually and updated by bulk loader.
  • Field_Update_Estimated_Creation: Initially added manually and updated by estimation.
  • Field_Update_External_Creation: Bulk loaded point updated manually.
  • Field_Update_And_Creation: Initially added manually and updated manually.
  • Anonymous_Point_Address: Anonymous Point Address. It represents a location that has a latitude/longitude position, but neither a house number nor building name available.
  • External: Data is from an External Source.
  • Field: Data is verified by Field Team.
Value Description
UNDEFINED
ESTIMATED
EXTERNAL_UPDATE_ESTIMATED_CREATION
EXTERNAL_UPDATE_AND_CREATION
EXTERNAL_UPDATE_FIELD_CREATION
FIELD_UPDATE_ESTIMATED_CREATION
FIELD_UPDATE_EXTERNAL_CREATION
FIELD_UPDATE_AND_CREATION
ANONYMOUS_POINT_ADDRESS
EXTERNAL
FIELD

results matching ""

    No results matching ""