org.soulspace.overarch.domain.element — org.soulspace.clj/overarch 0.21.0

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.

all-tags? clj

(all-tags? v e)

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

all-techs? clj

(all-techs? v e)

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

architecture-dependency-relation-types clj

architecture-node-types clj

Node types in the architecture model.

architecture-node? clj

(architecture-node? e)

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

architecture-relation-types clj

Relation types in the architecture model.

architecture-relation? clj

(architecture-relation? e)

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

boundary-types clj

Element types of boundaries.

boundary? clj

(boundary? e)

Returns true if e is a boundary.

c4-view-types clj

The set of C4 view types.

child? clj

(child? e p)

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

children clj

(children e)

Returns the children of the element e.

class-model-node? clj

(class-model-node? e)

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

class-model-relation? clj

(class-model-relation? e)

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

class-node-types clj

Node types for class models.

class-relation-types clj

Relation types for class models.

class-view-element-types clj

Element types of a class view.

code-view-element-types clj

Element types of a C4 code view.

collect-fields clj

(collect-fields coll)

Returns the fields of all classes in the coll.

collect-methods clj

(collect-methods coll)

Returns the methods of all classes in the coll.

collect-technologies clj

(collect-technologies coll)

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

component-view-element-types clj

Element types of a C4 component view.

concept-model-node? clj

(concept-model-node? e)

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

concept-model-relation? clj

(concept-model-relation? e)

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

concept-node-types clj

Node types for concept models.

concept-relation-types clj

Relation types of concept models.

concept-view-element-types clj

Element types of a concept view.

concept-view-types clj

The set of concept views types.

container-view-element-types clj

Element types of a C4 container view.

context-view-element-types clj

Element types of a C4 context view.

deployment-node-types clj

Node types for deployment models.

deployment-node? clj

(deployment-node? e)

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

deployment-relation-types clj

Relation types for deployment models.

deployment-relation? clj

(deployment-relation? e)

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

deployment-view-element-types clj

Element types of a C4 deployment view.

desc-check? clj

(desc-check? v e)

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

desc? clj

(desc? v e)

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

difference-by-id clj

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

dynamic-view-element-types clj

Element types of a C4 dynamic view.

el? clj

(el? v e)

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

element->ref clj

(element->ref e)

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

element-hierarchy clj

Hierarchy for rendering methods.

element-name clj

(element-name e)

Returns the name of the element e.

element-namespace clj

(element-namespace e)

Returns the namespace of the element e.

element? clj

(element? e)

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

elements-by-namespace clj

(elements-by-namespace coll)

Returns the elements of the coll grouped by namespace.

els? clj

(els? v e)

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

external-check? clj

(external-check? v e)

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

external? clj

(external? e)

Returns true if the given element e is external.

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.

from-namespace? clj

(from-namespace? v e)

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

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.

from? clj

(from? v e)

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

generate-node-id clj

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

generate-relation-id clj

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

glossary-view-element-types clj

Element types of a glossary view.

hierarchical-view-types clj

The set of hierarchical view types.

hierarchical-view? clj

(hierarchical-view? e)

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

id->element clj

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

id->element-map clj

(id->element-map elements)

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

id->parent clj

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

id-check? clj

(id-check? v e)

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

id? clj

(id? v e)

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

identifiable-element? clj

(identifiable-element? e)

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

identifiable-named-element? clj

(identifiable-named-element? e)

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

identifiable-relational-element? clj

(identifiable-relational-element? e)

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

identifiable? clj

(identifiable? e)

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

ids-xf clj

Returns a transducer to extract the id of each element.

internal? clj

(internal? e)

Returns true if the given element e is internal.

key->element clj

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

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.

key? clj

(key? [k v] e)

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

model-element-types clj

Element types for the model.

model-element? clj

(model-element? e)

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

model-node-types clj

Node types of the model.

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.

model-relation-types clj

Relation types of the model.

model-relation? clj

(model-relation? e)

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

name-check? clj

(name-check? v e)

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

name-prefix? clj

(name-prefix? v e)

Returns true if the name of e starts with v.

name? clj

(name? v e)

Returns true if the name of e matches v.

named-element? clj

(named-element? e)

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

named-relational-element? clj

(named-relational-element? e)

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

named? clj

(named? e)

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

namespace-prefix? clj

(namespace-prefix? v e)

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

namespace? clj

(namespace? v e)

Returns true, if vis the namespace of element e.

namespaced? clj

(namespaced? e)

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

namespaces-xf clj

Returns a transducer to extract the namespaces of some elements.

namespaces? clj

(namespaces? v e)

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

node-ids-xf clj

Returns a transducer to extract the id of each node.

node-of? clj

(node-of? kind e)

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

parent-check? clj

(parent-check? v e)

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

reference-types clj

Element types of references.

reference? clj

(reference? e)

Returns true if the given element e is a reference.

referred-id->relation clj

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

referrer-id->relation clj

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

relation-of? clj

(relation-of? kind e)

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

relational-element? clj

(relational-element? e)

Returns true if the given element e is a relation.

relational? clj

(relational? e)

Returns true if the given element e is a relation.

state-machine-view-element-types clj

Element types of a state machine view.

statemachine-node-types clj

Node types for statemachine models.

statemachine-node? clj

(statemachine-node? e)

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

statemachine-relation-types clj

Relation types for statemachine models.

statemachine-relation? clj

(statemachine-relation? e)

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

subtype-check? clj

(subtype-check? v e)

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

subtype? clj

(subtype? v e)

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

subtypes? clj

(subtypes? v e)

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

synthetic? clj

(synthetic? e)

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

system-landscape-view-element-types clj

Element types of a C4 system-landscape view.

tag? clj

(tag? v e)

Returns true if v is a tag of e.

tags-check? clj

(tags-check? v e)

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

tags? clj

(tags? v e)

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

tech-check? clj

(tech-check? v e)

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

tech-collector clj

(tech-collector)

(tech-collector acc)

(tech-collector acc e)

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

tech? clj

(tech? v e)

Returns true if v is a technology of e.

technical-architecture-node-types clj

Technical node types in the architecture model.

technical-architecture-node? clj

(technical-architecture-node? e)

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

technologies clj

(technologies e)

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

techs? clj

(techs? v e)

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

theme? clj

(theme? e)

Returns true if the given element e is a theme.

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.

to-namespace? clj

(to-namespace? v e)

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

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.

to? clj

(to? v e)

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

traverse clj

(traverse step-fn coll)

(traverse pred-fn step-fn coll)

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

tree->set clj

(tree->set)

(tree->set acc)

(tree->set acc e)

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

uml-node-types clj

Node types for UML models.

uml-relation-types clj

Relation types of UML models.

uml-view-element-types clj

Element types of UML views.

uml-view-types clj

The set of UML view types.

union-by-id clj

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

unresolved-ref? clj

(unresolved-ref? e)

Returns true if the given element e is a reference.

use-case-view-element-types clj

Element types of a use case view.

usecase-node-types clj

Node types for usecase models.

usecase-node? clj

(usecase-node? e)

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

usecase-relation-types clj

Relation types for usecase models.

usecase-relation? clj

(usecase-relation? e)

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

value-xf clj

(value-xf k)

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

view-of? clj

(view-of? e kind)

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

view-types clj

The set of view types.

view? clj

(view? e)

Returns true if the given element e is a view.