GroIMP wiki - dev-guide

add-content-registry-descriptor

Anonymous (anonymous@undisclosed.example.com) — 2024-12-04T17:54:52+00:00

GroIMP load doclet.xml files on startup that contains description of methods and classes. Access Descriptor files in runtime The loaded content is added in the runtime registry under /plugins/statics. This directory should have the three directories:

add-navigation

Anonymous (anonymous@undisclosed.example.com) — 2024-04-29T15:20:36+00:00

You can change navigation with view > navigators > select the one you want. You can add a new navigator by creating a new plugin. See template navigator. WIP

add-object-as-node-production

Anonymous (anonymous@undisclosed.example.com) — 2025-01-08T15:33:39+00:00

Includes object in production XL rules can include a production statement, in which some Node and Edges are created (and possibly added - depends on the rule). The production statement is managed by a Producer object. By default, RGG files use a RGGProducer. RGG producer By default, all java objects that extends

add-templates-and-examples

Anonymous (anonymous@undisclosed.example.com) — 2024-04-12T12:12:54+00:00

Add templates and examples The CLI and the API use the same way to load examples and templates, this way is different from the way currently used in the gui. Therefore the examples and templates added as follows will not show in the GUI. For the CLI and the

automatic-code-enhancement

Anonymous (anonymous@undisclosed.example.com) — 2024-05-23T08:07:48+00:00

Code enhancer To work with the graph persistence in GroIMP you can use the automatic code enhancement. The script look for //enh: comments in your code and automatically process the following commands. To execute the code enhancement the following maven command is used:

automatic-conversion

Anonymous (anonymous@undisclosed.example.com) — 2025-01-08T15:30:49+00:00

Implicit conversion GroIMP compiler can automatically perform implicit conversions. By default RGG files use this implicit conversions. A common example is the conversion from float to double (and vice versa). Add a conversion During compilation, if a type if forced onto another (and they are not compatible), the compiler try the Autoconversion, which includes widening conversions, boxing and unboxing, and allows to transform an object of type A into an object of type B by means of conversio…

automatic-imports

Anonymous (anonymous@undisclosed.example.com) — 2024-12-04T13:20:03+00:00

Groimp enables to includes default imports in files when compiling them. These imports are defined in the registry under. /io/filter/xx where xx is the filter type to manage. Currently only the rgg filter is modified, thus, all .rgg files are compiled with additional default imports.

base-objects

Anonymous (anonymous@undisclosed.example.com) — 2025-08-13T10:49:31+00:00

Create object from Nodes -> All objects that are supposed to be added in a groimp project should implement persistence management. (project graph & registry) -> source enhancement creating-node-class automatic-code-enhancement add-object-as-node-production embedded-file-object disposable-node automatic-conversion graph-listeners user-pattern parameter_manager typegraph graphxml

base-platform

Anonymous (anonymous@undisclosed.example.com) — 2024-06-25T10:25:41+00:00

add-navigation add-templates-and-examples create-windows create-new-mimetypes-and-file-types translating-groimp-into-other-languages

contributing

Anonymous (anonymous@undisclosed.example.com) — 2024-04-12T12:00:54+00:00

Add to the Git repository Pushing to the remote repository If you followed the wiki on setting up a git connection This part consists of multiple steps. The plan is as follows: * Add changed files to stage * Create a commit * Push to the forked (your own) project

create-new-api-function

Anonymous (anonymous@undisclosed.example.com) — 2024-04-12T12:08:54+00:00

Create new API functions New GroIMP commands that work with the API can be created in any plugin. This small guide will only create a first starting point, for further information the code of the API plugin should be considered. This does only work with the

create-new-mimetypes-and-file-types

Anonymous (anonymous@undisclosed.example.com) — 2024-04-12T11:39:58+00:00

Creating new mimeType and File type Adding a new type To add the management of a type of file in GroIMP, three java objects needs to be correctly set up: * The Filetype links the extension types and the Mimetype. * The Mimetype defines how GroIMP detect this object type. It links the

create-windows

Anonymous (anonymous@undisclosed.example.com) — 2024-04-12T11:44:34+00:00

Create windows There are many level of windows that can be created in GroIMP, depending on the needs. Basic windows The most common way of creating a new window is by invoking the “createPanel” of the currently used uitoolkit (Swingtoolkit in

creating-node-class

Anonymous (anonymous@undisclosed.example.com) — 2024-04-12T11:30:41+00:00

How to create a node class Creating an own Java node class is not difficult. The new class, say Cube, has to be a subclass of _de.grogra.graph.impl.Node_ or one of its subclasses. So we have to write something like import de.grogra.graph.impl.Node; public class Cube extends Node { }

creating-own-plugin

Anonymous (anonymous@undisclosed.example.com) — 2025-04-02T13:30:13+00:00

GroIMP Plugin Plugin structure The GroIMP software can be extended by plugins. This page describes how to write a plugin named MyPlugin. Firstly, a plugin has to have a special directory layout. The layout depends on how you run GroIMP. There are currently two layout:

developer-guide

Anonymous (anonymous@undisclosed.example.com) — 2024-06-25T09:19:49+00:00

Develop GroIMP in Eclipse This guide is written to give new GroIMP developers an overview about how the required development environment is prepared and installed. This guide starts with the installation of Eclipse and ends with a merge request for the own code changes.

disposable-node

Anonymous (anonymous@undisclosed.example.com) — 2025-01-08T15:16:38+00:00

Disposable Nodes/Fields A Node is considered deleted when it is removed from the graph. The Node is made “transient”, i.e. it is not handled by the persistence manager anymore. Once a Node is “transient” it will be automatically garbage collected by Java. However, a Node can have attributes (fields in java) that require a specific dispose method (e.g

embedded-file-object

Anonymous (anonymous@undisclosed.example.com) — 2025-01-08T18:11:53+00:00

Custom object persistence GroIMP require Nodes, Node's attributes, and SCOs to be manageable by the persistence manager, to process the save/ load/ query operations. GroIMP define its own persistence management. To be managed by the GroIMP persistence management, an object need to implements either

getting-started

Anonymous (anonymous@undisclosed.example.com) — 2024-12-18T09:54:19+00:00

Developer Guide Welcome to this developer guide! Developing on the GroIMP source code only require a java compiler. Additionally GroIMP support two development setup: Maven and Eclipse. Requirements To compile GroIMP you will need the following additional tools:

interacting-groimp

Anonymous (anonymous@undisclosed.example.com) — 2025-04-02T12:46:49+00:00

create-new-api-function add-templates-and-examples add-content-registry-descriptor automatic-imports save-project-with-static export-as-lib

linking-help-button

Anonymous (anonymous@undisclosed.example.com) — 2024-07-08T10:19:29+00:00

Configuration of Help buttons By default every explorer created in GroIMP has a small question mark button on the upper right corner. Moreover several buttons are added to different panels. In the following it will be described how to link this buttons to the right places and how to add buttons to newly created panels.

markdowndoku

Anonymous (anonymous@undisclosed.example.com) — 2024-07-08T08:50:46+00:00

Create embedded documentation based on markdown files With GroIMP 2.1.4 it is possible to use a markdown file to generate the content of the embedded documentation of a GroIMP plugin. The idea is that the README.md file of a git repository is then doubly used. Yet since the pipeline depends on pandoc, it is in theory also possible to use a

maven-commands

Anonymous (anonymous@undisclosed.example.com) — 2024-06-28T14:23:44+00:00

mvn compile mvn package: If the plugin have some java dependencies managed from Maven, the property generate-resources needs to be added to the pom.xml. mvn package -P app-with-doc: Add to the package command the compilation of the plugin's doc. Require

plugin-ecosystem

Anonymous (anonymous@undisclosed.example.com) — 2025-07-18T13:17:39+00:00

Plugin ecosystem Each plugin in GroIMP has its own git repository which can be changed and deployed individually. Plugin Web Explorer The references to all the plugins are collected in the plugin-repo.list in the plugin web exlorer. The same repository is also creating the website plugins.grogra.de based on the content of this list as well as the the plugins.json file for the embedded

plugin-pipeline

Anonymous (anonymous@undisclosed.example.com) — 2025-07-18T13:24:36+00:00

Plugin deployment pipeline In order to ease the deployment of Plugins and their version and to work properly with the Plugin ecosystem, all plugins should follow the deployment pipeline, based on the docker image from: The pipeline is based on gitlab pages! This pipeline goes through the following steps:

plugins-repository

Anonymous (anonymous@undisclosed.example.com) — 2024-06-25T10:43:02+00:00

Plugin repositories The Plugin Manager uses Plugin repositories to gather knowledge on the available plugins. The repositories can be provided in three formats: * Ordered List ItemAs a JSON file. Which contains the metadata of one or several plugins.The file need to follow the JSON format for plugin data (see bellow).

plugins

Anonymous (anonymous@undisclosed.example.com) — 2025-06-18T10:05:57+00:00

GroIMP is designed around plugins, which can be added, modified or removed without modifying the GroIMP installation. GroIMP Plugin Any repository with a plugin.xml and plugin.properties files is considered as a plugin by GroIMP. To be properly loadable though, the

translating-groimp-into-other-languages

Anonymous (anonymous@undisclosed.example.com) — 2024-04-11T15:49:47+00:00

Translating GroIMP into other languages Help to translate GroIMP into other languages is welcome. The steps needed to do so are simple. Every project contains a file src/plugin.properties which stores the text messages displayed in the GUI. To translate those messages into another language, a copy of the file must be made and each message must be replaced by the correct translation.