Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


Page Table of Content


Extract of requirement

Title

Establish semantic correspondence

Identifier

SWIM-INFO-013

Requirement

An information definition shall document a semantic correspondence for each of its concepts.

Rationale

Documentation of semantic correspondence is the evidence that an information definition is an AIRM conformant information definition.

Verification

Completeness

Examples/Notes

Note: This requirement covers information concepts and data concepts.

Note: This requirement allows an information definition to:

  • be accompanied by a standalone resource containing the statements of semantic correspondence; or
  • have statements of semantic correspondence embedded in it; or 
  • be accompanied by a reference to an already existing set of semantic correspondences.


Note: The forms that a semantic correspondence can take are given in SWIM-INFO-014.

Note: It is important to ensure that the syntax used for mappings is self-explaining or appropriately explained. To this end, extra information can accompany the information definition in order to ensure that the mappings can be understood without having to read external documentation or make assumptions on how the mappings are technically and procedurally implemented.


Example: A statement that the “container’s traces” are considered as part of the concept mappings (as discussed in SWIM-INFO-018).

Level of Implementation

Mandatory

Explanations

Documenting semantic correspondences

Consider having a running example/scenario in the requirements. Make the examples be consistent with the scenario. Scenario is based around the need to define a service (new and legacy). At the moment the target audience is humans/organisation needing to show conformance - obviously tooling can be developed by organisations. Tooling section may be added e.g. on ontology matching tools. 


A semantic correspondence is the relation between a concept in an information definition and the AIRM.


The relations (further explained in SWIM-INFO-014 - delete the diagram here as it is better in SWIM-INFO-014) can be visualised below:


This requirement ensures that the relations are documented. This allows them to be shared. The requirement allows an information definition to:

  • be accompanied by a standalone resource containing the statements of semantic correspondence; or
  • have statements of semantic correspondence embedded in it;
  • be accompanied by a reference to an already existing set of semantic correspondences.

Standalone resource


AIXM is accompanied by a spreadsheet.


The following concepts are mapped to the AIRM: AerialRefuelling, AerialRefuellingAnchor, AerialRefuellingPoint, AerialRefuellingTrack, AuthorityForAerialRefuelling. In all the cases the “Degree of Correspondence” is ExactCopy (definition of source and target are exact copy of each other), except for AerialRefuellingPoint where the “Degree of Correspondence” is Restriction (Source definition is a restricted case of the target definition, i.e. it retains the original definition but adds additional qualifiers).

It shall be provided a Compliance Report as a MS Word document according to the template defined in Appendix A.1. All the required fields shall be filled in. The actual mapping artifact within the template could be provided as a table as explained in Appendix A.2, or via a UML mapping model as explained in Appendix B.

Embedded: tbd

The code attribute in the OtherInformation field of the flight plan maps to the CLDM attribute Aircraft.icaoAircraftAddress. See Figure 4 how the URN from the target attribute has been used to fill in the tagged value for the source attribute.

Figure 4. Simple mapping for aircraft address field in the flight plan.

Reference:

reference to another information definition. Example – a profile of AIXM can refer to the sematic correspondence artefact which accompanies AIXM.

Is my message built on a standard model?

Be careful in use of terminology e.g. message. Need a controlled vocabulary. Bring it in from the specs and use hyperlinks.

Should this be in the service SPEC supporting material?

The scenario approach would help a great deal here.

If messages are composed by elements entirely built on an exchange model (such as FIXM, AIXM, IWXXM) then the AIRM Compliance must be assessed for the underlying model only. If the exchange model already has an AIRM Compliance Report, then the compliance for the message is already satisfied and the available Report can be referenced right away.

If the underlying model does not have a Compliance Report, you shall produce it by following instructions in Section 5.

If the message adds extensions or additional constructs with respect to the exchange model, then Compliance shall be elaborated on the additional part according to next Section 4.2.

If not, what do I have to provide?

AIRM Compliance is achieved by mapping all constructs present in schemas (elements typed as simple and complex types) to AIRM.

The mapping between schema elements and the AIRM is provided by referencing the target AIRM elements via their URNs. The mapping can be provided as a table as explained in Appendix A.2.

Ensuring the documentation is understandable

Note: It is important to ensure that the syntax used for mappings is self-explaining or appropriately explained. To this end, extra information can accompany the information definition in order to ensure that the mappings can be understood without having to read external documentation or make assumptions on how the mappings are technically and procedurally implemented.

 

Example: A statement that the “container’s traces” are considered as part of the concept mappings (as discussed in SWIM-INFO-018).

Verification Support

Completeness: Check that a semantic correspondence statement exists for each concept in the information definition.

Examples/Best Practice

Example of SWIM-INFO-013
<gmd:title> guess what </gmd:title>


Available support files

Templates

Spreadsheet template

<make this available>

  • No labels