Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.15 KB

README.md

File metadata and controls

65 lines (43 loc) · 2.15 KB
Raw

OCEL Model

This project contains an autogenerated java model for the OCEL standard, as specified here. These classes are generated using the XML schema definition file and jax-b.

Getting Started

To use the classes, simply include the maven dependency on the project.

<dependency>
    <groupId>science.aist</groupId>
    <artifactId>ocel-model</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope> <!-- Note: this is default -->
</dependency>

Then you are able to load OCEL files the following way:

XMLRepository<LogType> repository = new LogRepository()

// load
JAXBElement<LogType> log = repository.load(inputStream);

// save
repository.save(log, outputStream);

Building the XML model yourself

If you want to build the project yourself, just checkout this git repo, make sure you have jdk 11 or above installed as well as maven 3.6.0 or above and build the project by running the maven command: mvn package. This results in a jar-file inside the target folder, which can be used as a dependency in other projects.

FAQ

If you have any questions, please checkout our FAQ section.

Contributing

First make sure to read our general contribution guidelines.

License

Copyright (c) 2020 the original author or authors. DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

The following files are under different licence and copyright:

Licence Filepaths
Copyright © 2021 Process and Data Science Group (PADS) of the RWTH Aachen University. src/main/resources/ocel.xsd and src/test/resources/running-example.xmlocel

Research

If you are going to use this project as part of a research paper, we would ask you to reference this project by citing it.

DOI