Note [NTE]
- Wolfgang Scheucher
- POROSNICU Eduard
- Markus Haas
- Manfred Beckmann
AIXM Model Overview
The AIXM 5 UML package for Notes contains the definition of the generalised notes (remarks) concept. Any AIXM feature can have notes at two levels:
- concerning the whole feature,
- concerning a specified property.
Notes may be provided in any language.
The figure below shows that the Note class can be referenced by any AIXMFeature and any AIXMObject.
The Note.purpose attribute may be used to indicate the goal with which a free text note is provided.
In case the note is related to a specific property, the property name as defined in AIXM 5 shall be provided using the Note.propertyName attribute.
The Note is related to the LinguisticNote class, which is used to provide the content of the same note in different languages. The lang attribute is used to define the language of the Note. ISO 19115 used by AIXM 5 for its metadata concept as well as the INSPIRE Metadata Implementing Rules
recommend using ISO 639-2
for language codes. This takes the form of three letters (e.g. 'eng'). The AIXM 5 coding guidelines follow this recommendation (see also coding rule GEN-005 on the [common] Annex A - Verification Rules page).
Although, the xml:lang attribute supports RFC 3066 and ISO 639. Therefore, it supports 2 letter language codes ('en'), 2 letter codes with country identification ('en-GB') and 3 letter language identifiers ('eng').
As a minimum, all notes shall be expressed in English.
The text of a LinguisticNote.note instance is limited to 10.000 characters.
References
Coding Examples
Note for a whole AIXM Feature
The figure below shows the encoding of a Note related to a whole feature, viz. a DesignatedPoint.
.png?version=1&modificationDate=1493911027000&cacheVersion=1&api=v2&width=1024&height=456)
Note for a specific Property
The figure below shows the encoding of a Note related to a specific property of a AIXM feature, viz. the altimeterCheckLocation of an AirportHeliport.
.png?version=1&modificationDate=1493911021000&cacheVersion=1&api=v2&width=1024&height=514)
Note for an AIXM Object
In case of an AIXM object, there are actually two options.
The figure below shows the first option, the encoding of a Note related to the AIXM Object as such, viz. the City.
This has the meaning that the note is for a specific instance of the object. In this example the note is only applicable for 'BERN' and not any other served City (if any).
%20-%20Option%201.png?version=1&modificationDate=1493911018000&cacheVersion=1&api=v2&width=1024&height=515)
The figure below shows the second option, the encoding of a Note on the feature the object is related to, in other words for a specific property of that feature, viz. the servedCity of the AirportHeliport.
This has the meaning that the note is relevant for all related instances of this object and not a specific one. In this example, if the airport would not only serve 'BERN', but also another city, the note will be also applicable for that other served city.
%20-%20Option%202.png?version=1&modificationDate=1493911020000&cacheVersion=1&api=v2&width=1024&height=511)
Coding rules
| Identifier | Data Encoding Rule | Justification | Data Verification Rule (UID) | Remarks |
|---|---|---|---|---|
| NTE-101 | For the lang attribute either ISO 639-2 should be used. | Data harmonisation | TBD | |
| NTE-102 | Each LinguisticNote associated with the same Note should have a different lang value | Data harmonisation | TBD |