Liking cljdoc? Tell your friends :D
Clojure only.

org.soulspace.overarch.domain.element

This namespace contains element specific logic. It defines the different element categories of model elements and views and the hierarchical relationships. The namespace also defines predicates to query the elements and functionality requiring only elements or collections of elements without references to the model as a whole.

This namespace contains element specific logic.
It defines the different element categories of model elements and views
and the hierarchical relationships. The namespace also defines predicates
to query the elements and functionality requiring only elements or collections
of elements without references to the model as a whole.
raw docstring

all-tags?clj

(all-tags? v e)

Returns true if all of the tags in v are tags of e.

Returns true if all of the tags in `v` are tags of `e`.
sourceraw docstring

all-techs?clj

(all-techs? v e)

Returns true if all of the technologies in v are technologies of e.

Returns true if all of the technologies in `v` are technologies of `e`.
sourceraw docstring

architecture-dependency-relation-typesclj

source

architecture-node-typesclj

Node types in the architecture model.

Node types in the architecture model.
sourceraw docstring

architecture-node?clj

(architecture-node? e)

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

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

architecture-relation-typesclj

Relation types in the architecture model.

Relation types in the architecture model.
sourceraw docstring

architecture-relation?clj

(architecture-relation? e)

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

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

boundary-typesclj

Element types of boundaries.

Element types of boundaries.
sourceraw docstring

boundary?clj

(boundary? e)

Returns true if e is a boundary.

Returns true if `e` is a boundary.
sourceraw docstring

c4-view-typesclj

The set of C4 view types.

The set of C4 view types.
sourceraw docstring

child?clj

(child? e p)

Returns true, if element e is a child of model element p.

Returns true, if element `e` is a child of model element `p`.
sourceraw docstring

childrenclj

(children e)

Returns the children of the element e.

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

class-model-node?clj

(class-model-node? e)

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

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

class-model-relation?clj

(class-model-relation? e)

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

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

class-node-typesclj

Node types for class models.

Node types for class models.
sourceraw docstring

class-relation-typesclj

Relation types for class models.

Relation types for class models.
sourceraw docstring

class-view-element-typesclj

Element types of a class view.

Element types of a class view.
sourceraw docstring

code-view-element-typesclj

Element types of a C4 code view.

Element types of a C4 code view.
sourceraw docstring

collect-fieldsclj

(collect-fields coll)

Returns the fields of all classes in the coll.

Returns the fields of all classes in the `coll`.
sourceraw docstring

collect-methodsclj

(collect-methods coll)

Returns the methods of all classes in the coll.

Returns the methods of all classes in the `coll`.
sourceraw docstring

collect-technologiesclj

(collect-technologies coll)

Returns the set of technologies for the elements of the coll.

Returns the set of technologies for the elements of the coll.
sourceraw docstring

component-view-element-typesclj

Element types of a C4 component view.

Element types of a C4 component view.
sourceraw docstring

concept-model-node?clj

(concept-model-node? e)

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

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

concept-model-relation?clj

(concept-model-relation? e)

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

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

concept-node-typesclj

Node types for concept models.

Node types for concept models.
sourceraw docstring

concept-relation-typesclj

Relation types of concept models.

Relation types of concept models.
sourceraw docstring

concept-view-element-typesclj

Element types of a concept view.

Element types of a concept view.
sourceraw docstring

concept-view-typesclj

The set of concept views types.

The set of concept views types.
sourceraw docstring

container-view-element-typesclj

Element types of a C4 container view.

Element types of a C4 container view.
sourceraw docstring

context-view-element-typesclj

Element types of a C4 context view.

Element types of a C4 context view.
sourceraw docstring

deployment-node-typesclj

Node types for deployment models.

Node types for deployment models.
sourceraw docstring

deployment-node?clj

(deployment-node? e)

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

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

deployment-relation-typesclj

Relation types for deployment models.

Relation types for deployment models.
sourceraw docstring

deployment-relation?clj

(deployment-relation? e)

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

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

deployment-view-element-typesclj

Element types of a C4 deployment view.

Element types of a C4 deployment view.
sourceraw docstring

desc-check?clj

(desc-check? v e)

Returns true if the check for desc on e equals the boolean value v

Returns true if the check for desc on `e` equals the boolean value `v`
sourceraw docstring

desc?clj

(desc? v e)

Returns true if the description of e matches the regular expressionv.

Returns true if the description of `e` matches the regular expression`v`.
sourceraw docstring

difference-by-idclj

(difference-by-id base-set & sets)

Returns a set of elements that is the difference of the base-set and the rest of the sets. Equality is based on the id (:id key) of the element maps in the sets, not on value equality of the maps (entity equality vs. value equality).

Returns a set of elements that is the difference of the `base-set` and the rest of the `sets`.
Equality is based on the id (:id key) of the element maps in the sets, not on value equality of the maps (entity equality vs. value equality).
sourceraw docstring

dynamic-view-element-typesclj

Element types of a C4 dynamic view.

Element types of a C4 dynamic view.
sourceraw docstring

el?clj

(el? v e)

Returns true if the element type of e is equal to v.

Returns true if the element type of `e` is equal to `v`.
sourceraw docstring

element->refclj

(element->ref e)

Returns a ref for the element e, if it is identifiable.

Returns a ref for the element `e`, if it is identifiable.
sourceraw docstring

element-hierarchyclj

Hierarchy for rendering methods.

Hierarchy for rendering methods.
sourceraw docstring

element-nameclj

(element-name e)

Returns the name of the element e.

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

element-namespaceclj

(element-namespace e)

Returns the namespace of the element e.

Returns the namespace of the element `e`.
sourceraw 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).
sourceraw docstring

elements-by-namespaceclj

(elements-by-namespace coll)

Returns the elements of the coll grouped by namespace.

Returns the elements of the `coll` grouped by namespace.
sourceraw docstring

els?clj

(els? v e)

Returns true if the element type of e is contained in v.

Returns true if the element type of `e` is contained in `v`.
sourceraw docstring

external-check?clj

(external-check? v e)

Returns true if the check for external on e equals the boolean value v

Returns true if the check for external on `e` equals the boolean value `v`
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

from-namespace-prefix?clj

(from-namespace-prefix? v e)

Returns true, if vis a prefix of the namespace of element referenced by the from id of relation e.

Returns true, if `v`is a prefix of the namespace of element referenced by the from id of relation `e`.
sourceraw docstring

from-namespace?clj

(from-namespace? v e)

Returns true, if vis the namespace of the element referenced by the from id of relation e.

Returns true, if `v`is the namespace of the element referenced by the from id of relation `e`.
sourceraw docstring

from-namespaces?clj

(from-namespaces? v e)

Returns true, if the set of namespaces v contains the namespace of the from id of relation e.

Returns true, if the set of namespaces `v` contains the namespace of the from id of relation `e`.
sourceraw docstring

from?clj

(from? v e)

Returns true if the from id of the relation e is equal to v.

Returns true if the from id of the relation `e` is equal to `v`.
sourceraw docstring

generate-node-idclj

(generate-node-id e p)

Generates an identifier for element e based on the id of the parent p.

The generated id takes the id of p as prefix and appends the lowercase name of e and the element type of e separated by a hyphen.

Generates an identifier for element `e` based on the id of the parent `p`.

The generated id takes the id of `p` as prefix and appends the lowercase
name of `e` and the element type of `e` separated by a hyphen.
sourceraw docstring

generate-relation-idclj

(generate-relation-id {:keys [el from to]})
(generate-relation-id el from to)

Generates an identifier for a relation r.

The generated id takes the id of the referrer as prefix and appends the relation type of the relation and the name part of the referred id separated by a hyphen.

Generates an identifier for a relation `r`.

The generated id takes the id of the referrer as prefix and appends the relation type
of the relation and the name part of the referred id separated by a hyphen.
sourceraw docstring

glossary-view-element-typesclj

Element types of a glossary view.

Element types of a glossary view.
sourceraw docstring

hierarchical-view-typesclj

The set of hierarchical view types.

The set of hierarchical view types.
sourceraw docstring

hierarchical-view?clj

(hierarchical-view? e)

Returns true if the given element e is a hierarchical view.

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

idclj

(id e)

Returns the id of the element or ref e.

Returns the id of the element or ref `e`.
sourceraw docstring

id->elementclj

(id->element)
(id->element acc)
(id->element acc e)

Step function to create an id to element map. Adds the association of the id of the element e to the map acc.

Step function to create an id to element map.
Adds the association of the id of the element `e` to the map `acc`.
sourceraw docstring

id->element-mapclj

(id->element-map elements)

Returns am map of id -> element for the given elements.

Returns am map of id -> element for the given `elements`.
sourceraw docstring

id->parentclj

(id->parent)
(id->parent [res ctx])
(id->parent [res ctx] e)

Step function to create an id to parent element map. Adds the association from the id of element e to the parent p to the map acc. Uses a list as stack in the accumulator to manage the context of the current element e in the traversal of the tree.

Step function to create an id to parent element map.
Adds the association from the id of element `e` to the parent `p` to the map `acc`.
Uses a list as stack in the accumulator to manage the context of the current element `e`
in the traversal of the tree.
sourceraw docstring

id-check?clj

(id-check? v e)

Returns true if the check for id on e equals the boolean value v

Returns true if the check for id on `e` equals the boolean value `v`
sourceraw docstring

id?clj

(id? v e)

Returns true if the id of e is equal to v.

Returns true if the id of `e` is equal to `v`.
sourceraw docstring

identifiable-element?clj

(identifiable-element? e)

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

Returns true if the given element `e` is an element and named.
sourceraw docstring

identifiable-named-element?clj

(identifiable-named-element? e)

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

Returns true if the given element `e` is an element, identifiable and named.
sourceraw docstring

identifiable-relational-element?clj

(identifiable-relational-element? e)

Returns true if the given element e is an identifiable relation.

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

identifiable?clj

(identifiable? 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).
sourceraw docstring

ids-xfclj

Returns a transducer to extract the id of each element.

Returns a transducer to extract the id of each element.
sourceraw docstring

internal?clj

(internal? e)

Returns true if the given element e is internal.

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

key->elementclj

(key->element k)

Returns a step function to create an key k to element map. Adds the association of the id of the element e to the map acc.

Returns a step function to create an key `k` to element map.
Adds the association of the id of the element `e` to the map `acc`.
sourceraw docstring

key-check?clj

(key-check? [k v] e)

Returns true if the check for the key k on element e equals the boolean value v. Useful to check for custom keys.

Returns true if the check for the key `k` on element `e` equals the boolean value `v`.
Useful to check for custom keys.
sourceraw docstring

key?clj

(key? [k v] e)

Returns true if the check for entry on element e equals the boolean value `v.

Returns true if the check for `entry` on element `e` equals the boolean value `v.
sourceraw docstring

model-element-typesclj

Element types for the model.

Element types for the model.
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-node-typesclj

Node types of the model.

Node types of the model.
sourceraw docstring

model-node?clj

(model-node? e)

Returns true if the given element is a node in the model element graph. A model node is a model element which is not a relation.

Returns true if the given element is a node in the model element graph.
A model node is a model element which is not a relation.
sourceraw docstring

model-relation-typesclj

Relation types of the model.

Relation types of the model.
sourceraw docstring

model-relation?clj

(model-relation? e)

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

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

name-check?clj

(name-check? v e)

Returns true if the check for name on e equals the boolean value v

Returns true if the check for name on `e` equals the boolean value `v`
sourceraw docstring

name-prefix?clj

(name-prefix? v e)

Returns true if the name of e starts with v.

Returns true if the name of `e` starts with `v`.
sourceraw docstring

name?clj

(name? v e)

Returns true if the name of e matches v.

Returns true if the name of `e` matches `v`.
sourceraw docstring

named-element?clj

(named-element? e)

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

Returns true if the given element `e` is an element and named.
sourceraw 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.
sourceraw docstring

named?clj

(named? 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).
sourceraw docstring

namespace-prefix?clj

(namespace-prefix? v e)

Returns true, if vis a prefix of the namespace of element e.

Returns true, if `v`is a prefix of the namespace of element `e`.
sourceraw docstring

namespace?clj

(namespace? v e)

Returns true, if vis the namespace of element e.

Returns true, if `v`is the namespace of element `e`.
sourceraw docstring

namespaced?clj

(namespaced? e)

Returns true, if the id of element e has a namespace.

Returns true, if the id of element `e` has a namespace.
sourceraw docstring

namespaces-xfclj

Returns a transducer to extract the namespaces of some elements.

Returns a transducer to extract the namespaces of some elements.
sourceraw docstring

namespaces?clj

(namespaces? v e)

Returns true, if the set of namespaces v contains the namespace of element e.

Returns true, if the set of namespaces `v` contains the namespace of element `e`.
sourceraw docstring

node-ids-xfclj

Returns a transducer to extract the id of each node.

Returns a transducer to extract the id of each node.
sourceraw docstring

node-of?clj

(node-of? kind e)

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

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

parent-check?clj

(parent-check? v e)

Returns true if the check for children of e equals the boolean value v

Returns true if the check for children of `e` equals the boolean value `v`
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

referred-id->relationclj

(referred-id->relation)
(referred-id->relation acc)
(referred-id->relation acc e)

Step function to create an map of referred ids to relations. Adds the relation r to the set associated with the id of the :to reference in the map acc.

Step function to create an map of referred ids to relations.
Adds the relation `r` to the set associated with the id of the :to reference in the map `acc`.
sourceraw docstring

referrer-id->relationclj

(referrer-id->relation)
(referrer-id->relation acc)
(referrer-id->relation acc e)

Step function to create an map of referrer ids to relations. Adds the relation r to the set associated with the id of the :from reference in the map acc.

Step function to create an map of referrer ids to relations.
Adds the relation `r` to the set associated with the id of the :from reference in the map `acc`.
sourceraw docstring

relation-of?clj

(relation-of? kind e)

Returns true if the given element e is a relation of kind.

Returns true if the given element `e` is a relation of `kind`.
sourceraw 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.
sourceraw docstring

relational?clj

(relational? e)

Returns true if the given element e is a relation.

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

state-machine-view-element-typesclj

Element types of a state machine view.

Element types of a state machine view.
sourceraw docstring

statemachine-node-typesclj

Node types for statemachine models.

Node types for statemachine models.
sourceraw docstring

statemachine-node?clj

(statemachine-node? e)

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

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

statemachine-relation-typesclj

Relation types for statemachine models.

Relation types for statemachine models.
sourceraw docstring

statemachine-relation?clj

(statemachine-relation? e)

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

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

subtype-check?clj

(subtype-check? v e)

Returns true if the check for subtype on e equals the boolean value v

Returns true if the check for subtype on `e` equals the boolean value `v`
sourceraw docstring

subtype?clj

(subtype? v e)

Returns true if the subtype of e is equal to v.

Returns true if the subtype of `e` is equal to `v`.
sourceraw docstring

subtypes?clj

(subtypes? v e)

Returns true if the subtype of e is contained in v.

Returns true if the subtype of `e` is contained in `v`.
sourceraw docstring

synthetic?clj

(synthetic? e)

Returns true, if the element e is a synthetic element.

Returns true, if the element `e` is a synthetic element.
sourceraw docstring

system-landscape-view-element-typesclj

Element types of a C4 system-landscape view.

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

tag?clj

(tag? v e)

Returns true if v is a tag of e.

Returns true if `v` is a tag of `e`.
sourceraw docstring

tags-check?clj

(tags-check? v e)

Returns true if the check for tags on e equals the boolean value v

Returns true if the check for tags on `e` equals the boolean value `v`
sourceraw docstring

tags?clj

(tags? v e)

Returns true if any of the tags in v are tags of e.

Returns true if any of the tags in `v` are tags of `e`.
sourceraw docstring

tech-check?clj

(tech-check? v e)

Returns true if the check for tech on e equals the boolean value v

Returns true if the check for tech on `e` equals the boolean value `v`
sourceraw docstring

tech-collectorclj

(tech-collector)
(tech-collector acc)
(tech-collector acc e)

Step function to collect the technologies. Adds the tech of e to the accumulator acc.

Step function to collect the technologies.
Adds the tech of `e` to the accumulator `acc`.
sourceraw docstring

tech?clj

(tech? v e)

Returns true if v is a technology of e.

Returns true if `v` is a technology of `e`.
sourceraw docstring

technical-architecture-node-typesclj

Technical node types in the architecture model.

Technical node types in the architecture model.
sourceraw docstring

technical-architecture-node?clj

(technical-architecture-node? e)

Returns true if the given element e is a technical architecture model node.

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

technologiesclj

(technologies e)

Returns a vector of the technologies used by the element e.

Returns a vector of the technologies used by the element `e`.
sourceraw docstring

techs?clj

(techs? v e)

Returns true if any of the technologies in v are technologies of e.

Returns true if any of the technologies in `v` are technologies of `e`.
sourceraw docstring

theme?clj

(theme? e)

Returns true if the given element e is a theme.

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

to-namespace-prefix?clj

(to-namespace-prefix? v e)

Returns true, if vis a prefix of the namespace of element referenced by the to id of relation e.

Returns true, if `v`is a prefix of the namespace of element referenced by the to id of relation `e`.
sourceraw docstring

to-namespace?clj

(to-namespace? v e)

Returns true, if vis the namespace of the element referenced by the to id of relation e.

Returns true, if `v`is the namespace of the element referenced by the to id of relation `e`.
sourceraw docstring

to-namespaces?clj

(to-namespaces? v e)

Returns true, if the set of namespaces v contains the namespace of the to id of relation e.

Returns true, if the set of namespaces `v` contains the namespace of the to id of relation `e`.
sourceraw docstring

to?clj

(to? v e)

Returns true if the to id of the relation e is equal to v.

Returns true if the to id of the relation `e` is equal to `v`.
sourceraw docstring

traverseclj

(traverse step-fn coll)
(traverse pred-fn step-fn coll)
(traverse pred-fn children-fn step-fn coll)
(traverse element-fn pred-fn children-fn step-fn coll)

Recursively traverses the coll of elements and returns the elements (selected by the optional pred-fn) and transformed by the step-fn.

pred-fn - a predicate on the current element children-fn - a function to resolve the children of the current element step-fn - a function with three signatures [], [acc] and [acc e]

The no args signature of the step-fn should return an empty accumulator, the one args signature extracts the result from the accumulator on return and the 2 args signature receives the accumulator and the current element and should add the transformed element to the accumulator.

Recursively traverses the `coll` of elements and returns the elements
(selected by the optional `pred-fn`) and transformed by the `step-fn`.

`pred-fn`     - a predicate on the current element
`children-fn` - a function to resolve the children of the current element
`step-fn`     - a function with three signatures [], [acc] and [acc e]

The no args signature of the `step-fn` should return an empty accumulator,
the one args signature extracts the result from the accumulator on return
and the 2 args signature receives the accumulator and the current element and
should add the transformed element to the accumulator.
sourceraw docstring

tree->setclj

(tree->set)
(tree->set acc)
(tree->set acc e)

Step function to convert a hierarchical tree of elements to a flat set of elements.

Step function to convert a hierarchical tree of elements to a flat set of elements.
sourceraw docstring

uml-node-typesclj

Node types for UML models.

Node types for UML models.
sourceraw docstring

uml-relation-typesclj

Relation types of UML models.

Relation types of UML models.
sourceraw docstring

uml-view-element-typesclj

Element types of UML views.

Element types of UML views.
sourceraw docstring

uml-view-typesclj

The set of UML view types.

The set of UML view types.
sourceraw docstring

union-by-idclj

(union-by-id & sets)

Returns a set that is the union of the input sets. Equality is based on the id (:id key) of the element maps in the sets, not on value equality of the maps (entity equality vs. value equality). Element maps with the same id will be merged in left-to-right order. If a key occurs in more than one map, the mapping from the latter (left-to-right) will be the mapping in the result.

Returns a set that is the union of the input `sets`.
Equality is based on the id (:id key) of the element maps in the sets, not on value equality of the maps (entity equality vs. value equality).
Element maps with the same id will be merged in left-to-right order. If a key occurs in more than one map, the mapping from the latter (left-to-right) will be the mapping in the result.
sourceraw docstring

unresolved-ref?clj

(unresolved-ref? e)

Returns true if the given element e is a reference.

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

use-case-view-element-typesclj

Element types of a use case view.

Element types of a use case view.
sourceraw docstring

usecase-node-typesclj

Node types for usecase models.

Node types for usecase models.
sourceraw docstring

usecase-node?clj

(usecase-node? e)

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

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

usecase-relation-typesclj

Relation types for usecase models.

Relation types for usecase models.
sourceraw docstring

usecase-relation?clj

(usecase-relation? e)

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

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

value-xfclj

(value-xf k)

Returns a transducer to extract the value of the key k of each element.

Returns a transducer to extract the value of the key `k` of each element.
sourceraw docstring

view-of?clj

(view-of? e kind)

Returns true if the given element e is a view of kind.

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

view-typesclj

The set of view types.

The set of 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

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

× close