This repository contains Java POJO classes for IATA ONE Record (1R), as per official IATA Ontology on GitHub at https://github.com/IATA-Cargo/ONE-Record.
Note that the deliverable of this project contains POJO classes from the Ontologies for "API-Security" and "Data-Model".
This repository additionally contains some assisting classes e.g.,
in package org.iata.cargo.codelists which are not generated from the
Ontology but might be useful for fields where values are limited to code
lists. Please note the codelists packages are incomplete and do not
mirror all cods from the Ontology.
See also IATA-Cargo/ONE-Record Issue#92 for details about
"Standard values of enumerations".
This repository aims use the most minimal dependencies, therefore also build.gradle
comes with disabled transitive dependency resolution. The declared project
dependencies resolve the POJO annocations.
See these examples about the POJOs used in projects:
- https://github.com/riege/one-record-converter (using this library)
- https://github.com/IATA-Cargo/one-record-server-java (original from IATA)
See also https://github.com/riege/one-record-ontologydatamodel.
Public projects like IATA one-record-server-java
or NE:ONE ONE Record server
use similar approaches with embedded Java POJOs.
Comparison one-record-ontologydatamodel and one-record-ontologymodel
| one-record-ontologydatamodel | one-record-ontologymodel | |
|---|---|---|
| Ontology 1.1 / 2021-June | not available (Note 1) | Yes (Release 1.1.x) |
| Ontology 2.0 / 2022-May | not available (Note 1) | Yes (Release 2.0.x) |
| Ontology 2.1 / 2022-December | Yes | not available |
| Scope | DataModel Ontology only | API + DataModel Ontology |
| 3rd party Java annotations | none (clean API) | Jackson, Swagger IO, Spring Framework |
Note 1: Not released but can be build manually by replacing Ontology file and building manually within project.
In general, the official IATA Ontology determines the 1R data model. The IATA Ontology is available in various versions at GitHub. The IATA Cargo Operations and Technology Board, COTB approved various Ontology versions.
Ontologies prior version 1.1 have not been covered enought data fields required used by forwarders in the CargoIMP/XMP (X)FWB.
This project aims to keep its releases and versioning in synchronization with the IATA Ontologies, starting with IATA ONE Record Ontology version 1.1.
| IATA Ontology version / endorsement | ONE.Record Ontology-Model Library version |
|---|---|
| 1.1.x / 2021-June | 1.1.x latest: 1.1.2 (Note 2) |
| 2.0.x / 2022-May | 2.0.x see 2.0.2 |
Note 2: Update for Ontology 1.1 on Oct-22nd 2021, IATA fixed a bug in Ontology 1.1, this fix is mirrored since release 1.1.1 of this library.
For any issues or questions with the ONE Record Ontology and data model as such, please refer to or create new issues with the IATA-Cargo project on GitHub under https://github.com/IATA-Cargo/ONE-Record/issues.
Generation of Java domain classes from the Ontology is part of the IATA Sandbox implementation, see https://github.com/IATA-Cargo/one-record-server-java/blob/master/README.md.
Updating file iata.ttl in that project and applying step "Generate ONE Record cargo related data model" from the README generates the POJOs.
It is recommended to remove directory src/main/generated-sources/org/iata/cargo prior generation.
Example for generation from IATA-Cargo/one-record-server-java main directory on Linux/macOS with Ontology 1.1 (June 2021):
rm -rf src/main/generated-sources/org/iata/cargo
curl -o iata.ttl https://raw.githubusercontent.com/IATA-Cargo/ONE-Record/master/June-2021-standard-COTB-endorsed/Data-Model/IATA-1R-DM-Ontology-vCOTB-Jun2021.ttl
mvn package -Dbuild=cargo
Example for generation from IATA-Cargo/one-record-server-java main directory on Linux/macOS from Ontology working draft:
rm -rf src/main/generated-sources/org/iata/cargo
curl -o iata.ttl https://raw.githubusercontent.com/IATA-Cargo/ONE-Record/master/working_draft/ontology/IATA-1R-DM-Ontology.ttl
mvn package -Dbuild=cargo
Compile might fail now but src/main/generated-sources/org/iata/cargo contains the freshly generated POJO files which require adoption of annotations
prior updating this the one-record-ontologymodel project with them.
The Linux/macOS script patch-from-ontology-diff.sh is capable to
generate a patch-file for the differences of two ontology versions.
The patch could be applied to update this project with the ontology changes/differences.
Downloable URLs of the old and new on ontology could be supplied as 1st and 2nd paramter to the script.
As per 2021-Mar-18, the Ontology 1.1 had various open issues which had been adopted in version 2.0, which had been essential to reach eAWB compatibility e.g., IATA-Cargo/ONE-Record#85 or IATA-Cargo/ONE-Record#111