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(Element source, Element destination)
RelationshipView	add(Element source, java.lang.String description, Element destination)
protected boolean	canBeRemoved(Element element)
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.
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	startParallelSequence()
java.lang.String	toString()

Methods inherited from class com.structurizr.view.View

addElement, addRelationship, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDescription, getElements, getElementView, getKey, getPaperSize, getRelationshipView, getSoftwareSystem, 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, wait, wait, wait

Method Details

getModel

public Model getModel()

Description copied from class: View

Gets the model that this view belongs to.

Overrides:

getModel in class View

Returns:

a Model object

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

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

public Element getElement()

add

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

add

public RelationshipView add(@Nonnull Element source, java.lang.String description, @Nonnull Element destination)

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

startParallelSequence

public void startParallelSequence()

endParallelSequence

public void endParallelSequence()

endParallelSequence

public void endParallelSequence(boolean endAllParallelSequencesAndContinueNumbering)

canBeRemoved

protected boolean canBeRemoved(Element element)

Specified by:

canBeRemoved in class View

getRelationships

public java.util.Set<RelationshipView> getRelationships()

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

Overrides:

getRelationships in class View

Returns:

an ordered set of RelationshipView objects