Package com.structurizr.view
Class DynamicView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.DynamicView
public final class DynamicView extends View
A dynamic view, used to describe behaviour between static elements at runtime.
-
Method Summary
Modifier and Type Method Description RelationshipView
add(StaticStructureElement source, StaticStructureElement destination)
RelationshipView
add(StaticStructureElement source, java.lang.String description, StaticStructureElement destination)
RelationshipView
add(StaticStructureElement source, java.lang.String description, java.lang.String technology, StaticStructureElement destination)
protected RelationshipView
addRelationship(Relationship relationship, java.lang.String description, java.lang.String order, boolean response)
protected boolean
canBeRemoved(Element element)
protected void
checkElementCanBeAdded(Element elementToBeAdded)
void
endParallelSequence()
void
endParallelSequence(boolean endAllParallelSequencesAndContinueNumbering)
Element
getElement()
java.lang.String
getElementId()
Gets the ID of the software system or container associated with this view.boolean
getExternalBoundariesVisible()
Determines whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).Model
getModel()
Gets the model that this view belongs to.java.lang.String
getName()
Gets the (computed) name of this view.java.util.Set<RelationshipView>
getRelationships()
Gets the set of RelationshipView objects for this view, ordered by the order property.java.lang.String
getSoftwareSystemId()
Gets the ID of the software system this view is associated with.void
setExternalBoundariesVisible(boolean externalBoundariesVisible)
Sets whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).void
startParallelSequence()
java.lang.String
toString()
Methods inherited from class com.structurizr.view.View
add, add, addElement, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDescription, getElements, getElementView, getKey, getPaperSize, getRelationshipView, getSoftwareSystem, getTitle, getViewSet, isElementInView, remove, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDescription, setLayoutMergeStrategy, setPaperSize, setTitle
-
Method Details
-
getModel
Description copied from class:View
Gets the model that this view belongs to. -
getSoftwareSystemId
public java.lang.String getSoftwareSystemId()Description copied from class:View
Gets the ID of the software system this view is associated with.- Overrides:
getSoftwareSystemId
in classView
- Returns:
- the ID, as a String, or null if this view is not associated with a software system (e.g. it's a system landscape view)
-
getElementId
public java.lang.String getElementId()Gets the ID of the software system or container associated with this view.- Returns:
- the ID, as a String, or null if not set
-
getElement
-
add
public RelationshipView add(@Nonnull StaticStructureElement source, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull StaticStructureElement source, java.lang.String description, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull StaticStructureElement source, java.lang.String description, java.lang.String technology, @Nonnull StaticStructureElement destination) -
addRelationship
protected RelationshipView addRelationship(Relationship relationship, java.lang.String description, java.lang.String order, boolean response) -
getName
public java.lang.String getName()Gets the (computed) name of this view. -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
startParallelSequence
public void startParallelSequence() -
endParallelSequence
public void endParallelSequence() -
endParallelSequence
public void endParallelSequence(boolean endAllParallelSequencesAndContinueNumbering) -
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classView
-
canBeRemoved
- Specified by:
canBeRemoved
in classView
-
getRelationships
Gets the set of RelationshipView objects for this view, ordered by the order property.- Overrides:
getRelationships
in classView
- Returns:
- an ordered set of RelationshipView objects
-
getExternalBoundariesVisible
public boolean getExternalBoundariesVisible()Determines whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).- Returns:
- true if external boundaries are visible, false otherwise
-
setExternalBoundariesVisible
public void setExternalBoundariesVisible(boolean externalBoundariesVisible)Sets whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).- Parameters:
externalBoundariesVisible
- true if external boundaries should be visible, false otherwise
-