xatkit-bot-platform / xatkit-uml-platform

Provides action to create and manipulate UML models
Other
4 stars 1 forks source link

Xatkit UML Platform

License Badge Build Status Wiki Badge

Create and manipulate UML (meta) models in Xatkit execution models.

UML models are internally stored as instances of the Eclipse UML metamodel. To render them (see Save action below), we rely on PlantuML: the UML model is transformed to PlantUML syntax and render by PlantUML before returning it back to the requester.

Providers

The UML platform does not define any provider.

Actions

Action Parameters Return Return Type Description
CreateClass - name (String): the name of the UML Class to create The created UML Class Class Creates a UML Class with the provided name
GetClass - name (String): the name of the UML Class to retrieve in the current model The UML Class with the provided name Class Returns the UML Class in the current model with the provided name
AddAttribute - class (Class): the UML Class to add an attribute to
- name (String): the name of the attribute to add
The created UML Property Property Adds an attributes name to the provided class and returns it
AddAttribute - class (Class): the UML Class to add an attribute to
- name (String): the name of the attribute to add
- type (String): the name of the DataType to set as the attribute's type
The created UML Property Property Adds an attribute name with the provided type to the provided class and returns it
AddAssociation - source (Class): the source Class of the association
- target (Class): the target Class of the association
- type (String): the type of the association
The created UML Association Association Creates an association between source and target with the given type (the type literals can be found in AggregationKind)
Save - The File object containing the PNG representation of the model File Save the current model and renders it in a PNG

Options

The UML platform does not support any configuration option.

Installation Notes

PlantUML uses Graphviz for rendering the UML diagram. Make sure you have Graphviz installed before trying to use this platform. More info on Graphviz installation