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

public final class DynamicView
extends ModelView

A dynamic view, used to describe behaviour between static elements at runtime.

Method Summary

Modifier and Type	Method	Description
RelationshipView	add(CustomElement source, CustomElement destination)
RelationshipView	add(CustomElement source, StaticStructureElement destination)
RelationshipView	add(CustomElement source, String description, CustomElement destination)
RelationshipView	add(CustomElement source, String description, StaticStructureElement destination)
RelationshipView	add(CustomElement source, String description, String technology, CustomElement destination)
RelationshipView	add(CustomElement source, String description, String technology, StaticStructureElement destination)
RelationshipView	add(Relationship relationship)	Adds a specific relationship to this dynamic view, with the original description.
RelationshipView	add(Relationship relationship, String description)	Adds a specific relationship to this dynamic view, with an overidden description.
RelationshipView	add(StaticStructureElement source, CustomElement destination)
RelationshipView	add(StaticStructureElement source, StaticStructureElement destination)
RelationshipView	add(StaticStructureElement source, String description, CustomElement destination)
RelationshipView	add(StaticStructureElement source, String description, StaticStructureElement destination)
RelationshipView	add(StaticStructureElement source, String description, String technology, CustomElement destination)
RelationshipView	add(StaticStructureElement source, String description, String technology, StaticStructureElement destination)
protected RelationshipView	addRelationship(Relationship relationship, String description, String order, boolean response)
protected boolean	canBeRemoved(Element element)
protected void	checkElementCanBeAdded(Element elementToBeAdded)
void	endParallelSequence()
void	endParallelSequence(boolean endAllParallelSequencesAndContinueNumbering)
Element	getElement()
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.
String	getName()	Gets the (computed) name of this view.
Set<RelationshipView>	getRelationships()	Gets the set of RelationshipView objects for this view, ordered by the order property.
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()
String	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

Methods inherited from class java.lang.Object

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

Method Details

getModel

public Model getModel()

Description copied from class: ModelView

Gets the model that this view belongs to.

Overrides:

getModel in class ModelView

Returns:

a Model object

getSoftwareSystemId

public String getSoftwareSystemId()

Description copied from class: ModelView

Gets the ID of the software system this view is associated with.

Overrides:

getSoftwareSystemId in class ModelView

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 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

public Element 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

public RelationshipView add(@Nonnull
 CustomElement source,
 @Nonnull
 CustomElement destination)

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

public RelationshipView add(Relationship relationship)

Adds a specific relationship to this dynamic view, with the original description.

Parameters:

relationship - the Relationship to add

Returns:

a RelationshipView

add

public RelationshipView add(Relationship relationship,
 String description)

Adds a specific relationship to this dynamic view, with an overidden description.

Parameters:

relationship - the Relationship to add

description - the overidden description

Returns:

a RelationshipView

addRelationship

protected RelationshipView addRelationship(Relationship relationship,
 String description,
 String order,
 boolean response)

getName

public String getName()

Gets the (computed) name of this view.

Specified by:

getName in class View

Returns:

the name, as a String

toString

public String toString()

Overrides:

toString in class Object

startParallelSequence

public void startParallelSequence()

endParallelSequence

public void endParallelSequence()

endParallelSequence

public void endParallelSequence(boolean endAllParallelSequencesAndContinueNumbering)

checkElementCanBeAdded

protected void checkElementCanBeAdded(Element elementToBeAdded)

Specified by:

checkElementCanBeAdded in class ModelView

canBeRemoved

protected boolean canBeRemoved(Element element)

Specified by:

canBeRemoved in class ModelView

getRelationships

public Set<RelationshipView> getRelationships()

Gets the set of RelationshipView objects for this view, ordered by the order property.

Overrides:

getRelationships in class ModelView

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