Package org.odpi.openmetadata.commonservices.mermaid

Class MermaidGraphBuilderBase

java.lang.Object

org.odpi.openmetadata.commonservices.mermaid.MermaidGraphBuilderBase

Direct Known Subclasses:

AssetGraphMermaidGraphBuilder, AssetLineageGraphMermaidGraphBuilder, GovernanceActionProcessMermaidGraphBuilder, HierarchyMermaidGraphBuilder, InformationSupplyChainMermaidGraphBuilder, OpenMetadataMermaidGraphBuilder, SolutionBlueprintMermaidGraphBuilder, SolutionComponentMermaidGraphBuilder, SolutionRoleMermaidGraphBuilder, SpecificationMermaidGraphBuilder

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
protected final Map<String,VisualStyle>	nodeColours
protected final PropertyHelper	propertyHelper

Constructor Summary

Constructors

Constructor	Description
MermaidGraphBuilderBase()

Method Summary

Modifier and Type	Method	Description
protected void	addSolutionComponentToGraph(String parentNodeName, String parentLinkLabel, SolutionComponentElement solutionComponentElement, List<String> solutionLinkingWireGUIDs)	Add a solution component to graph.
protected String	addSpacesToTypeName(String typeName)	Convert a type name into a spaced string to allow the names to wrap nicely in a mermaid box.
protected void	addStyles()	Add styling for nodes as requested.
void	appendInvisibleMermaidLine(String end1Id, String end2Id)	Append an invisible line to the graph.
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.
void	appendMermaidThinLine(String end1Id, String label, String end2Id)	Append a line to the graph.
void	appendNewMermaidNode(String currentNodeName, String currentDisplayName, String currentType, VisualStyle visualStyle)	Create a node in the mermaid graph.
String	getListLabel(List<String> labelValues)	Convert an array into a comma separated string.
String	getMermaidGraph()	Add any style requests and return the built mermaid graph.
protected String	getNodeDisplayName(MetadataElementSummary metadataElementSummary)
protected VisualStyle	getVisualStyleForSolutionComponent(String solutionComponentType)	Map the solution component type to an appropriate visual style.

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

nodeColours

protected final Map<String,VisualStyle> nodeColours

propertyHelper

protected final PropertyHelper propertyHelper

Constructor Details

MermaidGraphBuilderBase

public MermaidGraphBuilderBase()

Method Details

getVisualStyleForSolutionComponent

protected VisualStyle getVisualStyleForSolutionComponent(String solutionComponentType)

Map the solution component type to an appropriate visual style.

Parameters:

solutionComponentType - type of component

Returns:

visual style enum

addSpacesToTypeName

protected String addSpacesToTypeName(String typeName)

Convert a type name into a spaced string to allow the names to wrap nicely in a mermaid box.

Parameters:

typeName - type name

Returns:

spaced type name

getListLabel

public String getListLabel(List<String> labelValues)

Convert an array into a comma separated string.

Parameters:

labelValues - array of labels

Returns:

string value

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

appendNewMermaidNode

public void appendNewMermaidNode(String currentNodeName,
 String currentDisplayName,
 String currentType,
 VisualStyle visualStyle)

Create a node in the mermaid graph.

Parameters:

currentNodeName - unique name/identifier

currentDisplayName - display name

currentType - type of element

visualStyle - mermaid defined shape and colour value

appendMermaidThinLine

public void appendMermaidThinLine(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

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

appendInvisibleMermaidLine

public void appendInvisibleMermaidLine(String end1Id,
 String end2Id)

Append an invisible line to the graph. This is used to line up descriptions etc

Parameters:

end1Id - identifier of the starting end

end2Id - identifier of the ending end

addStyles

protected void addStyles()

Add styling for nodes as requested. These go at the end of the graph.

getNodeDisplayName

protected String getNodeDisplayName(MetadataElementSummary metadataElementSummary)

addSolutionComponentToGraph

protected void addSolutionComponentToGraph(String parentNodeName,
 String parentLinkLabel,
 SolutionComponentElement solutionComponentElement,
 List<String> solutionLinkingWireGUIDs)

Add a solution component to graph.

Parameters:

parentNodeName - identifier of the parent node (maybe null)

parentLinkLabel - add label to parent link - also optional

solutionComponentElement - element to process

solutionLinkingWireGUIDs - list of solution wires already defined

getMermaidGraph

public String getMermaidGraph()

Add any style requests and return the built mermaid graph.

Returns:

string markdown