Liking cljdoc? Tell your friends :D

org.soulspace.overarch.domain.model

Functions for the definition and handling of the overarch model.

Functions for the definition and handling of the overarch model.
raw docstring

all-descendant-nodesclj

(all-descendant-nodes model elements)

Returns the set of descendants of the nodes in the collection of elements in the model.

Returns the set of descendants of the nodes in the collection of `elements` in the `model`.
sourceraw docstring

all-elementsclj

(all-elements model)

Returns a set of all elements in the model.

Returns a set of all elements in the `model`.
sourceraw docstring

all-nodesclj

(all-nodes model elements)

Returns the set of all nodes, including descendants, of the elements in the model.

Returns the set of all nodes, including descendants, of the `elements` in the `model`.
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-predclj

(ancestor-of-pred model v)

Returns a predicate that returns true, if e is an ancestor of the node with id v in the model.

Returns a predicate that returns true, if `e` is an ancestor of the node with id `v` in the `model`.
sourceraw docstring

check-nodesclj

(check-nodes model)

Validates the content references in the model.

Validates the content references in the model.
sourceraw docstring

check-relationsclj

(check-relations model)

Validates the relations in the model.

Validates the relations in the model.
sourceraw docstring

check-viewsclj

(check-views model)

Validates the references in the views.

Validates the references in the views.
sourceraw docstring

child-check-predclj

(child-check-pred model v)

Returns a predicate that returns true, if the check for e is a child in the model equals the boolean value v.

Returns a predicate that returns true, if the check for `e` is a child in the `model` equals the boolean value `v`.
sourceraw docstring

child-predclj

(child-pred model v)

Returns a predicate that returns true, if e is a child of the node with id v in the model.

Returns a predicate that returns true, if `e` is a child of the node with id `v` in the `model`.
sourceraw docstring

childrenclj

(children model e)

Returns the children of the model node e.

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

children-resolverclj

(children-resolver model)

Returns a children resolver function for the given model.

Returns a children resolver function for the given `model`.
sourceraw docstring

collect-in-ordered-setclj

(collect-in-ordered-set)
(collect-in-ordered-set acc)
(collect-in-ordered-set acc e)

Step function to collect elements e in the accumulator acc. No transformation on the element is applied.

Step function to collect elements `e` in the accumulator `acc`.
No transformation on the element is applied.
sourceraw docstring

collect-in-setclj

(collect-in-set)
(collect-in-set acc)
(collect-in-set acc e)

Step function to collect elements e in the accumulator acc. No transformation on the element is applied.

Step function to collect elements `e` in the accumulator `acc`.
No transformation on the element is applied.
sourceraw docstring

collect-in-vectorclj

(collect-in-vector)
(collect-in-vector acc)
(collect-in-vector acc e)

Step function to collect elements e in the accumulator acc. No transformation on the element is applied.

Step function to collect elements `e` in the accumulator `acc`.
No transformation on the element is applied.
sourceraw docstring

criteria-map-predicateclj

(criteria-map-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-predicateclj

(criteria-predicate 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

descendant-node?clj

(descendant-node? model e c)

Returns true, if c is a descendant of e in the model.

Returns true, if `c` is a descendant of `e` in the `model`.
sourceraw docstring

descendant-nodesclj

(descendant-nodes model e)

Returns the set of descendants of the node e in the model.

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

descendant-of-predclj

(descendant-of-pred model v)

Returns a predicate that returns true, if e is a descendant of the node with id v in the model.

Returns a predicate that returns true, if `e` is a descendant of the node with id `v` in the `model`.
sourceraw docstring

element-resolverclj

(element-resolver model)

Returns an element resolver function for the given model.

Returns an element resolver function for the given `model`.
sourceraw docstring

external-check-predclj

(external-check-pred model v)

Returns a predicate that returns true, if the check for external on e equals the boolean value v in the model.

Returns a predicate that returns true, if the check for external on `e` equals the boolean value `v` in the `model`.
sourceraw docstring

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

from-predclj

(from-pred model v)

Returns a predicate that returns true, if referring node of relation e is matched by v in the model.

Returns a predicate that returns true, if referring node of relation `e` is matched by `v` in the `model`.
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

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

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

model-elements-by-criteriaclj

(model-elements-by-criteria model criteria)

Returns a set of relations that match the criteria

Returns a set of relations that match the `criteria`
sourceraw docstring

node-by-idclj

(node-by-id model id)

Returns the node with the given id.

Returns the node with the given `id`.
sourceraw docstring

nodesclj

(nodes model)

Returns the collection of model nodes.

Returns the collection of model nodes.
sourceraw docstring

nodes-by-criteriaclj

(nodes-by-criteria model criteria)

Returns a set of nodes that match the criteria

Returns a set of nodes that match the `criteria`
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-check-predclj

(parent-check-pred model v)

Returns a predicate that returns true if the check for children of e equals the boolean value v

Returns a predicate that returns true if the check for children of `e` equals the boolean value `v`
sourceraw docstring

parent-newclj

(parent-new model e)

Returns the parent of the model node e.

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

parent-predclj

(parent-pred model v)

Returns a predicate that returns true if v is the parent of e

Returns a predicate that returns true if `v` is the parent of `e`
sourceraw docstring

parent-resolverclj

(parent-resolver model)

Returns a parent resolver function for the given model.

Returns a parent resolver function for the given `model`.
sourceraw docstring

referred-by-predclj

(referred-by-pred model v)

Returns a predicate that returns true, if e is referred by the node with id v in the model.

Returns a predicate that returns true, if `e` is referred by the node with id `v` in the `model`.
sourceraw docstring

referred-check-predclj

(referred-check-pred model v)

Returns a predicate that returns true if the check for e as referred to equals the boolean value v in the model.

Returns a predicate that returns true if the check for `e` as referred to equals the boolean value `v` in the `model`.
sourceraw docstring

referred-nodesclj

(referred-nodes model e)
(referred-nodes model e criteria)

Returns the nodes referred by e in the model. Optionally takes criteria to filter for.

Returns the nodes referred by `e` in the `model`.
Optionally takes `criteria` to filter for.
sourceraw docstring

referred-predclj

(referred-pred model v)

Returns a predicate that returns true, if a referrer relation of the node e matches v in the model.

Returns a predicate that returns true, if a referrer relation of the node `e` matches `v` in the `model`.
sourceraw docstring

referred-relationsclj

(referred-relations model e)
(referred-relations model e criteria)

Returns the relations referred by e in the model. Optionally takes criteria to filter for.

Returns the relations referred by `e` in the `model`.
Optionally takes `criteria` to filter for.
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

referring-nodesclj

(referring-nodes model e)
(referring-nodes model e criteria)

Returns the nodes referring to e in the model. Optionally takes criteria to filter for.

Returns the nodes referring to `e` in the `model`.
Optionally takes `criteria` to filter for.
sourceraw docstring

referring-relationsclj

(referring-relations model e)
(referring-relations model e criteria)

Returns the relations referring to e in the model. Optionally takes criteria to filter for.

Returns the relations referring to `e` in the `model`.
Optionally takes `criteria` to filter for.
sourceraw docstring

refers-check-predclj

(refers-check-pred model v)

Returns a predicate that returns true, if the check for e as a referrer equals the boolean value v in the model.

Returns a predicate that returns true, if the check for `e` as a referrer equals the boolean value `v` in the `model`.
sourceraw docstring

refers-predclj

(refers-pred model v)

Returns a predicate that returns true, if a referrer relation of the node e matches v in the model.

Returns a predicate that returns true, if a referrer relation of the node `e` matches `v` in the `model`.
sourceraw docstring

refers-to-predclj

(refers-to-pred model v)

Returns a predicate that returns true, if the node with id v refers to e in the model.

Returns a predicate that 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

relation-by-idclj

(relation-by-id model id)

Returns the node with the given id.

Returns the node with the given `id`.
sourceraw docstring

relationsclj

(relations model)

Returns the collection of model relations.

Returns the collection of model relations.
sourceraw docstring

relations-by-criteriaclj

(relations-by-criteria model criteria)

Returns a set of relations that match the criteria

Returns a set of relations that match the `criteria`
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 and associates any additional keys of r to the model element.

Resolves the model element for the ref `r` and associates any additional keys of `r` to the model element.
sourceraw docstring

resolveable-element?clj

(resolveable-element? model e)

Returns true if the element is resolveable in the model.

Returns true if the element is resolveable in the model.
sourceraw docstring

resolveable-relation?clj

(resolveable-relation? model e)

Returns true if relation e and the referrer and referred nodes of e are resolveable in the model.

Returns true if relation `e` and the referrer and referred nodes of `e` are resolveable in the `model`.
sourceraw docstring

root-nodesclj

(root-nodes model elements)

Returns the set of root nodes of the elements in the model. The root nodes are not contained as descendants in any of the element nodes.

Returns the set of root nodes of the `elements` in the `model`.
The root nodes are not contained as descendants in any of the element nodes.
sourceraw docstring

sprite-collectorclj

(sprite-collector)
(sprite-collector acc)
(sprite-collector acc e)

Adds the sprite of e to the accumulator acc.

Adds the sprite of `e` to the accumulator `acc`.
sourceraw docstring

t-ancestorsclj

(t-ancestors model e)

Returns the ancestors of the element in the model.

Returns the ancestors of the `element` in the `model`.
sourceraw docstring

t-descendantsclj

(t-descendants model e)

Returns the descendants of the element in the model.

Returns the descendants of the `element` in the `model`.
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

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

to-predclj

(to-pred model v)

Returns a predicate that returns true, if referred node of relation e is matched by v in the model.

Returns a predicate that returns true, if referred node of relation `e` is matched by `v` in the `model`.
sourceraw docstring

(transitive-search model search-criteria)
(transitive-search model search-criteria e)
(transitive-search model collect-fn search-criteria e)

Returns the result of a transitive search for the model based on the search-criteria.

Returns the result of a transitive search for the `model` based on the `search-criteria`.
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 filtered by an optional pred-fn and returns the elements transformed by the step-fn.

element-fn - a resolver function for an element, defaults to identity pred-fn - a predicate on the current element, defaults to identity 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 filtered by an optional `pred-fn`
and returns the elements transformed by the `step-fn`.

`element-fn`  - a resolver function for an element, defaults to `identity`
`pred-fn`     - a predicate on the current element, defaults to `identity`
`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

unrelated-nodesclj

(unrelated-nodes model)

Returns the set of ids of identifiable model nodes not taking part in any relation.

Returns the set of ids of identifiable model nodes not taking part in any relation.
sourceraw docstring

unresolved-refsclj

(unresolved-refs model element)

Checks references in an element.

Checks references in an element.
sourceraw docstring

unresolved-refs-in-viewclj

(unresolved-refs-in-view model view)

Checks references in a view.

Checks references in a view.
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

(unresolved-related model rel)

Checks references in a relation.

Checks references in a relation.
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