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 LingusiticNote class which is used for the note content expressed in a specific language.
The text of a Note instance is limited to 10.000 characters.
As a minimum, all Notes shall be expressed in English.
The lang attribute is used to define the language of the Note.
ISO 19115 recommends using ISO 639-2 for language codes. This takes the form of three letters e.g. 'eng'. However, other parts of ISO 639 can be used.
The xml:lang attribute supports supports RFC 3066 and ISO 639. Therefore, it supports 2 letter language codes ('en'), 2 letter codes with country indentification ('en-GB') and 3 letter language identifiers ('eng').
RFC 3066 section 2.3 gives the rules for the choice of language tags. These should be followed to ensure consistency.
Coding Rules for Note
| Identifier | Data Encoding Rule | Justification | Data Verification Rule (UID) | Remarks |
|---|---|---|---|---|
| NTE-101 | For the lang attribute either ISO 639-2 or RFC 3066 standard shall be used. | Data harmonisation | TBD |
Coding Examples
Note for a whole AIXM Feature
The figure below shows the encoding of a Note related to a whole feature, viz. a DesigatedPoint.
.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 actuallly 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).
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!