Package com.structurizr.export

Class AbstractDiagramExporter

java.lang.Object
com.structurizr.export.AbstractExporter
com.structurizr.export.AbstractDiagramExporter
All Implemented Interfaces:
DiagramExporter, Exporter
Direct Known Subclasses:
AbstractPlantUMLExporter, DOTExporter, MermaidDiagramExporter, WebSequenceDiagramsExporter
public abstract class AbstractDiagramExporter extends AbstractExporter implements DiagramExporter

  • Field Details

  • Constructor Details

    • AbstractDiagramExporter

      public AbstractDiagramExporter()

  • Method Details

    • export

      public final Collection<Diagram> export(com.structurizr.Workspace workspace)
      Exports all views in the workspace.
      Specified by:
      export in interface DiagramExporter
      Parameters:
      workspace - the workspace containing the views to be written
      Returns:
      a collection of diagram definitions, one per view

    • export

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

    • export

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

    • export

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

    • export

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

    • export

      public Diagram export(com.structurizr.view.ContainerView view, Integer animationStep)

    • getBoundarySoftwareSystems

      protected List<com.structurizr.model.SoftwareSystem> getBoundarySoftwareSystems(com.structurizr.view.ModelView view)

    • export

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

    • export

      public Diagram export(com.structurizr.view.ComponentView view, Integer animationStep)

    • getBoundaryContainers

      protected List<com.structurizr.model.Container> getBoundaryContainers(com.structurizr.view.ModelView view)

    • export

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

    • export

      public Diagram export(com.structurizr.view.DynamicView view, String order)

    • export

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

    • export

      public Diagram export(com.structurizr.view.DeploymentView view, Integer animationStep)

    • writeElements

      protected void writeElements(com.structurizr.view.ModelView view, List<com.structurizr.model.GroupableElement> elements, IndentingWriter writer)

    • writeRelationships

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

    • writeHeader

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

    • writeFooter

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

    • startEnterpriseBoundary

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

    • endEnterpriseBoundary

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

    • startGroupBoundary

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

    • endGroupBoundary

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

    • startSoftwareSystemBoundary

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

    • endSoftwareSystemBoundary

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

    • startContainerBoundary

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

    • endContainerBoundary

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

    • startDeploymentNodeBoundary

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

    • endDeploymentNodeBoundary

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

    • writeElement

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

    • writeRelationship

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

    • isAnimationSupported

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

    • isVisible

      protected boolean isVisible(com.structurizr.view.ModelView view, com.structurizr.model.Element element)

    • isVisible

      protected boolean isVisible(com.structurizr.view.ModelView view, com.structurizr.view.RelationshipView relationshipView)

    • createDiagram

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

    • createLegend

      protected Legend createLegend(com.structurizr.view.ModelView view)

    • getViewOrViewSetProperty

      protected String getViewOrViewSetProperty(com.structurizr.view.ModelView view, String name, String defaultValue)