fossabot/gtf

GTF - Graph Transformation Framework

The Graph Transformation Framework is as the name suggests, all about graphs and their transformation into desired target models. It provides different modules, like ...

• graph: This module contains all the domain objects, that are required to represent a graph and its state.
• template: This module contains classes for various templating and automation tasks.
• transformation: This module allows creating transformations on graph structures.
• verification: With this module a verification on graph models can be performed.
• visualization: This module contains classes for visualization using Freemarker template engine.

Getting Started

There is no general getting started, as it strongly depends on what you want to achieve with the framework. The next few sections provide some examples for the different modules. For more details you can checkout our test classes, which deal with a few different examples and problems.

Graph

If you want to use the graph structure itself, you have to add the following maven dependency to your project:

<dependency>
    <groupId>science.aist.gtf</groupId>
    <artifactId>graph</artifactId>
    <version>${gtf.version}</version> <!-- e.g. 1.0.0 -->
</dependency>

Using graph builder offers you an intuitive, declarative way to define and create your graph, which is shown in the following example.

@lombok.AllArgsConstructor
class Person {
    @lombok.Getter
  int id;
  String name;
}

Function<Person, Object> keyExtractor = Person::getId;
Graph<Person, String> graph = GraphBuilderImpl.<Person, String>create(keyExtractor)
   .from(new Person(1, "Max Mustermann")).toData(new Person(2, "Maxine Musterfrau")).data("married")
   .from(new Person(3, "John Smith")).toDataByKey(2).data("friends")
   .fromByKey(3).toByKey(2)
   .toGraph();

Template

<dependency>
    <groupId>science.aist.gtf</groupId>
    <artifactId>template</artifactId>
    <version>${gtf.version}</version> <!-- e.g. 1.0.0 -->
</dependency>

For a more thorough description of how to use templates refer to template documentation.

Transformation

<dependency>
    <groupId>science.aist.gtf</groupId>
    <artifactId>transformation</artifactId>
    <version>${gtf.version}</version> <!-- e.g. 1.0.0 -->
</dependency>

The transformation module basically consists of interface and abstract helper classes that allow to transform any input into any output. The base concept consists of Transformers and Renderers, where a Transformer is used to transform the whole input into an output whereas the renderers are applied on small parts of the given input. A renderer can have a condition which allows to use a list of renderers with their condition inside MultiRenderers. This form of abstraction allows for a clean separation of concerns.

Example (Note: this example only shows the interaction of a single component).

RendererCondition<String> upperCaseCondition = () -> x -> x.equals("a");
TransformationRender<Optional<String>, String, Graph<String, Void>, String> uppercaseTransformer =
        new AbstractConditionalTransformationRenderer<>(upperCaseCondition) {
            @Override
            public String createElement() {
                return null; // not needed in this case can be used to create the resulting element
            }

            @Override
            public String mapProperties(String s, Graph<String, Void> vertices, String currentElement) {
                return currentElement.toUpperCase();
            }
        };
TransformationRender<Optional<String>, String, Graph<String, Void>, String> lowercaseTransformer = ...;
var renderer = new MultiTransformationRenderer<>(List.of(uppercaseTransformer, lowercaseTransformer));

Graph<String, Void> graph = ...;
Transformer<Graph<String, Void>, List<String>> transformer = g -> {
    List<String> res = new ArrayList<>();
    g.traverseVertices(vv -> res.add(renderer.renderElement(g, vv.getElement())));
    return res;
};
List<String> result = transformer.applyTransformation(graph);

In addition to that transformation can be split into multiple parts and then joined again.

Transformer<Input, Interim> t1 = ...;
Transformer<Interim, Output> t2 = ...;
Transformer<Input, Output> finalTransformation = t1.andThen(t2);

Verification

<dependency>
    <groupId>science.aist.gtf</groupId>
    <artifactId>verification</artifactId>
    <version>${gtf.version}</version> <!-- e.g. 1.0.0 -->
</dependency>

Different approaches for verification are implemented in the verification module. You may checkout the test classes to get an overview over the functionality.

Visualization

<dependency>
    <groupId>science.aist.gtf</groupId>
    <artifactId>visualization</artifactId>
    <version>${gtf.version}</version> <!-- e.g. 1.0.0 -->
</dependency>

The visualization module is based on the template engine and basically provides different implementation for the TemplateEngine interface. As an example the graph transformation framework provides a freemarker-based approach.

FAQ

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

Contributing

First make sure to read our general contribution guidelines.

Licence

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/.

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.

TODO zenodo doi