Skip to content

Document reading CML models from code and tests #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
stefan-ka wants to merge 2 commits into
base: feature/bounded-context-owner
Choose a base branch
from
Draft

Document reading CML models from code and tests #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8163af3
Document reading CML models from code and tests
stefan-ka Oct 19, 2026
1c51608
Update Java version in standalone usage docs to 17
stefan-ka Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions _docs/standalone-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,27 @@ implementation 'org.contextmapper:context-mapper-dsl:{our-latest-version}'

The latest release can be found here: [org.contextmapper:context-mapper-dsl on Maven Central](https://central.sonatype.com/artifact/org.contextmapper/context-mapper-dsl)

The library runs on Java 17 or newer (tested with Java 17 and 21).

## Reading a CML Model in Your Code or Tests
A common use case is to read your CML model in your own build or tests, for example to derive architecture tests or other checks from the context map. The following snippet loads a CML file and iterates over the relationships of its context map:

```java
StandaloneContextMapperAPI contextMapper = ContextMapperStandaloneSetup.getStandaloneAPI();
CMLResource cml = contextMapper.loadCML("./src/main/cml/transit.cml");

for (Relationship relationship : cml.getContextMappingModel().getMap().getRelationships()) {
if (relationship instanceof UpstreamDownstreamRelationship) {
UpstreamDownstreamRelationship upDown = (UpstreamDownstreamRelationship) relationship;
System.out.println(upDown.getUpstream().getName() + " " + upDown.getUpstreamRoles() + " -> "
+ upDown.getDownstream().getName() + " " + upDown.getDownstreamRoles());
}
}
// prints for example: PaymentProvider [OHS] -> TicketSales [ACL]
```

The model classes (`BoundedContext`, `Aggregate`, `UpstreamDownstreamRelationship`, etc.) are located in the package `org.contextmapper.dsl.contextMappingDSL`; the API in `org.contextmapper.dsl.standalone`. If you want to check tactic DDD elements (Aggregates, Entities, etc.) against your Java code, have a look at our [ArchUnit extension](https://github.com/ContextMapper/context-mapper-archunit-extension).

## Example Project
If you want to use Context Mapper as library within your application, have a look at our standalone example project:
[https://github.com/ContextMapper/context-mapper-standalone-example](https://github.com/ContextMapper/context-mapper-standalone-example)
Expand Down
Loading