Liking cljdoc? Tell your friends :D

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:

:input-elements -> the given data :nodes -> the set of nodes (incl. child nodes) :relations -> the set of relations (incl. contains 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 element :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:

:input-elements         -> the given data
:nodes                  -> the set of nodes (incl. child nodes)
:relations              -> the set of relations (incl. contains 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 element
: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)
raw docstring

->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.
sourceraw docstring

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

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`.
sourceraw docstring

all-elementsclj

(all-elements model)

Returns a set of all elements.

Returns a set of all elements.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

build-modelclj

(build-model coll)

Builds the working model from the input coll of elements.

Builds the working model from the input `coll` of elements.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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.
sourceraw docstring

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.
sourceraw docstring

criterium-predicateclj

(criterium-predicate model [k v])

Returns a predicate for the given criterium.

Returns a predicate for the given `criterium`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

descendant-nodesclj

(descendant-nodes model e)

Returns the set of descendants of the node e.

Returns the set of descendants of the node `e`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

featuresclj

(features model e)
source

filter-xfclj

(filter-xf model criteria)

Returns a filter transducer for the given criteria.

Returns a filter transducer for the given `criteria`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

input-elementsclj

(input-elements model)

Returns the collection of elements.

Returns the collection of elements.
sourceraw docstring

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`.
sourceraw docstring

model-elementclj

(model-element model id)

Returns the model element with the given id.

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

model-elementsclj

(model-elements model)

Returns the collection of model elements.

Returns the collection of model elements.
sourceraw docstring

nodesclj

(nodes model)

Returns the collection of model nodes.

Returns the collection of model nodes.
sourceraw docstring

parentclj

(parent model e)

Returns the parent of the model node e.

Returns the parent of the model node `e`.
sourceraw docstring

parent-of-relationclj

(parent-of-relation p-id e-id)

Returns a parent-of relation for parent p and element e.

Returns a parent-of relation for parent `p` and element `e`.
sourceraw docstring

parent?clj

(parent? model v e)

Returns true if v is the parent of e

Returns true if `v` is the parent of `e`
sourceraw docstring

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`.
sourceraw docstring

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`
sourceraw docstring

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.
sourceraw docstring

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.
sourceraw docstring

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`
sourceraw docstring

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`.
sourceraw docstring

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

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

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

relationsclj

(relations model)

Returns the collection of model relations.

Returns the collection of model relations.
sourceraw docstring

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.
sourceraw docstring

resolve-elementclj

(resolve-element model e)

Resolves the model element for the ref e.

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

resolve-idclj

(resolve-id model id)

Resolves the model element for the id

Resolves the model element for the `id`
sourceraw docstring

resolve-refclj

(resolve-ref model r)

Resolves the model element for the ref r.

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

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.
sourceraw docstring

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`.
sourceraw docstring

subordinatesclj

(subordinates model e)

Returns the subordinates of the concept e in the model.

Returns the subordinates of the concept `e` in the `model`.
sourceraw docstring

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`.
sourceraw docstring

superordinatesclj

(superordinates model e)

Returns the superordinates of the concept e in the model.

Returns the superordinates of the concept `e` in the `model`.
sourceraw docstring

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`.
sourceraw docstring

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`.
sourceraw docstring

themesclj

(themes model)

Returns the set of themes from the model.

Returns the set of themes from the `model`.
sourceraw docstring

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`.
sourceraw docstring

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.
sourceraw docstring

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.
sourceraw docstring

unresolved-refs-xfclj

(unresolved-refs-xf model)

Returns a transducer to extract unresolved refs

Returns a transducer to extract unresolved refs
sourceraw docstring

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

viewsclj

(views model)

Returns the set of views from the model.

Returns the set of views from the `model`.
sourceraw docstring

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

× close