org.soulspace.overarch.core

Liking cljdoc? Tell your friends :D

Clojure only.

aggregable-relation?
all-elements
build-id->elements
build-id->parent
build-referred-id->rels
build-referrer-id->rels
build-registry
c4-view-types
class-types
class-view-element?
code-types
code-view-element?
component-set
component-types
component-view-element?
component?
concept-types
concept-view-element?
concept-view-types
container-types
container-view-element?
container?
context-types
context-view-element?
deployment-types
deployment-view-element?
dynamic-types
dynamic-view-element?
element?
external?
get-model-element
get-model-elements
get-parent-element
get-view
get-views
glossary-view-element?
id-set
identifiable-element?
identifiable-named-element?
model-element?
model-elements
model-types
named-element?
named-relational-element?
node?
person?
read-elements
reference-types
reference?
related-elements
relation-types
relation?
relational-element?
resolve-ref
state
state-machine-types
state-machine-view-element?
system-landscape-types
system-landscape-view-element?
system?
uml-relation-types
uml-types
uml-view-types
unconnected-components
update-state!
use-case-types
use-case-view-element?
view-types
view?
views

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.

source raw docstring

all-elements^clj

(all-elements)

(all-elements m)

Returns a set of all elements.

Returns a set of all elements.

source raw docstring

build-id->elements^clj

(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`.

source raw docstring

build-id->parent^clj

(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`.

source raw docstring

build-referred-id->rels^clj

(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`.

source raw docstring

build-referrer-id->rels^clj

(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`.

source raw docstring

build-registry^clj

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

source raw docstring

c4-view-types^clj

C4 view types.

C4 view types.

source raw docstring

class-types^clj

Element types of a class view.

Element types of a class view.

source raw 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.

source raw docstring

code-types^clj

Element types of a C4 code view.

Element types of a C4 code view.

source raw 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.

source raw docstring

component-set^clj

(component-set)

(component-set m)

Returns the set of model components.

Returns the set of model components.

source raw docstring

component-types^clj

Element types of a C4 component view.

Element types of a C4 component view.

source raw 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.

source raw 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.

source raw docstring

concept-types^clj

Element types of a glossary view.

Element types of a glossary view.

source raw docstring

concept-view-element?^clj

(concept-view-element? e)

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

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

source raw docstring

concept-view-types^clj

Concept views types.

Concept views types.

source raw docstring

container-types^clj

Element types of a C4 container view.

Element types of a C4 container view.

source raw 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.

source raw 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.

source raw docstring

context-types^clj

Element types of a C4 context view.

Element types of a C4 context view.

source raw 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.

source raw docstring

deployment-types^clj

Element types of a C4 deployment view.

Element types of a C4 deployment view.

source raw 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.

source raw docstring

dynamic-types^clj

Element types of a C4 dynamic view.

Element types of a C4 dynamic view.

source raw 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.

source raw docstring

element?^clj

(element? e)

Returns true if the given element e has a type (:el key).

Returns true if the given element `e` has a type (:el key).

source raw docstring

external?^clj

(external? e)

Returns true if the given element e is external.

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

source raw docstring

get-model-element^clj

(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`.

source raw docstring

get-model-elements^clj

(get-model-elements)

(get-model-elements m)

Returns the collection of model elements.

Returns the collection of model elements.

source raw docstring

get-parent-element^clj

(get-parent-element e)

(get-parent-element m e)

Returns the parent of the element e.

Returns the parent of the element `e`.

source raw docstring

get-view^clj

(get-view id)

(get-view m id)

Returns the view with the given id.

Returns the view with the given id.

source raw docstring

get-views^clj

(get-views)

(get-views m)

Returns the collection of views.

Returns the collection of views.

source raw docstring

glossary-view-element?^clj

(glossary-view-element? e)

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

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

source raw docstring

id-set^clj

(id-set coll)

Returns a set of id's for the elements in coll.

Returns a set of id's for the elements in `coll`.

source raw docstring

identifiable-element?^clj

(identifiable-element? e)

Returns true if the given element e has an ID (:id key).

Returns true if the given element `e` has an ID (:id key).

source raw docstring

identifiable-named-element?^clj

(identifiable-named-element? e)

Returns true if the given element e is identifiable and named.

Returns true if the given element `e` is identifiable and named.

source raw 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.

source raw docstring

model-elements^clj

(model-elements coll)

Filters the given collection of elements coll for model elements.

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

source raw docstring

model-types^clj

Element types for the architectural model.

Element types for the architectural model.

source raw docstring

named-element?^clj

(named-element? e)

Returns true if the given element e has a name (:name key).

Returns true if the given element `e` has a name (:name key).

source raw docstring

named-relational-element?^clj

(named-relational-element? e)

Returns true if the given element e is a named relation.

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

source raw 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.

source raw 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.

source raw docstring

read-elements^clj

(read-elements dir)

Reads the elements of data from the given directory dir.

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

source raw docstring

reference-types^clj

Element types of references

Element types of references

source raw 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.

source raw 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.

source raw docstring

relation-types^clj

Element types of relations

Element types of relations

source raw 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.

source raw docstring

relational-element?^clj

(relational-element? e)

Returns true if the given element e is a relation.

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

source raw docstring

resolve-ref^clj

(resolve-ref e)

(resolve-ref m e)

Resolves the model element for the ref e.

Resolves the model element for the ref `e`.

source raw docstring

state^clj

source

state-machine-types^clj

Element types of a state machine view.

Element types of a state machine view.

source raw 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.

source raw docstring

system-landscape-types^clj

Element types of a C4 system-landscape view.

Element types of a C4 system-landscape view.

source raw 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.

source raw 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.

source raw docstring

uml-relation-types^clj

Relation types of UML views.

Relation types of UML views.

source raw docstring

uml-types^clj

Element types of UML views.

Element types of UML views.

source raw docstring

uml-view-types^clj

UML view types.

UML view types.

source raw docstring

unconnected-components^clj

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

source raw 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`.

source raw docstring

use-case-types^clj

Element types of a use case view.

Element types of a use case view.

source raw 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.

source raw docstring

view-types^clj

View types.

View types.

source raw 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.

source raw docstring

views^clj

(views coll)

Filters the given collection of elements coll for views.

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

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close