Package com.structurizr.view
Class DeploymentView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.ModelView
com.structurizr.view.DeploymentView
- All Implemented Interfaces:
PropertyHolder
A deployment view, used to show the mapping of container instances to deployment nodes.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(ContainerInstance containerInstance) Adds a container instance (and its parent deployment nodes) to this view.void
add
(CustomElement customElement) Adds the given custom element to this view, including relationships to/from that custom element.void
add
(CustomElement customElement, boolean addRelationships) Adds the given custom element to this view.void
add
(DeploymentNode deploymentNode) Adds a deployment node to this view, including relationships to/from that deployment node (and children).void
add
(DeploymentNode deploymentNode, boolean addRelationships) Adds a deployment node to this view.void
add
(InfrastructureNode infrastructureNode) Adds an infrastructure node (and its parent deployment nodes) to this view.add
(Relationship relationship) Adds a Relationship to this view.void
add
(SoftwareSystemInstance softwareSystemInstance) Adds a software system instance (and its parent deployment nodes) to this view.void
Adds all of the top-level deployment nodes to this view, for the same deployment environment (if set).void
addAnimation
(InfrastructureNode... infrastructureNodes) Adds an animation step, with the specified infrastructure nodes.void
addAnimation
(StaticStructureElementInstance... elementInstances) Adds an animation step, with the specified element instances.void
addAnimation
(StaticStructureElementInstance[] elementInstances, InfrastructureNode[] infrastructureNodes) Adds an animation step, with the specified container instances and infrastructure nodes.void
Adds the default set of elements to this view.protected boolean
canBeRemoved
(Element element) protected void
checkElementCanBeAdded
(Element elementToBeAdded) Gets the name of the environment that this deployment view is for (e.g.getModel()
Gets the model that this view belongs to.getName()
Gets the (computed) name of this view.void
remove
(ContainerInstance containerInstance) Removes a container instance from this view.void
remove
(CustomElement customElement) Removes the given custom element from this view.void
remove
(DeploymentNode deploymentNode) Removes the given deployment node from this view.void
remove
(InfrastructureNode infrastructureNode) Removes an infrastructure node from this view.void
remove
(SoftwareSystemInstance softwareSystemInstance) Removes a software system instance from this view.void
setEnvironment
(String environment) Sets the name of the environment that this deployment view is for (e.g.Methods inherited from class com.structurizr.view.ModelView
addElement, addNearestNeighbours, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDimensions, getElements, getElementView, getMergeFromRemote, getPaperSize, getRelationships, getRelationshipView, getSoftwareSystem, getSoftwareSystemId, getViewSet, isElementInView, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDimensions, setLayoutMergeStrategy, setMergeFromRemote, setPaperSize
Methods inherited from class com.structurizr.view.View
addProperty, getDescription, getKey, getOrder, getProperties, getTitle, setDescription, setTitle
-
Method Details
-
getModel
Description copied from class:ModelView
Gets the model that this view belongs to. -
addDefaultElements
public void addDefaultElements()Adds the default set of elements to this view. -
addAllDeploymentNodes
public void addAllDeploymentNodes()Adds all of the top-level deployment nodes to this view, for the same deployment environment (if set). -
add
Adds a deployment node to this view, including relationships to/from that deployment node (and children).- Parameters:
deploymentNode
- the DeploymentNode to add
-
add
Adds a deployment node to this view.- Parameters:
deploymentNode
- the DeploymentNode to addaddRelationships
- whether to add relationships to/from the person
-
add
Adds an infrastructure node (and its parent deployment nodes) to this view.- Parameters:
infrastructureNode
- the InfrastructureNode to add
-
add
Adds a software system instance (and its parent deployment nodes) to this view.- Parameters:
softwareSystemInstance
- the SoftwareSystemInstance to add
-
add
Adds a container instance (and its parent deployment nodes) to this view.- Parameters:
containerInstance
- the ContainerInstance to add
-
remove
Removes the given deployment node from this view.- Parameters:
deploymentNode
- the DeploymentNode to be removed
-
remove
Removes an infrastructure node from this view.- Parameters:
infrastructureNode
- the InfrastructureNode to be removed
-
remove
Removes a software system instance from this view.- Parameters:
softwareSystemInstance
- the SoftwareSystemInstance to be removed
-
remove
Removes a container instance from this view.- Parameters:
containerInstance
- the ContainerInstance to be removed
-
add
Adds a Relationship to this view.- Parameters:
relationship
- the Relationship to be added- Returns:
- a RelationshipView object representing the relationship added
-
getName
Gets the (computed) name of this view. -
getEnvironment
Gets the name of the environment that this deployment view is for (e.g. "Development", "Live", etc).- Returns:
- the environment name, as a String
-
setEnvironment
Sets the name of the environment that this deployment view is for (e.g. "Development", "Live", etc).- Parameters:
environment
- the environment name, as a String
-
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classModelView
-
canBeRemoved
- Specified by:
canBeRemoved
in classModelView
-
addAnimation
Adds an animation step, with the specified infrastructure nodes.- Parameters:
infrastructureNodes
- the infrastructure nodes that should be shown in the animation step
-
addAnimation
Adds an animation step, with the specified element instances.- Parameters:
elementInstances
- the element instances that should be shown in the animation step
-
addAnimation
public void addAnimation(StaticStructureElementInstance[] elementInstances, InfrastructureNode[] infrastructureNodes) Adds an animation step, with the specified container instances and infrastructure nodes.- Parameters:
elementInstances
- the element instances that should be shown in the animation stepinfrastructureNodes
- the container infrastructure nodes that should be shown in the animation step
-
getAnimations
-
add
Adds the given custom element to this view, including relationships to/from that custom element.- Parameters:
customElement
- the CustomElement to add
-
add
Adds the given custom element to this view.- Parameters:
customElement
- the CustomElement to addaddRelationships
- whether to add relationships to/from the custom element
-
remove
Removes the given custom element from this view.- Parameters:
customElement
- the CustomElement to add
-