Package com.structurizr.view

Class SystemContextView

java.lang.Object

com.structurizr.view.View

com.structurizr.view.StaticView

com.structurizr.view.SystemContextView

public final class SystemContextView
extends StaticView

Represents the System Context view from the C4 model, showing how a software system fits into its environment, in terms of the users (people) and other software system dependencies.

Method Summary

Modifier and Type	Method	Description
void	addAllElements()	Adds all software systems and all people.
void	addDefaultElements()	Adds the default set of elements to this view.
void	addNearestNeighbours(Element element)	Adds all software systems and people that are directly connected to the specified element.
protected boolean	canBeRemoved(Element element)
java.lang.String	getName()	Gets the (computed) name of this view.
boolean	isEnterpriseBoundaryVisible()	Determines whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.
void	setEnterpriseBoundaryVisible(boolean enterpriseBoundaryVisible)	Sets whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.

Methods inherited from class com.structurizr.view.StaticView

add, add, add, add, add, addAllPeople, addAllSoftwareSystems, addAnimation, addNearestNeighbours, getAnimations, remove, remove, removeElementsThatAreUnreachableFrom, removeElementsWithTag, removeRelationshipsWithTag

Methods inherited from class com.structurizr.view.View

addElement, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDescription, getElements, getElementView, getKey, getModel, getPaperSize, getRelationships, getRelationshipView, getSoftwareSystem, getSoftwareSystemId, getTitle, getViewSet, isElementInView, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDescription, setLayoutMergeStrategy, setPaperSize, setTitle

Methods inherited from class java.lang.Object

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

Method Details

getName

public java.lang.String getName()

Gets the (computed) name of this view.

Specified by:

getName in class View

Returns:

the name, as a String

addDefaultElements

public void addDefaultElements()

Adds the default set of elements to this view.

Specified by:

addDefaultElements in class StaticView

addAllElements

public void addAllElements()

Adds all software systems and all people.

Specified by:

addAllElements in class StaticView

addNearestNeighbours

public void addNearestNeighbours(@Nonnull Element element)

Adds all software systems and people that are directly connected to the specified element.

Specified by:

addNearestNeighbours in class StaticView

Parameters:

element - an Element

isEnterpriseBoundaryVisible

public boolean isEnterpriseBoundaryVisible()

Determines whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.

Returns:

true if the enterprise boundary is visible, false otherwise

setEnterpriseBoundaryVisible

public void setEnterpriseBoundaryVisible(boolean enterpriseBoundaryVisible)

Sets whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.

Parameters:

enterpriseBoundaryVisible - true if the enterprise boundary should be visible, false otherwise

canBeRemoved

protected boolean canBeRemoved(Element element)

Specified by:

canBeRemoved in class View