Liking cljdoc? Tell your friends :D

org.soulspace.overarch.core

Functions for the definition and handling of the overarch model.

Functions for the definition and handling of the overarch model.
raw docstring

aggregable-relation?clj

(aggregable-relation? r1 r2)
(aggregable-relation? m r1 r2)

Returns true, if the relations r1 and r2 are aggregable.

Returns true, if the relations `r1` and `r2` are aggregable.
sourceraw docstring

all-elementsclj

(all-elements)
(all-elements m)

Returns a set of all elements.

Returns a set of all elements.
sourceraw docstring

build-id->elementsclj

(build-id->elements coll)
(build-id->elements m coll)

Returns a map of id to element for the elements of the coll.

Returns a map of id to element for the elements of the `coll`.
sourceraw docstring

build-id->parentclj

(build-id->parent coll)
(build-id->parent m p coll)

Returns a map of child id to parent element for the elements in coll.

Returns a map of child id to parent element for the elements in `coll`.
sourceraw docstring

build-referred-id->relsclj

(build-referred-id->rels coll)
(build-referred-id->rels m coll)

Returns a map of referred-id to relation for the relations in coll.

Returns a map of referred-id to relation for the relations in `coll`.
sourceraw docstring

build-referrer-id->relsclj

(build-referrer-id->rels coll)
(build-referrer-id->rels m coll)

Returns a map of referrer-id to relation for the relations in coll.

Returns a map of referrer-id to relation for the relations in `coll`.
sourceraw docstring

build-registryclj

(build-registry elements)

Returns a map with the original elements and a registry by id for lookups.

The map has the following shape:

:elements -> the given data :registry -> a map from id to element :parents -> a map from id to parent element :referrer -> a map from id to set of relations where the id is the referrer (:from) :referred -> a map from id to set of relations where the id is referred (:to)

Returns a map with the original `elements` and a registry by id for lookups.

The map has the following shape:

:elements -> the given data
:registry -> a map from id to element
:parents  -> a map from id to parent element
:referrer -> a map from id to set of relations where the id is the referrer (:from)
:referred -> a map from id to set of relations where the id is referred (:to)
sourceraw docstring

c4-view-typesclj

C4 view types.

C4 view types.
sourceraw docstring

class-typesclj

Element types of a class view.

Element types of a class view.
sourceraw docstring

class-view-element?clj

(class-view-element? e)

Returns true if the given element e is rendered in a UML state view.

Returns true if the given element `e` is rendered in a UML state view.
sourceraw docstring

code-typesclj

Element types of a C4 code view.

Element types of a C4 code view.
sourceraw docstring

code-view-element?clj

(code-view-element? e)

Returns true if the given element e is rendered in a code view.

Returns true if the given element `e` is rendered in a code view.
sourceraw docstring

component-setclj

(component-set)
(component-set m)

Returns the set of model components.

Returns the set of model components.
sourceraw docstring

component-typesclj

Element types of a C4 component view.

Element types of a C4 component view.
sourceraw docstring

component-view-element?clj

(component-view-element? e)

Returns true if the given element e is rendered in a C4 component view.

Returns true if the given element `e` is rendered in a C4 component view.
sourceraw docstring

component?clj

(component? e)

Returns true if the given element e is a container element.

Returns true if the given element `e` is a container element.
sourceraw docstring

container-typesclj

Element types of a C4 container view.

Element types of a C4 container view.
sourceraw docstring

container-view-element?clj

(container-view-element? e)

Returns true if the given element e is rendered in a C4 container view.

Returns true if the given element `e` is rendered in a C4 container view.
sourceraw docstring

container?clj

(container? e)

Returns true if the given element e is a container element.

Returns true if the given element `e` is a container element.
sourceraw docstring

context-typesclj

Element types of a C4 context view.

Element types of a C4 context view.
sourceraw docstring

context-view-element?clj

(context-view-element? e)

Returns true if the given element e is rendered in a C4 context view.

Returns true if the given element `e` is rendered in a C4 context view.
sourceraw docstring

deployment-typesclj

Element types of a C4 deployment view.

Element types of a C4 deployment view.
sourceraw docstring

deployment-view-element?clj

(deployment-view-element? e)

Returns true if the given element e is rendered in a C4 deployment view.

Returns true if the given element `e` is rendered in a C4 deployment view.
sourceraw docstring

dynamic-typesclj

Element types of a C4 dynamic view.

Element types of a C4 dynamic view.
sourceraw docstring

dynamic-view-element?clj

(dynamic-view-element? e)

Returns true if the given element e is rendered in a C4 dynamic view.

Returns true if the given element `e` is rendered in a C4 dynamic view.
sourceraw docstring

external?clj

(external? e)

Returns true if the given element e is external.

Returns true if the given element `e` is external.
sourceraw docstring

get-model-elementclj

(get-model-element id)
(get-model-element m id)

Returns the model element with the given id.

Returns the model element with the given `id`.
sourceraw docstring

get-model-elementsclj

(get-model-elements)
(get-model-elements m)

Returns the collection of model elements.

Returns the collection of model elements.
sourceraw docstring

get-parent-elementclj

(get-parent-element e)
(get-parent-element m e)

Returns the parent of the element e.

Returns the parent of the element `e`.
sourceraw docstring

get-viewclj

(get-view id)
(get-view m id)

Returns the view with the given id.

Returns the view with the given id.
sourceraw docstring

get-viewsclj

(get-views)
(get-views m)

Returns the collection of views.

Returns the collection of views.
sourceraw docstring

identifiable?clj

(identifiable? e)

Returns true if the given element e has an ID.

Returns true if the given element `e` has an ID.
sourceraw docstring

model-element?clj

(model-element? e)

Returns true if the given element e is a model element.

Returns true if the given element `e` is a model element.
sourceraw docstring

model-elementsclj

(model-elements coll)

Filters the given collection of elements coll for model elements.

Filters the given collection of elements `coll` for model elements.
sourceraw docstring

model-typesclj

Element types for the architectural model.

Element types for the architectural model.
sourceraw docstring

node?clj

(node? e)

Returns true if the given element e is a node element.

Returns true if the given element `e` is a node element.
sourceraw docstring

person?clj

(person? e)

Returns true if the given element e is a person element.

Returns true if the given element `e` is a person element.
sourceraw docstring

read-elementsclj

(read-elements dir)

Reads the elements of data from the given directory dir.

Reads the elements of data from the given directory `dir`.
sourceraw docstring

reference-typesclj

Element types of references

Element types of references
sourceraw docstring

reference?clj

(reference? e)

Returns true if the given element e is a reference.

Returns true if the given element `e` is a reference.
sourceraw docstring

(related-elements coll)

Returns the set of elements that are part of at least one relation.

Returns the set of elements that are part of at least one relation.
sourceraw docstring

relation-typesclj

Element types of relations

Element types of relations
sourceraw docstring

relation?clj

(relation? e)

Returns true if the given element e is a relation.

Returns true if the given element `e` is a relation.
sourceraw docstring

resolve-refclj

(resolve-ref e)
(resolve-ref m e)

Resolves the model element for the ref e.

Resolves the model element for the ref `e`.
sourceraw docstring

stateclj

source

state-machine-typesclj

Element types of a state machine view.

Element types of a state machine view.
sourceraw docstring

state-machine-view-element?clj

(state-machine-view-element? e)

Returns true if the given element e is rendered in a UML state view.

Returns true if the given element `e` is rendered in a UML state view.
sourceraw docstring

system-landscape-typesclj

Element types of a C4 system-landscape view.

Element types of a C4 system-landscape view.
sourceraw docstring

system-landscape-view-element?clj

(system-landscape-view-element? e)

Returns true if the given element e is rendered in a C4 system landscape view.

Returns true if the given element `e` is rendered
in a C4 system landscape view.
sourceraw docstring

system?clj

(system? e)

Returns true if the given element e is a system element.

Returns true if the given element `e` is a system element.
sourceraw docstring

uml-relation-typesclj

Relation types of UML views.

Relation types of UML views.
sourceraw docstring

uml-typesclj

Element types of UML views.

Element types of UML views.
sourceraw docstring

uml-view-typesclj

UML view types.

UML view types.
sourceraw docstring

unconnected-componentsclj

(unconnected-components)
(unconnected-components m)

Returns the set of elements that are not connected with any other element by a relation.

Returns the set of elements that are not connected with any other element by a relation.
sourceraw docstring

update-state!clj

(update-state! dir)

Updates the state with the registered data read from dir.

Updates the state with the registered data read from `dir`.
sourceraw docstring

use-case-typesclj

Element types of a use case view.

Element types of a use case view.
sourceraw docstring

use-case-view-element?clj

(use-case-view-element? e)

Returns true if the given element e is rendered in a UML use case view.

Returns true if the given element `e` is rendered in a UML use case view.
sourceraw docstring

view-typesclj

View types.

View types.
sourceraw docstring

view?clj

(view? e)

Returns true if the given element e is a view.

Returns true if the given element `e` is a view.
sourceraw docstring

viewsclj

(views coll)

Filters the given collection of elements coll for views.

Filters the given collection of elements `coll` for views.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close