[AIXM-573] Obstacle place name and designator

Description

Properties for designator and place name (administrative location) are added in the VerticalStructure. The maximum length of a designator for both VerticalStructure and VerticalStructurePart is extended to 60 characters.

Note: This Change Proposal replaces AIXM-399.

Rationale for change

See https://aixmccb.atlassian.net/browse/AIXM-239  and https://aixmccb.atlassian.net/browse/AIXM-281

The current VerticalStructure and VerticalStructurePart properties are not sufficient to describe the details that many countries provide in terms of designator, name and location of the obstacle itself or parts of it. The available properties run the risk of being misused:

• most obstacles have a designator for the obstacle as a whole. The current model allows a designator to be coded only for a VerticalStructurePart. The coding guidelines recommend using the name property for the designator, but this workaround might create confusion and might be inapplicable for an obstacle that has both an “national registry ID” and a name. Therefore, a VerticalStructure designator attribute is needed;
• some countries have obstacle designators that are longer than the 16 character limits of the AIXM TextDesignatorType;
• some countries publish an administrative area name (such as “city”, “municipality”, etc.) as a property of the obstacle. This is neither a name nor a designator and it would benefit from being coded as a separate property.

In order to enable Data Providers to code the VerticalStructure(Part) data as necessary, some properties shall be added, other already available properties shall be extended in length.

Impact assessment

[FWD_MAP_1:1] Data mapping is possible and no data loss occurs when data is exchanged from a system (A) that uses AIXM 5.1.1 for output towards a system (B) that uses AIXM 5.2 for input.

[BWD_MAP_LOSS] Data mapping is possible, but some data would be lost (or converted into Notes) when data is exchanged from a system (B) that uses AIXM 5.2 for output towards a system (A) that uses AIXM 5.1.1 for input.

Change Proposal details

In the UML model, in the class VerticalStructure:

• Add a designator attribute with definition “A coded identifier associated with the structure, taken from a national or local obstacle registry” and data type TextDesignatorLongType;
• Add placeName property with definition “A description of the geographical location where the vertical structure is situated” and data type TextNameType:
  
  

In the UML Model, in the class VerticalStructurePart

• Modify the data type of  the designator property to use TextDesignatorLongType;
  
  

In the UML Model, add the following new data types:

• TextDesignatorLongBaseType with stereotype <<DataType>> as a specialisation of the Character3 data type:
  • Definition = “A relatively long textual designator.”
  • minLength=1
  • maxLength=60
• TextDesignatorLongType with stereotype <<DataType>> as a specialisation of the TextDesignatorLongBaseType data type
  • Definition = “A complex data type that enables the provision of a NIL reason for any attribute using this type.”
  • Attribute
    • nilReason, type NilReasonEnumeration

The following UML class diagram highlights the new/modified properties:

Mapping AIXM 5.1.1 to AIXM 5.2 (forward)

• Not applicable.

Mapping AIXM 5.2 to AIXM 5.1.1 (backward)

[MAPC-06] For each VerticalStructurePart that has a designator child element longer than 16 characters.

From the three backward mapping options discussed for this case, the first two (discard the value or use an extension) are straightforward and do not need any further details. The 3rd option (backward mapping into a Note) is detailed in order to provide a complete description of this case and its conversion option. The following mapping into Note algorithm is proposed:

• Remove the value of the designator element and insert the following XML attributes
  • xsi:nil="true"
  • nilReason="other:invalidValueCopiedAsNote"
• Add an annotation.Note associated with the owner class having
• purpose=“OTHER:BACKWARD_MAPPING”;
• LinguisticNote.note=”<designator_value>” (the full content of the longer element string value)
• propertyName=”designator”

[MAPC-02] For each VerticalStructure that has specified designator or placeName values:

From the three backward mapping options applicable in this case, the first two (discard the value or use an extension) are straightforward and do not need any further details. The 3^rd option (backward mapping into a Note) is detailed in order to provide a complete description of this case and its conversion option. The following mapping into Note algorithm is proposed:

• Remove the designator element
• Add an annotation.Note associated with the VerticalStructure class having:
• purpose=“OTHER:BACKWARD_MAPPING”
• LinguisticNote.note=”designator: <designator>”.
• Remove the placeName element
• Add an annotation.Note associated with the VerticalStructure class having:
• purpose=“OTHER:BACKWARD_MAPPING”
• LinguisticNote.note=”placeName: <placeName>”.

Mapping example

(Note: for mapping test data see: https://github.com/aixm/mapping_52_511/tree/master/AIXM-xxx) 

AIXM Input	AIXM Output