Package io.jmix.datatools.datamodel.engine.plantuml.impl

Class PlantUmlDiagramEngine

java.lang.Object

io.jmix.datatools.datamodel.engine.plantuml.impl.PlantUmlDiagramEngine

All Implemented Interfaces:

DiagramEngine

public class PlantUmlDiagramEngine
extends Object
implements DiagramEngine

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	attributeTemplate
protected final int	dataStoresCount
protected final DatatoolsProperties	datatoolsProperties
protected final String	entityTemplate
protected final PlantUmlEncoder	plantUmlEncoder
protected final String	relationTemplate
protected final org.springframework.web.client.RestClient	restClient
protected final String	template
protected final String	urlTemplate

Constructor Summary

Constructors

Constructor	Description
PlantUmlDiagramEngine(DatatoolsProperties datatoolsProperties, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
protected org.springframework.web.client.RestClient	configureClient(String baseUrl)
String	constructEntityDescription(String entityName, String dataStoreName, List<AttributeModel> attributeModelList)	Constructs a description of an entity in the format required by the selected diagramming library.
String	constructRelationDescription(String currentEntityType, String refEntityType, RelationType relationType, String dataStoreName)	Constructs a string representation of a relationship between two entities in a specific format for use with a diagramming library.
protected String	createAttributeTemplate()
protected String	createBaseURL()
protected PlantUmlEncoder	createEncoder()
protected String	createEntityTemplate()
protected String	createRelationTemplate()
protected String	createTemplate()
protected String	createURLTemplate()
byte[]	generateDiagram(String entitiesDescription, String relationsDescriptions)	Generates a diagram in a binary format based on the provided descriptions of entities and their relationships.
protected int	getDataStoresCount(Metadata metadata)
boolean	pingService()	Checks the availability of the remote diagramming service.
protected byte[]	receiveDiagramFile(String diagramDescription)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

datatoolsProperties

protected final DatatoolsProperties datatoolsProperties

plantUmlEncoder

protected final PlantUmlEncoder plantUmlEncoder

template

protected final String template

entityTemplate

protected final String entityTemplate

attributeTemplate

protected final String attributeTemplate

relationTemplate

protected final String relationTemplate

urlTemplate

protected final String urlTemplate

restClient

protected final org.springframework.web.client.RestClient restClient

dataStoresCount

protected final int dataStoresCount

Constructor Details

PlantUmlDiagramEngine

public PlantUmlDiagramEngine(DatatoolsProperties datatoolsProperties,
 Metadata metadata)

Method Details

getDataStoresCount

protected int getDataStoresCount(Metadata metadata)

createBaseURL

protected String createBaseURL()

createEncoder

protected PlantUmlEncoder createEncoder()

createTemplate

protected String createTemplate()

createURLTemplate

protected String createURLTemplate()

createEntityTemplate

protected String createEntityTemplate()

createAttributeTemplate

protected String createAttributeTemplate()

createRelationTemplate

protected String createRelationTemplate()

configureClient

protected org.springframework.web.client.RestClient configureClient(String baseUrl)

receiveDiagramFile

protected byte[] receiveDiagramFile(String diagramDescription)

constructEntityDescription

public String constructEntityDescription(String entityName,
 String dataStoreName,
 List<AttributeModel> attributeModelList)

Description copied from interface: DiagramEngine

Constructs a description of an entity in the format required by the selected diagramming library.

Specified by:

constructEntityDescription in interface DiagramEngine

Parameters:

entityName - the name of the entity to be described

dataStoreName - the name of the data store where the entity resides

attributeModelList - a list of attributes that define the structure of the entity

Returns:

a string representing the description of the entity in the required format

constructRelationDescription

public String constructRelationDescription(String currentEntityType,
 String refEntityType,
 RelationType relationType,
 String dataStoreName)

Description copied from interface: DiagramEngine

Constructs a string representation of a relationship between two entities in a specific format for use with a diagramming library.

Specified by:

constructRelationDescription in interface DiagramEngine

Parameters:

currentEntityType - the type of the current entity involved in the relationship

refEntityType - the type of the referenced entity involved in the relationship

relationType - the type of the relationship (e.g., MANY_TO_ONE, ONE_TO_MANY)

dataStoreName - the name of the data store where the entities reside

Returns:

a string describing the relationship between the specified entities in the required format

pingService

public boolean pingService()

Description copied from interface: DiagramEngine

Checks the availability of the remote diagramming service.

Specified by:

pingService in interface DiagramEngine

Returns:

true if the service is accessible, otherwise false.

generateDiagram

public byte[] generateDiagram(String entitiesDescription,
 String relationsDescriptions)

Description copied from interface: DiagramEngine

Generates a diagram in a binary format based on the provided descriptions of entities and their relationships.

Specified by:

generateDiagram in interface DiagramEngine

Parameters:

entitiesDescription - a string containing the descriptions of entities to be included in the diagram

relationsDescriptions - a string containing the descriptions of relationships between entities

Returns:

a byte array representing the generated diagram