Package com.structurizr.view
Class DynamicView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.ModelView
com.structurizr.view.DynamicView
- All Implemented Interfaces:
PropertyHolder
A dynamic view, used to describe behaviour between static elements at runtime.
-
Method Summary
Modifier and TypeMethodDescriptionadd
(CustomElement source, CustomElement destination) add
(CustomElement source, StaticStructureElement destination) add
(CustomElement source, String description, CustomElement destination) add
(CustomElement source, String description, StaticStructureElement destination) add
(CustomElement source, String description, String technology, CustomElement destination) add
(CustomElement source, String description, String technology, StaticStructureElement destination) add
(Relationship relationship) Adds a specific relationship to this dynamic view, with the original description.add
(Relationship relationship, String description) Adds a specific relationship to this dynamic view, with an overidden description.add
(StaticStructureElement source, CustomElement destination) add
(StaticStructureElement source, StaticStructureElement destination) add
(StaticStructureElement source, String description, CustomElement destination) add
(StaticStructureElement source, String description, StaticStructureElement destination) add
(StaticStructureElement source, String description, String technology, CustomElement destination) add
(StaticStructureElement source, String description, String technology, StaticStructureElement destination) protected boolean
canBeRemoved
(Element element) protected void
checkElementCanBeAdded
(Element elementToBeAdded) void
void
endParallelSequence
(boolean endAllParallelSequencesAndContinueNumbering) Gets the ID of the software system or container associated with this view.boolean
Determines whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).getModel()
Gets the model that this view belongs to.getName()
Gets the (computed) name of this view.Gets the set of RelationshipView objects for this view, ordered by the order property.Gets the ID of the software system this view is associated with.void
setExternalBoundariesVisible
(boolean externalBoundariesVisible) Deprecated.void
toString()
Methods inherited from class com.structurizr.view.ModelView
addElement, addNearestNeighbours, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDimensions, getElements, getElementView, getMergeFromRemote, getPaperSize, getRelationshipView, getSoftwareSystem, 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. -
getSoftwareSystemId
Description copied from class:ModelView
Gets the ID of the software system this view is associated with.- Overrides:
getSoftwareSystemId
in classModelView
- 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
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, String description, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull StaticStructureElement source, String description, String technology, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull CustomElement source, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull CustomElement source, String description, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull CustomElement source, String description, String technology, @Nonnull StaticStructureElement destination) -
add
public RelationshipView add(@Nonnull StaticStructureElement source, @Nonnull CustomElement destination) -
add
public RelationshipView add(@Nonnull StaticStructureElement source, String description, @Nonnull CustomElement destination) -
add
public RelationshipView add(@Nonnull StaticStructureElement source, String description, String technology, @Nonnull CustomElement destination) -
add
-
add
public RelationshipView add(@Nonnull CustomElement source, String description, @Nonnull CustomElement destination) -
add
public RelationshipView add(@Nonnull CustomElement source, String description, String technology, @Nonnull CustomElement destination) -
add
Adds a specific relationship to this dynamic view, with the original description.- Parameters:
relationship
- the Relationship to add- Returns:
- a RelationshipView
-
add
Adds a specific relationship to this dynamic view, with an overidden description.- Parameters:
relationship
- the Relationship to adddescription
- the overidden description- Returns:
- a RelationshipView
-
getName
Gets the (computed) name of this view. -
toString
-
startParallelSequence
public void startParallelSequence() -
endParallelSequence
public void endParallelSequence() -
endParallelSequence
public void endParallelSequence(boolean endAllParallelSequencesAndContinueNumbering) -
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classModelView
-
canBeRemoved
- Specified by:
canBeRemoved
in classModelView
-
getRelationships
Gets the set of RelationshipView objects for this view, ordered by the order property.- Overrides:
getRelationships
in classModelView
- 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
Deprecated.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
-