Liking cljdoc? Tell your friends :D
org.soulspace.overarch.adapter.exports.structurizr
Functions for the export to structurizr.
Functions for the export to structurizr.
org.soulspace.overarch.adapter.reader.file-input-model-reader
Functions to read the overarch input models from filesystem.
Functions to read the overarch input models from filesystem.
org.soulspace.overarch.adapter.reader.input-model-reader
Functions to read and build the working model from overarch input models.
The built model is a map with the following keys
| Key | Description |
|---|---|
| Relation keys | |
| :nodes | the set of all nodes |
| :relations | the set of all relations |
| :views | the set of views |
| :themes | the set of themes |
| Index keys | |
| :id->element | a map from id to element (nodes, relations and views) |
| :id->parent-id | a map from id to parent node id |
| :id->children | a map from id to a vector of contained nodes (deprecated) |
| :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) |
| Problem keys | |
| :problems | the set of problems found during model building |
The input model is transformed by
- computing missing ids, if possible
- converting the node hierarchies to :contained-in relations
Functions to read and build the working model from overarch input models. The built model is a map with the following keys | Key | Description |-------------------------|------------- | **Relation keys** | | :nodes | the set of all nodes | :relations | the set of all relations | :views | the set of views | :themes | the set of themes | **Index keys** | | :id->element | a map from id to element (nodes, relations and views) | :id->parent-id | a map from id to parent node id | :id->children | a map from id to a vector of contained nodes (deprecated) | :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) | **Problem keys** | | :problems | the set of problems found during model building The input model is transformed by * computing missing ids, if possible * converting the node hierarchies to :contained-in relations
org.soulspace.overarch.adapter.reader.model-reader
Functions for reading and building models and setting the repository state. The multimethods should be implemented by specific readers.
Functions for reading and building models and setting the repository state. The multimethods should be implemented by specific readers.
org.soulspace.overarch.adapter.render.graphviz
Functions to export views to GraphViz.
Functions to export views to GraphViz.
org.soulspace.overarch.adapter.render.markdown
Functions to export views to markdown.
Functions to export views to markdown.
org.soulspace.overarch.adapter.render.plantuml
Functions to export views to PlantUML.
Functions to export views to PlantUML.
- alias-name
- collect-all-sprites
- collect-sprites
- collect-technologies
- linetypes
- load-sprite-mappings
- load-sprite-mappings-from-dir
- load-sprite-mappings-from-resource
- local-import
- plantuml-view?
- plantuml-views
- remote-import
- render-plantuml-view
- render-skinparam
- render-skinparams
- render-sprite-import
- render-sprite-imports
- render-spritelib-import
- render-title
- renderer
- short-name
- sorted-sprite-mappings
- sprite-libraries
- sprite-path
- sprite-resources
- sprite?
- sprites-for-view
- tech->sprite
- view-hierarchy
org.soulspace.overarch.adapter.render.plantuml.c4
Functions to render PlantUML C4 diagrams for architecture and deployment views.
Functions to render PlantUML C4 diagrams for architecture and deployment views.
org.soulspace.overarch.adapter.render.plantuml.uml
Functions to render PlantUML diagrams for UML views.
Functions to render PlantUML diagrams for UML views.
org.soulspace.overarch.adapter.template.comb
Template Engine implementation based on Comb templates.
Template Engine implementation based on Comb templates.
org.soulspace.overarch.adapter.template.model-api
Public API with useful functions on top of the model for use in templates. (Not yet stable!)
Public API with useful functions on top of the model for use in templates. (Not yet stable!)
- actors
- ancestor-nodes
- architecture-model-element?
- children
- code-model-element?
- collaborates-with
- collaboration-with
- collect-fields
- collect-methods
- concept-model-element?
- criteria-predicate
- dataflows-incoming
- dataflows-outgoing
- dependency-nodes
- dependent-nodes
- deployed-on
- deployed-to
- deployment-model-element?
- descendant-nodes
- element-name
- element-namespace
- element-namespace-path
- element-path
- element-type
- extensions
- feature-of
- features
- from-name
- implementations
- included
- interfaces
- linked-by
- links
- model-element-type-order
- model-element?
- model-node-type-order
- model-node?
- model-relation-type-order
- model-relation?
- organization-model-element?
- parent
- process-model-element?
- publishers-of
- publishes-incoming
- publishes-outgoing
- referenced-by
- referencing
- referred-nodes
- referred-relations
- referring-nodes
- referring-relations
- related-nodes
- requests-incoming
- requests-outgoing
- resolve-element
- resolve-view
- responses-incoming
- responses-outgoing
- responsibility-of
- responsible-for
- roles
- roles-in
- root-nodes
- root-path
- sends-incoming
- sends-outgoing
- state-machine-model-element?
- subclasses
- subordinates
- subscribers-of
- subscribes-incoming
- subscribes-outgoing
- superclasses
- superordinates
- supertypes
- supporting-actors
- sync-dependencies
- sync-dependents
- to-name
- transitions-incoming
- transitions-outgoing
- use-case-model-element?
- used-by
- using
- view-type-order
org.soulspace.overarch.adapter.template.view-api
Public API with useful functions on top of the view for use in templates. (Not yet stable!)
Public API with useful functions on top of the view for use in templates. (Not yet stable!)
org.soulspace.overarch.adapter.ui.cli
Functions for the command line interface of overarch.
Functions for the command line interface of overarch.
org.soulspace.overarch.application.export
Contains general functions for the export of the model data.
Contains general functions for the export of the model data.
org.soulspace.overarch.application.render
Contains dispatch functions for the rendering of the views.
Contains dispatch functions for the rendering of the views.
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.
- all-keys
- all-tags-pred
- all-techs-pred
- all-values-for-key
- architecture-dependency-relation-types
- architecture-node-types
- architecture-node?
- architecture-relation-types
- architecture-relation?
- boundary-types
- boundary?
- c4-view-types
- code-model-node?
- code-model-relation?
- code-node-types
- code-relation-types
- code-view-element-types
- collapsed?
- component-view-element-types
- concept-model-node?
- concept-model-relation?
- concept-node-types
- concept-relation-types
- concept-view-element-types
- concept-view-types
- container-view-element-types
- context-view-element-types
- count-elements-per-namespace
- count-elements-per-type
- count-external
- count-nodes-per-type
- count-relations-per-type
- count-synthetic
- count-views-per-type
- deployment-node-types
- deployment-node?
- deployment-relation-types
- deployment-relation?
- deployment-structure-view-element-types
- deployment-view-element-types
- desc-check-pred
- desc-pred
- difference-by-id
- doc-check-pred
- doc-pred
- dynamic-view-element-types
- el-pred
- element->ref
- element-hierarchy
- element-name
- element-namespace
- element?
- elements-by-namespace
- els-pred
- external?
- from-namespace-pred
- from-namespace-prefix-pred
- from-namespace-prefixes-pred
- from-namespaces-pred
- from-pred
- generate-node-id
- generate-relation-id
- glossary-view-element-types
- hierarchical-view-types
- hierarchical-view?
- id
- id->element-map
- id-check-pred
- id-pred
- identifiable-element?
- identifiable-named-element?
- identifiable-relational-element?
- identifiable?
- ids-pred
- ids-xf
- internal?
- key-check-pred
- key-pred
- maturities-pred
- maturity-check-pred
- maturity-pred
- model-element-type-order
- model-element-types
- model-element?
- model-node-pred
- model-node-type-order
- model-node-types
- model-node?
- model-relation-pred
- model-relation-type-order
- model-relation-types
- model-relation?
- model-view-element-types
- model-view-types
- name-check-pred
- name-pred
- name-prefix-pred
- named-element?
- named-relational-element?
- named?
- namespace-match?
- namespace-pred
- namespace-prefix-pred
- namespace-prefixes-pred
- namespaced?
- namespaces-pred
- namespaces-xf
- node-ids-xf
- node-of?
- organization-model-node?
- organization-model-relation?
- organization-node-types
- organization-relation-types
- organization-structure-view-element-types
- process-model-node?
- process-model-relation?
- process-node-types
- process-relation-types
- process-view-element-types
- process-view-types
- reference?
- relation-of?
- relational-element?
- relational?
- responsibility-model-node?
- responsibility-model-relation?
- responsibility-node-types
- responsibility-relation-types
- scope-element
- state-machine-view-element-types
- statemachine-node-types
- statemachine-node?
- statemachine-relation-types
- statemachine-relation?
- structure-view-types
- subtype-check-pred
- subtype-pred
- subtypes-pred
- synthetic-check-pred
- synthetic?
- system-landscape-view-element-types
- system-structure-view-element-types
- tag-pred
- tags-check-pred
- tags-pred
- tech-check-pred
- tech-pred
- technical-architecture-node-types
- technical-architecture-node?
- technology-set
- technology-vector
- techs-pred
- theme?
- to-namespace-pred
- to-namespace-prefix-pred
- to-namespace-prefixes-pred
- to-namespaces-pred
- to-pred
- uml-node-types
- uml-relation-types
- uml-view-element-types
- uml-view-types
- unidentifiable-elements
- union-by-id
- unmatched-relation-namespaces
- unnamed-elements
- unnamespaced-elements
- unresolved-ref?
- use-case-view-element-types
- usecase-node-types
- usecase-node?
- usecase-relation-types
- usecase-relation?
- value-xf
- view-of?
- view-type-order
- view-types
- view?
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.
- all-descendant-nodes
- all-elements
- all-nodes
- ancestor-node?
- ancestor-nodes
- ancestor-of-pred
- check-nodes
- check-relations
- check-views
- child-check-pred
- child-pred
- children
- children-resolver
- collect-in-ordered-set
- collect-in-set
- collect-in-vector
- criteria-map-predicate
- criteria-predicate
- criterium-predicate
- descendant-node?
- descendant-nodes
- descendant-of-pred
- element-resolver
- external-check-pred
- filter-xf
- from-name
- from-pred
- id->element
- key->element
- model-element
- model-elements
- model-elements-by-criteria
- node-by-id
- nodes
- nodes-by-criteria
- parent
- parent-check-pred
- parent-new
- parent-pred
- parent-resolver
- referred-by-pred
- referred-check-pred
- referred-nodes
- referred-pred
- referred-relations
- referred-xf
- referrer-xf
- referring-nodes
- referring-relations
- refers-check-pred
- refers-pred
- refers-to-pred
- related
- related-nodes
- related-xf
- relation-by-id
- relations
- relations-by-criteria
- relations-of-nodes
- resolve-element
- resolve-id
- resolve-ref
- resolveable-element?
- resolveable-relation?
- root-nodes
- sprite-collector
- t-ancestors
- t-descendants
- tech-collector
- themes
- to-name
- to-pred
- transitive-search
- traverse
- tree->set
- unrelated-nodes
- unresolved-refs
- unresolved-refs-in-view
- unresolved-refs-xf
- unresolved-related
- views
org.soulspace.overarch.domain.view
Functions for the definition and handling of views.
Functions for the definition and handling of views.
- element-to-render
- elements-to-render
- expand-external-spec
- graphviz-spec
- include-content?
- include-spec
- included-elements
- layout-spec
- legend-spec
- linetype-spec
- plantuml-spec
- referenced-elements
- render-model-element?
- root-elements
- selected-elements
- selection-spec
- sketch-spec
- specified-elements
- styles-spec
- themes->styles
- themes-spec
- title
- view-elements
- view-type
org.soulspace.overarch.domain.views.deployment-structure-view
No vars found in this namespace.
org.soulspace.overarch.domain.views.model-view
No vars found in this namespace.
org.soulspace.overarch.domain.views.organization-structure-view
No vars found in this namespace.
org.soulspace.overarch.domain.views.system-structure-view
No vars found in this namespace.
org.soulspace.overarch.util.io
Contains I/O related functions.
Contains I/O related functions.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close