https://github.com/googleinterns/ddex-mead-parser
https://github.com/googleinterns/ddex-mead-parser
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/googleinterns/ddex-mead-parser
- Owner: googleinterns
- License: apache-2.0
- Created: 2020-05-20T16:43:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T16:23:07.000Z (over 1 year ago)
- Last Synced: 2025-04-06T18:50:40.867Z (about 1 year ago)
- Language: Java
- Size: 13.6 MB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## DDEX XML/XSD to Protocol Buffer
**(Digital Data Exchange Standards) [ERN + MEAD] to Protocol Buffer Conversion**
### Overview
MEAD and ERN messages are transmitted in XML format. This tool allows users to convert
the XSD schemas and XML messages to Protocol Buffer format.
This README file contains instructions for general use of the conversion tools.
You can find more information about Protocol Buffer's here:
[https://developers.google.com/protocol-buffers/](https://developers.google.com/protocol-buffers/)
### General Usage
The tool has two core functions:
- Convert the XSD(s) representing a DDEX standard (e.g. ERN 3.8.1) to an equivalent Protocol Buffer schema
- Convert the XML(s) representing an ERN or MEAD message to an equivalent Protocol Buffer message
### Converting Standards' XSD Schema to Protocol Buffer
XSD's for ERN and MEAD can be found on the DDEX website.
(Old standards) https://kb.ddex.net/display/HBK/Old+Versions+of+DDEX+Standards
(More) https://kb.ddex.net/display/HBK/List+of+Standards+available+from+the+DDEX+Knowledge+Base
(MEAD Proposal) https://kb.ddex.net/pages/viewpage.action?pageId=13470928
Converting the DDEX XSD's is a prerequisite for converting messages, since each message conversion depends
on the corresponding Protocol Buffer schema (.proto) to exist. The Java tool handles conversion from XSD to
Protocol Buffer schema.
To use the Java **command line application** to parse XSD, more information can be found at:
[java/ddex-convertercli/README.md](java/ddex-convertercli/README.md)
To use the Java **library** to parse XSD, more information can be found at:
[java/ddex-xsdtoproto/README.md](java/ddex-xsdtoproto/README.md)
A successful conversion from XSD to Protocol Buffer will yield a folder containing `.proto` files representing the processed schema.
These `.proto` schema files can be compiled to either Java or C++ classes by the `protoc`compiler
(refer [here](https://github.com/protocolbuffers/protobuf/blob/master/README.md) for instruction on how to install and use the `protoc` compiler).
More information about the generated .proto in comparison to the original XSD: [SCHEMA.md](SCHEMA.md)
### Converting XML Messages to Protocol Buffer
Given an ERN or MEAD XML message, both the C++ and Java tools can be used to convert the message to
Protocol Buffer.
Both versions include a command line wrapper for their respective library implementations.
To use the Java **command line application** to parse XML, more information can be found at:
[java/ddex-convertercli/README.md](java/ddex-convertercli/README.md)
To use the Java **library** to parse XML, more information can be found at:
[java/ddex-xmltoproto/README.md](java/ddex-xmltoproto/README.md)
To use the C++ **command line application** to parse XML, more information can be found at:
[cpp/ddex-convertercli/README.md](cpp/ddex-convertercli/README.md)
To use the C++ **library** to parse XML, more information can be found at:
[cpp/ddex-xmltoproto/README.md](cpp/ddex-xmltoproto/README.md)
**Note** - Conversion of ERN and MEAD messages are dependent on existing support for their schema versions (ERN <= 4.2, MEAD <= 1.01).
To manually upgrade the XML to Protocol Buffer tools, instructions for both Java and C++ can be found at...
- Java: [java/UPGRADE.md](java/UPGRADE.md)
- C++: [cpp/UPGRADE.md](cpp/UPGRADE.md)