Package com.structurizr.export.mermaid

Class MermaidDiagramExporter

java.lang.Object

com.structurizr.export.AbstractExporter

com.structurizr.export.AbstractDiagramExporter

com.structurizr.export.mermaid.MermaidDiagramExporter

All Implemented Interfaces:

DiagramExporter, Exporter

public class MermaidDiagramExporter
extends AbstractDiagramExporter

Exports diagram definitions that can be used to create diagrams using mermaid (https://mermaidjs.github.io). System landscape, system context, container, component, dynamic and deployment diagrams are supported. Deployment node -> deployment node relationships are not rendered.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MERMAID_ICONS_PROPERTY
static final String	MERMAID_SEQUENCE_DIAGRAM_PROPERTY
static final String	MERMAID_TITLE_PROPERTY

Fields inherited from class com.structurizr.export.AbstractDiagramExporter

GROUP_SEPARATOR_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
MermaidDiagramExporter()

Method Summary

Modifier and Type	Method	Description
protected Diagram	createDiagram(com.structurizr.view.ModelView view, String definition)
protected void	endContainerBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endDeploymentNodeBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endEnterpriseBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endGroupBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endSoftwareSystemBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
Diagram	export(com.structurizr.view.DynamicView view)
protected boolean	includeTitle(com.structurizr.view.ModelView view)
protected boolean	renderAsSequenceDiagram(com.structurizr.view.ModelView view)
protected void	startContainerBoundary(com.structurizr.view.ModelView view, com.structurizr.model.Container container, IndentingWriter writer)
protected void	startDeploymentNodeBoundary(com.structurizr.view.DeploymentView view, com.structurizr.model.DeploymentNode deploymentNode, IndentingWriter writer)
protected void	startEnterpriseBoundary(com.structurizr.view.ModelView view, String enterpriseName, IndentingWriter writer)
protected void	startGroupBoundary(com.structurizr.view.ModelView view, String group, IndentingWriter writer)
protected void	startSoftwareSystemBoundary(com.structurizr.view.ModelView view, com.structurizr.model.SoftwareSystem softwareSystem, IndentingWriter writer)
protected void	writeElement(com.structurizr.view.ModelView view, com.structurizr.model.Element element, IndentingWriter writer)
protected void	writeFooter(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeHeader(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeRelationship(com.structurizr.view.ModelView view, com.structurizr.view.RelationshipView relationshipView, IndentingWriter writer)

Methods inherited from class com.structurizr.export.AbstractDiagramExporter

createLegend, export, export, export, export, export, export, export, export, export, export, export, getBoundaryContainers, getBoundarySoftwareSystems, getViewOrViewSetProperty, isAnimationSupported, isVisible, isVisible, writeElements, writeRelationships

Methods inherited from class com.structurizr.export.AbstractExporter

breakText, findElementStyle, findRelationshipStyle, hasValue, typeOf, typeOf

Methods inherited from class java.lang.Object

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

Field Details

MERMAID_TITLE_PROPERTY

public static final String MERMAID_TITLE_PROPERTY

See Also:

• Constant Field Values

MERMAID_SEQUENCE_DIAGRAM_PROPERTY

public static final String MERMAID_SEQUENCE_DIAGRAM_PROPERTY

See Also:

• Constant Field Values

MERMAID_ICONS_PROPERTY

public static final String MERMAID_ICONS_PROPERTY

See Also:

• Constant Field Values

Constructor Details

MermaidDiagramExporter

public MermaidDiagramExporter()

Method Details

writeHeader

protected void writeHeader(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

writeHeader in class AbstractDiagramExporter

writeFooter

protected void writeFooter(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

writeFooter in class AbstractDiagramExporter

startEnterpriseBoundary

protected void startEnterpriseBoundary(com.structurizr.view.ModelView view,
 String enterpriseName,
 IndentingWriter writer)

Specified by:

startEnterpriseBoundary in class AbstractDiagramExporter

endEnterpriseBoundary

protected void endEnterpriseBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endEnterpriseBoundary in class AbstractDiagramExporter

startGroupBoundary

protected void startGroupBoundary(com.structurizr.view.ModelView view,
 String group,
 IndentingWriter writer)

Specified by:

startGroupBoundary in class AbstractDiagramExporter

endGroupBoundary

protected void endGroupBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endGroupBoundary in class AbstractDiagramExporter

startSoftwareSystemBoundary

protected void startSoftwareSystemBoundary(com.structurizr.view.ModelView view,
 com.structurizr.model.SoftwareSystem softwareSystem,
 IndentingWriter writer)

Specified by:

startSoftwareSystemBoundary in class AbstractDiagramExporter

endSoftwareSystemBoundary

protected void endSoftwareSystemBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endSoftwareSystemBoundary in class AbstractDiagramExporter

startContainerBoundary

protected void startContainerBoundary(com.structurizr.view.ModelView view,
 com.structurizr.model.Container container,
 IndentingWriter writer)

Specified by:

startContainerBoundary in class AbstractDiagramExporter

endContainerBoundary

protected void endContainerBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endContainerBoundary in class AbstractDiagramExporter

startDeploymentNodeBoundary

protected void startDeploymentNodeBoundary(com.structurizr.view.DeploymentView view,
 com.structurizr.model.DeploymentNode deploymentNode,
 IndentingWriter writer)

Specified by:

startDeploymentNodeBoundary in class AbstractDiagramExporter

endDeploymentNodeBoundary

protected void endDeploymentNodeBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endDeploymentNodeBoundary in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.DynamicView view)

Overrides:

export in class AbstractDiagramExporter

writeElement

protected void writeElement(com.structurizr.view.ModelView view,
 com.structurizr.model.Element element,
 IndentingWriter writer)

Specified by:

writeElement in class AbstractDiagramExporter

writeRelationship

protected void writeRelationship(com.structurizr.view.ModelView view,
 com.structurizr.view.RelationshipView relationshipView,
 IndentingWriter writer)

Specified by:

writeRelationship in class AbstractDiagramExporter

createDiagram

protected Diagram createDiagram(com.structurizr.view.ModelView view,
 String definition)

Specified by:

createDiagram in class AbstractDiagramExporter

includeTitle

protected boolean includeTitle(com.structurizr.view.ModelView view)

renderAsSequenceDiagram

protected boolean renderAsSequenceDiagram(com.structurizr.view.ModelView view)