Package org.odpi.openmetadata.commonservices.mermaid

Class MermaidGraphBuilderBase

java.lang.Object

org.odpi.openmetadata.commonservices.mermaid.MermaidGraphBuilderBase

Direct Known Subclasses:

AssetGraphMermaidGraphBuilder, AssetLineageGraphMermaidGraphBuilder, HierarchyMermaidGraphBuilder, OpenMetadataMermaidGraphBuilder

public class MermaidGraphBuilderBase
extends Object

Provides the basic functions for building flowchart based graph visualizations

Field Summary

Fields

Modifier and Type	Field	Description
protected final StringBuilder	mermaidGraph

Constructor Summary

Constructors

Constructor	Description
MermaidGraphBuilderBase()

Method Summary

Modifier and Type	Method	Description
void	appendMermaidLine(String end1Id, String label, String end2Id)	Append a line to the graph.
void	appendMermaidNode(String currentNodeName, String currentDisplayName, String currentType)	Create a node in the mermaid graph.
String	getListLabel(List<String> labelValues)	Convert an array into a comma separated string.
String	getMermaidGraph()	Return the built mermaid graph.

Methods inherited from class java.lang.Object

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

Field Details

mermaidGraph

protected final StringBuilder mermaidGraph

Constructor Details

MermaidGraphBuilderBase

public MermaidGraphBuilderBase()

Method Details

getListLabel

public String getListLabel(List<String> labelValues)

Convert an array into a comma separated string.

Parameters:

labelValues - array of labels

Returns:

string value without square brackets (Mermaid does not allow them)

appendMermaidNode

public void appendMermaidNode(String currentNodeName,
 String currentDisplayName,
 String currentType)

Create a node in the mermaid graph.

Parameters:

currentNodeName - unique name/identifier

currentDisplayName - display name

currentType - type of element

appendMermaidLine

public void appendMermaidLine(String end1Id,
 String label,
 String end2Id)

Append a line to the graph.

Parameters:

end1Id - identifier of the starting end

label - label for the line

end2Id - identifier of the ending end

getMermaidGraph

public String getMermaidGraph()

Return the built mermaid graph.

Returns:

string markdown