/
Note (Overview)

Note (Overview)

Owned by Wolfgang Scheucher
Last updated: 2020 May 15 by POROSNICU Eduard

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 /wiki/spaces/DSSRULES/pages/309363070 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