- ->relational-model
- ->transitive-related
- actors
- add-node
- add-reference
- add-relation
- add-theme
- add-view
- all-elements
- all-nodes
- ancestor-node?
- ancestor-nodes
- ancestor-of?
- build-model
- child-check?
- child?
- children
- collaborates-with
- collaboration-with
- collect-fields
- collect-methods
- contained-in-relation
- criteria-predicate
- criteria-predicates
- criterium-predicate
- dataflows-incoming
- dataflows-outgoing
- dependency-nodes
- dependent-nodes
- deployed-on
- deployed-to
- descendant-node?
- descendant-nodes
- descendant-of?
- element-resolver
- extensions
- feature-of
- features
- filter-xf
- from-name
- identified-node
- implementations
- included
- input-child?
- input-elements
- interfaces
- linked-by
- links
- model-element
- model-elements
- nodes
- parent
- parent-check?
- parent?
- publishers-of
- publishes-incoming
- publishes-outgoing
- referenced-by
- referencing
- referred-by?
- referred-check?
- referred-xf
- referrer-xf
- refers-check?
- refers-to?
- related
- related-nodes
- related-transitive
- related-xf
- relations
- relations-of-nodes
- requests-incoming
- requests-outgoing
- resolve-element
- resolve-id
- resolve-ref
- responses-incoming
- responses-outgoing
- responsibility-of
- responsible-for
- root-nodes
- scope-fn
- sends-incoming
- sends-outgoing
- subclasses
- subordinates
- subscribers-of
- subscribes-incoming
- subscribes-outgoing
- superclasses
- superordinates
- supertypes
- supporting-actors
- themes
- to-name
- traverse
- traverse-with-model
- type-hierarchy
- unresolved-refs-xf
- update-acc
- used-by
- using
- views
org.soulspace.overarch.domain.model
Functions for the definition and handling of the overarch model.
The loaded overarch working model is a map with these keys:
:nodes -> the set of all nodes (incl. child nodes) :relations -> the set of all relations (incl. contained-in relations) :views -> the set of views :themes -> the set of themes :id->element -> a map from id to element (nodes, relations and views) :id->parent -> a map from id to parent node :id->children -> a map from id to a vector of contained nodes :referrer-id->relations -> a map from id to set of relations where the id is the referrer (:from) :referred-id->relations -> a map from id to set of relations where the id is referred (:to)
Functions for the definition and handling of the overarch model. The loaded overarch working model is a map with these keys: :nodes -> the set of all nodes (incl. child nodes) :relations -> the set of all relations (incl. contained-in relations) :views -> the set of views :themes -> the set of themes :id->element -> a map from id to element (nodes, relations and views) :id->parent -> a map from id to parent node :id->children -> a map from id to a vector of contained nodes :referrer-id->relations -> a map from id to set of relations where the id is the referrer (:from) :referred-id->relations -> a map from id to set of relations where the id is referred (:to)
->relational-modelclj
(->relational-model)(->relational-model [res ctx])(->relational-model [res ctx] e)Step function for the conversion of the hierachical input model into a relational model of nodes, relations and views.
Step function for the conversion of the hierachical input model into a relational model of nodes, relations and views.
->transitive-relatedclj
(->transitive-related)(->transitive-related acc)(->transitive-related acc e)Step function to build a set of transitively related nodes (with cycle detection).
Step function to build a set of transitively related nodes (with cycle detection).
actorsclj
(actors model e)Returns the actors of a use case e in the model.
Returns the actors of a use case `e` in the `model`.
add-nodeclj
(add-node acc p e)Update the accumulator acc of the model with the node e
in the context of the parent p (if given).
Update the accumulator `acc` of the model with the node `e` in the context of the parent `p` (if given).
add-referenceclj
(add-reference acc p e)Update the accumulator acc of the model with the reference e
in the context of the parent p (if given).
Update the accumulator `acc` of the model with the reference `e` in the context of the parent `p` (if given).
add-relationclj
(add-relation acc p e)Update the accumulator acc of the model with the relation e
in the context of the parent p (if given).
Update the accumulator `acc` of the model with the relation `e` in the context of the parent `p` (if given).
add-themeclj
(add-theme acc p e)Update the accumulator acc of the model with the view e
in the context of the parent p (if given).
Update the accumulator `acc` of the model with the view `e` in the context of the parent `p` (if given).
add-viewclj
(add-view acc p e)Update the accumulator acc of the model with the view e
in the context of the parent p (if given).
Update the accumulator `acc` of the model with the view `e` in the context of the parent `p` (if given).
all-elementsclj
(all-elements model)Returns a set of all elements.
Returns a set of all elements.
all-nodesclj
(all-nodes model elements)Returns the set of all nodes, including descendants, of the elements.
Returns the set of all nodes, including descendants, of the `elements`.
ancestor-node?clj
(ancestor-node? model e c)Returns true, if c is an ancestor of node e in the model.
Returns true, if `c` is an ancestor of node `e` in the `model`.
ancestor-nodesclj
(ancestor-nodes model e)Returns the ancestor nodes of the model node e in the model.
Returns the ancestor nodes of the model node `e` in the `model`.
ancestor-of?clj
(ancestor-of? model v e)Returns true, if e is an ancestor of the node with id v in the model.
Returns true, if `e` is an ancestor of the node with id `v` in the `model`.
build-modelclj
(build-model coll)(build-model options coll)Builds the working model from the input coll of elements.
Builds the working model from the input `coll` of elements.
child-check?clj
(child-check? model v e)Returns true, if the check for e is a child in the model equals the boolean value v.
Returns true, if the check for `e` is a child in the `model` equals the boolean value `v`.
child?clj
(child? model v e)Returns true, if e is a child of the node with id v in the model.
Returns true, if `e` is a child of the node with id `v` in the `model`.
childrenclj
(children model e)Returns the children of the model node e.
Returns the children of the model node `e`.
collaborates-withclj
(collaborates-with model e)Returns the organization model nodes the organization unit e collaborates with in the model.
Returns the organization model nodes the organization unit `e` collaborates with in the `model`.
collaboration-withclj
(collaboration-with model e)Returns the organization model nodes the organization unit e has a collaboration with in the model. Reverse direction of collaborates with.
Returns the organization model nodes the organization unit `e` has a collaboration with in the `model`. Reverse direction of collaborates with.
collect-fieldsclj
(collect-fields model coll)Returns the fields of all classes in the coll.
Returns the fields of all classes in the `coll`.
collect-methodsclj
(collect-methods model coll)Returns the methods of all classes in the coll.
Returns the methods of all classes in the `coll`.
contained-in-relationclj
(contained-in-relation p-id e-id)Returns a contained-in relation for parent p and element e.
Returns a contained-in relation for parent `p` and element `e`.
criteria-predicateclj
(criteria-predicate model criteria)Returns a filter predicate for the given criteria.
The resulting predicate is a logical conjunction (and) of the predicates for
each criterium.
Returns a filter predicate for the given `criteria`. The resulting predicate is a logical conjunction (and) of the predicates for each criterium.
criteria-predicatesclj
(criteria-predicates model criteria)Returns a filter predicate for the given criteria.
If a vector of criteria maps is given, the resulting predicate is a logical
disjunction (or) of the predicates.
Returns a filter predicate for the given `criteria`. If a vector of criteria maps is given, the resulting predicate is a logical disjunction (or) of the predicates.
criterium-predicateclj
(criterium-predicate model [k v])Returns a predicate for the given criterium.
Returns a predicate for the given `criterium`.
dataflows-incomingclj
(dataflows-incoming model e)Returns the incoming dataflow relations served by service e in the model.
Returns the incoming dataflow relations served by service `e` in the `model`.
dataflows-outgoingclj
(dataflows-outgoing model e)Returns the outgoing dataflow relations of e in the model.
Returns the outgoing dataflow relations of `e` in the `model`.
dependency-nodesclj
(dependency-nodes model e)Returns the direct dependencies of the architecture node e in the model.
Returns the direct dependencies of the architecture node `e` in the `model`.
dependent-nodesclj
(dependent-nodes model e)Returns the direct dependents of the architecture node e in the model.
Returns the direct dependents of the architecture node `e` in the `model`.
deployed-onclj
(deployed-on model e)Returns the architecture nodes deployed on the node e in the model.
Returns the architecture nodes deployed on the node `e` in the `model`.
deployed-toclj
(deployed-to model e)Returns the deployment nodes the architecture node e is deployed to in the ``model`.
Returns the deployment nodes the architecture node `e` is deployed to in the ``model`.
descendant-node?clj
(descendant-node? model e c)Returns true, if c is a descendant of e.
Returns true, if `c` is a descendant of `e`.
descendant-nodesclj
(descendant-nodes model e)Returns the set of descendants of the node e.
Returns the set of descendants of the node `e`.
descendant-of?clj
(descendant-of? model v e)Returns true, if e is a descendant of the node with id v in the model.
Returns true, if `e` is a descendant of the node with id `v` in the `model`.
element-resolverclj
(element-resolver model)Returns a element resolver function for the given model.
Returns a element resolver function for the given `model`.
extensionsclj
(extensions model e)Returns the extension use cases of a use case e in the model.
Returns the extension use cases of a use case `e` in the `model`.
feature-ofclj
(feature-of model e)Returns the concepts the concept e is a feature of in the model.
Returns the concepts the concept `e` is a feature of in the `model`.
featuresclj
(features model e)Returns the features of the concept e in the model.
Returns the features of the concept `e` in the `model`.
filter-xfclj
(filter-xf model criteria)Returns a filter transducer for the given criteria.
Returns a filter transducer for the given `criteria`.
from-nameclj
(from-name model rel)Returns the name of the from reference of the relation rel in the context of the model.
Returns the name of the from reference of the relation `rel` in the context of the `model`.
identified-nodeclj
(identified-node e p)Returns the node e with the id set. Generates the id from es name and the parent ps id.
Returns the node `e` with the id set. Generates the id from `e`s name and the parent `p`s id.
implementationsclj
(implementations model e)Returns the set of direct interfaces of the class element e in the model.
Returns the set of direct interfaces of the class element `e` in the `model`.
includedclj
(included model e)Returns the extension use cases of a use case e in the model.
Returns the extension use cases of a use case `e` in the `model`.
input-child?clj
(input-child? e p)Returns true, if element e is a child of model element p in the input model.
Returns true, if element `e` is a child of model element `p` in the input model.
input-elementsclj
(input-elements model)Returns the collection of elements.
Returns the collection of elements.
interfacesclj
(interfaces model e)Returns the set of direct interfaces of the class element e in the model.
Returns the set of direct interfaces of the class element `e` in the `model`.
linked-byclj
(linked-by model e)Returns the deployment nodes the deployment node e is linked by in the model
Returns the deployment nodes the deployment node `e` is linked by in the `model`
linksclj
(links model e)Returns the deployment nodes the deployment node e links in the model
Returns the deployment nodes the deployment node `e` links in the `model`
model-elementclj
(model-element model id)Returns the model element with the given id.
Returns the model element with the given `id`.
model-elementsclj
(model-elements model)Returns the collection of model elements.
Returns the collection of model elements.
nodesclj
(nodes model)Returns the collection of model nodes.
Returns the collection of model nodes.
parentclj
(parent model e)Returns the parent of the model node e.
Returns the parent of the model node `e`.
parent-check?clj
(parent-check? model 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`
parent?clj
(parent? model v e)Returns true if v is the parent of e
Returns true if `v` is the parent of `e`
publishers-ofclj
(publishers-of model e)Returns the publishers of the queue or subscribe relation e in the model.
Returns the publishers of the queue or subscribe relation `e` in the `model`.
publishes-incomingclj
(publishes-incoming model e)Returns the publish relations of e in the model.
Returns the publish relations of `e` in the `model`.
publishes-outgoingclj
(publishes-outgoing model e)Returns the publish relations of e in the model.
Returns the publish relations of `e` in the `model`.
referenced-byclj
(referenced-by model e)Returns the elements referencing element e in the model.
Returns the elements referencing element `e` in the `model`.
referencingclj
(referencing model e)Returns the referenced elements of e in the model.
Returns the referenced elements of `e` in the `model`.
referred-by?clj
(referred-by? model v e)Returns true, if e is referred by the node with id v in the model.
Returns true, if `e` is referred by the node with id `v` in the `model`.
referred-check?clj
(referred-check? model v e)Returns true if the check for e as referred to equals the boolean value v
Returns true if the check for `e` as referred to equals the boolean value `v`
referred-xfclj
(referred-xf model)(referred-xf model filter-fn)Transducer to resolve referred elements in the model.
Optionally takes a filter-fn to filter the relations to take into account.
Transducer to resolve referred elements in the `model`. Optionally takes a `filter-fn` to filter the relations to take into account.
referrer-xfclj
(referrer-xf model)(referrer-xf model filter-fn)Transducer to resolve referrer elements of in the model.
Optionally takes a filter-fn to filter the relations to take into account.
Transducer to resolve referrer elements of in the `model`. Optionally takes a `filter-fn` to filter the relations to take into account.
refers-check?clj
(refers-check? model v e)Returns true if the check for e as a referrer equals the boolean value v
Returns true if the check for `e` as a referrer equals the boolean value `v`
refers-to?clj
(refers-to? model v e)Returns true, if the node with id v refers to e in the model.
Returns true, if the node with id `v` refers to `e` in the `model`.
relatedclj
(related model coll)Returns the set of nodes of the model that are part of at least one relation in the coll.
Returns the set of nodes of the `model` that are part of at least one relation in the `coll`.
related-nodesclj
(related-nodes model coll)Returns the set of nodes of the model that are part of at least one relation in the coll.
Returns the set of nodes of the `model` that are part of at least one relation in the `coll`.
related-transitiveclj
(related-transitive model e)(related-transitive model f e)Returns the nodes that are transitively related to node e in the model.
Returns the nodes that are transitively related to node `e` in the `model`.
related-xfclj
(related-xf model)Transducer to resolve the elements in the model referenced by relations.
Transducer to resolve the elements in the `model` referenced by relations.
relationsclj
(relations model)Returns the collection of model relations.
Returns the collection of model relations.
relations-of-nodesclj
(relations-of-nodes model coll)Returns the relations of the model connecting nodes from the given coll of model nodes.
Returns the relations of the `model` connecting nodes from the given `coll` of model nodes.
requests-incomingclj
(requests-incoming model e)Returns the request relations served by service e in the model.
Returns the request relations served by service `e` in the `model`.
requests-outgoingclj
(requests-outgoing model e)Returns the request relations issued by client e in the model.
Returns the request relations issued by client `e` in the `model`.
resolve-elementclj
(resolve-element model e)Resolves the model element for the ref e.
Resolves the model element for the ref `e`.
resolve-idclj
(resolve-id model id)Resolves the model element for the id
Resolves the model element for the `id`
resolve-refclj
(resolve-ref model r)Resolves the model element for the ref r.
Resolves the model element for the ref `r`.
responses-incomingclj
(responses-incoming model e)Returns the response relations handled by client e in the model.
Returns the response relations handled by client `e` in the `model`.
responses-outgoingclj
(responses-outgoing model e)Returns the response relations served by service e in the model.
Returns the response relations served by service `e` in the `model`.
responsibility-ofclj
(responsibility-of model e)Returns the organization model nodes the e is responsible for in the model.
Returns the organization model nodes the `e` is responsible for in the `model`.
responsible-forclj
(responsible-for model e)Returns the nodes the organization unit e is responsible for in the model.
Returns the nodes the organization unit `e` is responsible for in the `model`.
root-nodesclj
(root-nodes model elements)Returns the set of root nodes of the elements.
The root nodes are not contained as descendants in any of the element nodes.
Returns the set of root nodes of the `elements`. The root nodes are not contained as descendants in any of the element nodes.
sends-incomingclj
(sends-incoming model e)Returns the send relations of receiver e in the model.
Returns the send relations of receiver `e` in the `model`.
sends-outgoingclj
(sends-outgoing model e)Returns the send relations of sender e in the model.
Returns the send relations of sender `e` in the `model`.
subclassesclj
(subclasses model e)Returns the set of direct subclasses of the class element e in the model.
Returns the set of direct subclasses of the class element `e` in the `model`.
subordinatesclj
(subordinates model e)Returns the subordinates of the concept e in the model.
Returns the subordinates of the concept `e` in the `model`.
subscribers-ofclj
(subscribers-of model e)Returns the subscribers of the queue or publish relation e in the model.
Returns the subscribers of the queue or publish relation `e` in the `model`.
subscribes-incomingclj
(subscribes-incoming model e)Returns the subscribe relations of e in the model.
Returns the subscribe relations of `e` in the `model`.
subscribes-outgoingclj
(subscribes-outgoing model e)Returns the subscribe relations of e in the model.
Returns the subscribe relations of `e` in the `model`.
superclassesclj
(superclasses model e)Returns the set of direct superclasses of the class element e in the model.
Returns the set of direct superclasses of the class element `e` in the `model`.
superordinatesclj
(superordinates model e)Returns the superordinates of the concept e in the model.
Returns the superordinates of the concept `e` in the `model`.
supertypesclj
(supertypes model e)Returns the set of direct supertypes (classes or interfaces) of the class element e in the model.
Returns the set of direct supertypes (classes or interfaces) of the class element `e` in the `model`.
supporting-actorsclj
(supporting-actors model e)Returns the supporting actors of a use case e in the model.
Returns the supporting actors of a use case `e` in the `model`.
themesclj
(themes model)Returns the set of themes from the model.
Returns the set of themes from the `model`.
to-nameclj
(to-name model rel)Returns the name of the from reference of the relation rel in the context of the model.
Returns the name of the from reference of the relation `rel` in the context of the `model`.
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.
traverse-with-modelclj
(traverse-with-model model step-fn coll)(traverse-with-model model pred-fn step-fn coll)(traverse-with-model model 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.
The children-fn takes 2 args [model e], the model and the current element.
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. The children-fn takes 2 args [model e], the model and the current element.
type-hierarchyclj
(type-hierarchy model e)Returns the type hierarchy of the class or interface element e in the model.
Returns the type hierarchy of the class or interface element `e` in the model.
unresolved-refs-xfclj
(unresolved-refs-xf model)Returns a transducer to extract unresolved refs
Returns a transducer to extract unresolved refs
update-accclj
(update-acc acc p e)Update the accumulator acc of the model with the element e
in the context of the parent p (if given).
Update the accumulator `acc` of the model with the element `e` in the context of the parent `p` (if given).
used-byclj
(used-by model e)Returns the from side of the relation of type :uses of node e in the model.
Returns the from side of the relation of type :uses of node `e` in the `model`.
usingclj
(using model e)Returns the to side of the relation of type :uses of node e in the model.
Returns the to side of the relation of type :uses of node `e` in the `model`.
viewsclj
(views model)Returns the set of views from the model.
Returns the set of views from the `model`.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close