Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/riege/one-record-ontologymodel
Java POJO classes for IATA ONE Record (Ontology 2.0 and 1.1)
https://github.com/riege/one-record-ontologymodel
java library onerecord
Last synced: 3 months ago
JSON representation
Java POJO classes for IATA ONE Record (Ontology 2.0 and 1.1)
- Host: GitHub
- URL: https://github.com/riege/one-record-ontologymodel
- Owner: riege
- License: upl-1.0
- Created: 2021-08-30T14:35:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-22T09:13:36.000Z (over 1 year ago)
- Last Synced: 2024-07-05T15:40:16.285Z (7 months ago)
- Topics: java, library, onerecord
- Language: Java
- Homepage:
- Size: 323 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-one-record - one-record-ontologymodel
README
# one-record-ontologymodel
## Introduction
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](https://github.com/IATA-Cargo/ONE-Record/issues/92) for details about
"Standard values of enumerations".
## How to use / Dependencies
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)
## Related projects
See also https://github.com/riege/one-record-ontologydatamodel.
Public projects like [IATA one-record-server-java](https://github.com/IATA-Cargo/one-record-server-java)
or [NE:ONE ONE Record server](https://git.openlogisticsfoundation.org/digital-air-cargo/ne-one)
use similar approaches with embedded Java POJOs.
### Comparison [one-record-ontologydatamodel](https://github.com/riege/one-record-ontologydatamodel) and [one-record-ontologymodel](https://github.com/riege/one-record-ontologymodel)
| | [one-record-ontologydatamodel](https://github.com/riege/one-record-ontologydatamodel) | [one-record-ontologymodel](https://github.com/riege/one-record-ontologymodel) |
|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Ontology 1.1 / 2021-June](https://github.com/IATA-Cargo/ONE-Record/tree/master/June-2021-standard-COTB-endorsed) | not available (Note 1) | Yes (Release 1.1.x) |
| [Ontology 2.0 / 2022-May](https://github.com/IATA-Cargo/ONE-Record/tree/master/May-2022-standard-forCOTBendorsement) | not available (Note 1) | Yes (Release 2.0.x) |
| [Ontology 2.1 / 2022-December](https://github.com/IATA-Cargo/ONE-Record/tree/master/December-2022-standard) | Yes | not available |
| Scope | DataModel Ontology only | API + DataModel Ontology |
| 3rd party Java annotations | none (clean API) | [Jackson](https://github.com/FasterXML/jackson), [Swagger IO](https://github.com/swagger-api/swagger.io), [Spring Framework](https://github.com/spring-projects/spring-framework) |
Note 1: Not released but can be build manually by replacing Ontology file and building manually within project.
## Used Ontology / Data model version
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](https://www.iata.org/en/programs/workgroups/cotb)
approved various Ontology versions.
Ontologies prior [version 1.1](https://github.com/IATA-Cargo/ONE-Record/tree/master/June-2021-standard-COTB-endorsed)
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](https://github.com/IATA-Cargo/ONE-Record/tree/master/June-2021-standard-COTB-endorsed) | 1.1.x latest: [1.1.2](../../releases/tag/1.1.2) (Note 2) |
| 2.0.x / [2022-May](https://github.com/IATA-Cargo/ONE-Record/tree/master/May-2022-standard-forCOTBendorsement) | 2.0.x see [2.0.2](../../releases/tag/2.0.2) |
Note 2: Update for Ontology 1.1 on Oct-22nd 2021, IATA [fixed a bug in Ontology 1.1](https://github.com/IATA-Cargo/ONE-Record/tree/master/June-2021-standard-COTB-endorsed),
this fix is mirrored since [release 1.1.1](../../releases/tag/1.1.1) of this library.
## Question and Feedback
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 from a new Ontology
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](https://github.com/IATA-Cargo/one-record-server-java) 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.
## Patching endorsed Ontology to working_draft version
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.
## P.S.
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., https://github.com/IATA-Cargo/ONE-Record/issues/85 or
https://github.com/IATA-Cargo/ONE-Record/issues/111